Crazy Eddies GUI System  0.7.2
FalStaticTextProperties.h
1 /***********************************************************************
2  filename: FalagardStaticTextProperties.h
3  created: 17/9/2005
4  author: Tomas L Olsen (based on code by Paul D Turner)
5 
6  purpose: Interface for properties for the FalagardStaticText class.
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to deal in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _FalagardStaticTextProperties_h_
31 #define _FalagardStaticTextProperties_h_
32 
33 #include "../../CEGUIProperty.h"
34 
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
39 
40 // Start of FalagardStaticTextProperties namespace section
45 namespace FalagardStaticTextProperties
46 {
47 
62 class TextColours : public Property
63 {
64 public:
66  "TextColours",
67  "Property to get/set the text colours for the FalagardStaticText widget. Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
68  "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
69  {}
70 
71  String get(const PropertyReceiver* receiver) const;
72  void set(PropertyReceiver* receiver, const String& value);
73 };
74 
75 
94 class HorzFormatting : public Property
95 {
96 public:
98  "HorzFormatting",
99  "Property to get/set the horizontal formatting mode. Value is one of the HorzFormatting strings.",
100  "LeftAligned")
101  {}
102 
103  String get(const PropertyReceiver* receiver) const;
104  void set(PropertyReceiver* receiver, const String& value);
105 };
106 
107 
121 class VertFormatting : public Property
122 {
123 public:
125  "VertFormatting",
126  "Property to get/set the vertical formatting mode. Value is one of the VertFormatting strings.",
127  "VertCentred")
128  {}
129 
130  String get(const PropertyReceiver* receiver) const;
131  void set(PropertyReceiver* receiver, const String& value);
132 };
133 
134 
147 class VertScrollbar : public Property
148 {
149 public:
151  "VertScrollbar",
152  "Property to get/set the setting for the vertical scroll bar. Value is either \"True\" or \"False\".",
153  "False")
154  {}
155 
156  String get(const PropertyReceiver* receiver) const;
157  void set(PropertyReceiver* receiver, const String& value);
158 };
159 
160 
173 class HorzScrollbar : public Property
174 {
175 public:
177  "HorzScrollbar",
178  "Property to get/set the setting for the horizontal scroll bar. Value is either \"True\" or \"False\".",
179  "False")
180  {}
181 
182  String get(const PropertyReceiver* receiver) const;
183  void set(PropertyReceiver* receiver, const String& value);
184 };
185 
195 class HorzExtent : public Property
196 {
197 public:
198  HorzExtent() : Property(
199  "HorzExtent",
200  "Property to get the current horizontal extent of the formatted text "
201  "string. Value is a float indicating the pixel extent.",
202  "0")
203  {}
204 
205  String get(const PropertyReceiver* receiver) const;
206  void set(PropertyReceiver* receiver, const String& value);
207 };
208 
218 class VertExtent : public Property
219 {
220 public:
221  VertExtent() : Property(
222  "VertExtent",
223  "Property to get the current vertical extent of the formatted text "
224  "string. Value is a float indicating the pixel extent.",
225  "0")
226  {}
227 
228  String get(const PropertyReceiver* receiver) const;
229  void set(PropertyReceiver* receiver, const String& value);
230 };
231 
232 } // End of FalagardStaticTextProperties namespace section
233 
234 } // End of CEGUI namespace section
235 
236 
237 #endif // end of guard _FalagardStaticTextProperties_h_