Pyrogenesis  trunk
CText.h
Go to the documentation of this file.
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 {
31 
32 public:
33  CText();
34  virtual ~CText();
35 
36  /**
37  * @see IGUIObject#ResetStates()
38  */
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  */
67 };
68 
69 #endif // INCLUDED_CTEXT
CPos m_TextPos
Placement of text.
Definition: CText.h:66
void SetupText()
Sets up text, should be called every time changes has been made that can change the visual...
Definition: CText.cpp:67
virtual void ResetStates()
Definition: CText.h:39
virtual ~CText()
Definition: CText.cpp:63
Framework for handling Output text.
Definition: IGUITextOwner.h:45
Made to represent screen positions and delta values.
Definition: Shapes.h:169
CText()
Definition: CText.cpp:27
virtual void HandleMessage(SGUIMessage &Message)
Definition: CText.cpp:128
virtual void ResetStates()
Definition: IGUIScrollBarOwner.cpp:32
Text field that just displays static text.
Definition: CText.h:28
Message send to IGUIObject::HandleMessage() in order to give life to Objects manually with a derived ...
Definition: GUIbase.h:91
Base-class this if you want an object to contain one, or several, scroll-bars.
Definition: IGUIScrollBarOwner.h:33
virtual void Draw()
Draws the Text.
Definition: CText.cpp:190
#define GUI_OBJECT(obj)
Definition: GUIbase.h:48
virtual bool MouseOverIcon()
Test if mouse position is over an icon.
Definition: CText.cpp:249