guiMLTextEditCtrl.h

Engine/source/gui/controls/guiMLTextEditCtrl.h

More...

Classes:

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 _GUIMLTEXTEDITCTRL_H_
25#define _GUIMLTEXTEDITCTRL_H_
26
27#ifndef _GUIMLTEXTCTRL_H_
28#include "gui/controls/guiMLTextCtrl.h"
29#endif
30
31class GuiMLTextEditCtrl : public GuiMLTextCtrl
32{
33   typedef GuiMLTextCtrl Parent;
34
35   //-------------------------------------- Overrides
36  protected:
37   StringTableEntry mEscapeCommand;
38
39   // Events
40   bool onKeyDown(const GuiEvent&event);
41
42   // Event forwards
43   void handleMoveKeys(const GuiEvent&);
44   void handleDeleteKeys(const GuiEvent&);
45
46   // rendering
47   void onRender(Point2I offset, const RectI &updateRect);
48
49  public:
50   GuiMLTextEditCtrl();
51   ~GuiMLTextEditCtrl();
52
53   virtual void setFirstResponder();
54   virtual void onLoseFirstResponder();
55
56   bool onWake();
57   bool resize(const Point2I &newPosition, const Point2I &newExtent);
58
59   DECLARE_CONOBJECT(GuiMLTextEditCtrl);
60   DECLARE_DESCRIPTION( "A control that allows to edit multiple lines of text." );
61   
62   static void initPersistFields();
63};
64
65#endif  // _H_GUIMLTEXTEDITCTRL_
66