source/gui/CText.h

   1 /* Copyright (C) 2009 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19 GUI Object - Text [field]
  20
  21 --Overview--
  22
  23         GUI Object representing a text field
  24
  25 --More info--
  26
  27         Check GUI.h
  28
  29 */
  30
  31 #ifndef INCLUDED_CTEXT
  32 #define INCLUDED_CTEXT
  33
  34 //--------------------------------------------------------
  35 //  Includes / Compiler directives
  36 //--------------------------------------------------------
  37 #include "GUI.h"
  38
  39 // TODO Gee: Remove
  40 class IGUIScrollBar;
  41
  42 //--------------------------------------------------------
  43 //  Macros
  44 //--------------------------------------------------------
  45
  46 //--------------------------------------------------------
  47 //  Types
  48 //--------------------------------------------------------
  49
  50 //--------------------------------------------------------
  51 //  Declarations
  52 //--------------------------------------------------------
  53
  54 /**
  55  * Text field that just displays static text.
  56  *
  57  * @see IGUIObject
  58  */
  59 class CText : public IGUIScrollBarOwner, public IGUITextOwner
  60 {
  61         GUI_OBJECT(CText)
  62
  63 public:
  64         CText();
  65         virtual ~CText();
  66
  67         /**
  68          * @see IGUIObject#ResetStates()
  69          */
  70         virtual void ResetStates() { IGUIScrollBarOwner::ResetStates(); }
  71
  72         /**
  73          * Test if mouse position is over an icon
  74          */
  75         virtual bool MouseOverIcon();
  76
  77 protected:
  78         /**
  79          * Sets up text, should be called every time changes has been
  80          * made that can change the visual.
  81          */
  82         void SetupText();
  83
  84         /**
  85          * @see IGUIObject#HandleMessage()
  86          */
  87         virtual void HandleMessage(SGUIMessage &Message);
  88
  89         /**
  90          * Draws the Text
  91          */
  92         virtual void Draw();
  93
  94         /**
  95          * Placement of text. Ignored when scrollbars are active.
  96          */
  97         CPos m_TextPos;
  98 };
  99
 100 #endif