Crazy Eddies GUI System  0.7.2
CEGUIMultiLineEditboxProperties.h
1 /***********************************************************************
2  filename: CEGUIMultiLineEditboxProperties.h
3  created: 10/7/2004
4  author: Paul D Turner
5 
6  purpose: Interface to properties for the MultiLineEditbox 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 _CEGUIMultiLineEditboxProperties_h_
31 #define _CEGUIMultiLineEditboxProperties_h_
32 
33 #include "../CEGUIProperty.h"
34 
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
39 
40 // Start of MultiLineEditboxProperties namespace section
45 namespace MultiLineEditboxProperties
46 {
59 class ReadOnly : public Property
60 {
61 public:
62  ReadOnly() : Property(
63  "ReadOnly",
64  "Property to get/set the read-only setting for the edit box. Value is either \"True\" or \"False\".",
65  "False")
66  {}
67 
68  String get(const PropertyReceiver* receiver) const;
69  void set(PropertyReceiver* receiver, const String& value);
70 };
71 
72 
85 class WordWrap : public Property
86 {
87 public:
88  WordWrap() : Property(
89  "WordWrap",
90  "Property to get/set the word-wrap setting of the edit box. Value is either \"True\" or \"False\".",
91  "True")
92  {}
93 
94  String get(const PropertyReceiver* receiver) const;
95  void set(PropertyReceiver* receiver, const String& value);
96 };
97 
98 
110 class CaratIndex : public Property
111 {
112 public:
113  CaratIndex() : Property(
114  "CaratIndex",
115  "Property to get/set the current carat index. Value is \"[uint]\".",
116  "0")
117  {}
118 
119  String get(const PropertyReceiver* receiver) const;
120  void set(PropertyReceiver* receiver, const String& value);
121 };
122 
123 
135 class SelectionStart : public Property
136 {
137 public:
139  "SelectionStart",
140  "Property to get/set the zero based index of the selection start position within the text. Value is \"[uint]\".",
141  "0")
142  {}
143 
144  String get(const PropertyReceiver* receiver) const;
145  void set(PropertyReceiver* receiver, const String& value);
146 };
147 
148 
160 class SelectionLength : public Property
161 {
162 public:
164  "SelectionLength",
165  "Property to get/set the length of the selection (as a count of the number of code points selected). Value is \"[uint]\".",
166  "0")
167  {}
168 
169  String get(const PropertyReceiver* receiver) const;
170  void set(PropertyReceiver* receiver, const String& value);
171 };
172 
173 
185 class MaxTextLength : public Property
186 {
187 public:
189  "MaxTextLength",
190  "Property to get/set the the maximum allowed text length (as a count of code points). Value is \"[uint]\".",
191  "1073741824")
192  {}
193 
194  String get(const PropertyReceiver* receiver) const;
195  void set(PropertyReceiver* receiver, const String& value);
196 };
197 
198 
209 {
210 public:
212  "SelectionBrushImage",
213  "Property to get/set the selection brush image for the editbox. Value should be \"set:[imageset name] image:[image name]\".",
214  "")
215  {}
216 
217  String get(const PropertyReceiver* receiver) const;
218  void set(PropertyReceiver* receiver, const String& value);
219 };
220 
234 {
235 public:
237  "ForceVertScrollbar",
238  "Property to get/set the 'always show' setting for the vertical scroll bar of the list box. Value is either \"True\" or \"False\".",
239  "False")
240  {}
241 
242  String get(const PropertyReceiver* receiver) const;
243  void set(PropertyReceiver* receiver, const String& value);
244 };
245 
246 } // End of MultiLineEditboxProperties namespace section
247 
248 } // End of CEGUI namespace section
249 
250 
251 #endif // end of guard _CEGUIMultiLineEditboxProperties_h_