source/gui/CText.h

   1 /* Copyright (C) 2015 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 #ifndef INCLUDED_CTEXT
  19 #define INCLUDED_CTEXT
  20
  21 #include "GUI.h"
  22
  23 /**
  24  * Text field that just displays static text.
  25  *
  26  * @see IGUIObject
  27  */
  28 class CText : public IGUIScrollBarOwner, public IGUITextOwner
  29 {
  30         GUI_OBJECT(CText)
  31
  32 public:
  33         CText();
  34         virtual ~CText();
  35
  36         /**
  37          * @see IGUIObject#ResetStates()
  38          */
  39         virtual void ResetStates() { IGUIScrollBarOwner::ResetStates(); }
  40
  41         /**
  42          * Test if mouse position is over an icon
  43          */
  44         virtual bool MouseOverIcon();
  45
  46 protected:
  47         /**
  48          * Sets up text, should be called every time changes has been
  49          * made that can change the visual.
  50          */
  51         void SetupText();
  52
  53         /**
  54          * @see IGUIObject#HandleMessage()
  55          */
  56         virtual void HandleMessage(SGUIMessage& Message);
  57
  58         /**
  59          * Draws the Text
  60          */
  61         virtual void Draw();
  62
  63         /**
  64          * Placement of text. Ignored when scrollbars are active.
  65          */
  66         CPos m_TextPos;
  67 };
  68
  69 #endif // INCLUDED_CTEXT