guiConsole.h

Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUICONSOLE_H_
25#define _GUICONSOLE_H_
26
27#ifndef _GUIARRAYCTRL_H_
28#include "gui/core/guiArrayCtrl.h"
29#endif
30
31#ifndef _CONSOLE_LOGGER_H_
32#include "console/consoleLogger.h"
33#endif
34
35
36class GuiConsole : public GuiArrayCtrl
37{
38   private:
39      typedef GuiArrayCtrl Parent;
40
41      Resource<GFont> mFont;
42
43      S32 getMaxWidth(S32 startIndex, S32 endIndex);
44
45   protected:
46
47      /// @name Callbacks
48      /// @{
49
50      DECLARE_CALLBACK( void, onMessageSelected, ( ConsoleLogEntry::Level level, const char* message ) );
51
52      /// @}
53
54      // GuiArrayCtrl.
55      virtual void onCellSelected( Point2I cell );
56
57   public:
58      GuiConsole();
59      DECLARE_CONOBJECT(GuiConsole);
60      DECLARE_CATEGORY( "Gui Editor" );
61      DECLARE_DESCRIPTION( "Control that displays the console log text." );
62
63      // GuiArrayCtrl.
64      virtual bool onWake();
65      virtual void onPreRender();
66      virtual void onRenderCell(Point2I offset, Point2I cell, bool selected, bool mouseOver);
67};
68
69#endif
70