guiConsoleTextCtrl.h

Engine/source/gui/controls/guiConsoleTextCtrl.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 _GUICONSOLETEXTCTRL_H_
25#define _GUICONSOLETEXTCTRL_H_
26
27#ifndef _GFONT_H_
28#include "gfx/gFont.h"
29#endif
30#ifndef _GUITYPES_H_
31#include "gui/core/guiTypes.h"
32#endif
33#ifndef _GUICONTROL_H_
34#include "gui/core/guiControl.h"
35#endif
36
37class GuiConsoleTextCtrl : public GuiControl
38{
39private:
40   typedef GuiControl Parent;
41
42public:
43   enum Constants { MAX_STRING_LENGTH = 255 };
44
45
46protected:
47
48   String mConsoleExpression;
49   String mResult;
50   Resource<GFont> mFont;
51
52   Vector<U32> mStartLineOffset;
53   Vector<U32> mLineLen;
54
55public:
56
57   //creation methods
58   DECLARE_CONOBJECT(GuiConsoleTextCtrl);
59   DECLARE_CATEGORY( "Gui Editor" );
60   
61   GuiConsoleTextCtrl();
62   virtual ~GuiConsoleTextCtrl();
63   static void initPersistFields();
64
65   //Parental methods
66   bool onWake();
67   void onSleep();
68
69   //text methods
70   virtual void setText( const char *txt = NULL );
71   const char* getText() { return mConsoleExpression.c_str(); }
72
73   //rendering methods
74   void calcResize();
75   void onPreRender();    // do special pre render processing
76   void onRender( Point2I offset, const RectI &updateRect );
77
78   //Console methods
79   const char* getScriptValue();
80   void setScriptValue( const char *value );
81};
82
83#endif //_GUI_TEXT_CONTROL_H_
84