Crazy Eddies GUI System  0.6.0
CEGUIMultiColumnListProperties.h
1 /***********************************************************************
2  filename: CEGUIMultiColumnListProperties.h
3  created: 11/7/2004
4  author: Paul D Turner
5 
6  purpose: Interface to multi-column list properties.
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 _CEGUIMultiColumnListProperties_h_
31 #define _CEGUIMultiColumnListProperties_h_
32 
33 #include "CEGUIProperty.h"
34 
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
39 
40 // Start of MultiColumnListProperties namespace section
45 namespace MultiColumnListProperties
46 {
59 class ColumnsSizable : public Property
60 {
61 public:
63  "ColumnsSizable",
64  "Property to get/set the setting for user sizing of the column headers. Value is either \"True\" or \"False\".",
65  "True")
66  {}
67 
68  String get(const PropertyReceiver* receiver) const;
69  void set(PropertyReceiver* receiver, const String& value);
70 };
71 
72 
85 class ColumnsMovable : public Property
86 {
87 public:
89  "ColumnsMovable",
90  "Property to get/set the setting for user moving of the column headers. 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 
112 {
113 public:
115  "SortSettingEnabled",
116  "Property to get/set the setting for for user modification of the sort column & direction. Value is either \"True\" or \"False\".",
117  "True")
118  {}
119 
120  String get(const PropertyReceiver* receiver) const;
121  void set(PropertyReceiver* receiver, const String& value);
122 };
123 
124 
138 class SortDirection : public Property
139 {
140 public:
142  "SortDirection",
143  "Property to get/set the sort direction setting of the list. Value is the text of one of the SortDirection enumerated value names.",
144  "None")
145  {}
146 
147  String get(const PropertyReceiver* receiver) const;
148  void set(PropertyReceiver* receiver, const String& value);
149 };
150 
151 
163 class SortColumnID : public Property
164 {
165 public:
167  "SortColumnID",
168  "Property to get/set the current sort column (via ID code). Value is an unsigned integer number.",
169  "0", false)
170  {}
171 
172  String get(const PropertyReceiver* receiver) const;
173  void set(PropertyReceiver* receiver, const String& value);
174 };
175 
176 
189 {
190 public:
192  "NominatedSelectionColumnID",
193  "Property to get/set the nominated selection column (via ID). Value is an unsigned integer number.",
194  "0")
195  {}
196 
197  String get(const PropertyReceiver* receiver) const;
198  void set(PropertyReceiver* receiver, const String& value);
199 };
200 
201 
214 {
215 public:
217  "NominatedSelectionRow",
218  "Property to get/set the nominated selection row. Value is an unsigned integer number.",
219  "0")
220  {}
221 
222  String get(const PropertyReceiver* receiver) const;
223  void set(PropertyReceiver* receiver, const String& value);
224 };
225 
226 
240 {
241 public:
243  "ForceVertScrollbar",
244  "Property to get/set the 'always show' setting for the vertical scroll bar of the list box. Value is either \"True\" or \"False\".",
245  "False")
246  {}
247 
248  String get(const PropertyReceiver* receiver) const;
249  void set(PropertyReceiver* receiver, const String& value);
250 };
251 
252 
266 {
267 public:
269  "ForceHorzScrollbar",
270  "Property to get/set the 'always show' setting for the horizontal scroll bar of the list box. Value is either \"True\" or \"False\".",
271  "False")
272  {}
273 
274  String get(const PropertyReceiver* receiver) const;
275  void set(PropertyReceiver* receiver, const String& value);
276 };
277 
278 
299 class SelectionMode : public Property
300 {
301 public:
303  "SelectionMode",
304  "Property to get/set the selection mode setting of the list. Value is the text of one of the SelectionMode enumerated value names.",
305  "RowSingle")
306  {}
307 
308  String get(const PropertyReceiver* receiver) const;
309  void set(PropertyReceiver* receiver, const String& value);
310 };
311 
312 
326 class ColumnHeader : public Property
327 {
328 public:
330  "ColumnHeader",
331  "Property to set up a column (there is no getter for this property)",
332  "", false)
333  {}
334 
335  String get(const PropertyReceiver* receiver) const;
336  void set(PropertyReceiver* receiver, const String& value);
337 };
338 
347 class RowCount : public Property
348 {
349 public:
350  RowCount() : Property(
351  "RowCount",
352  "Property to access the number of rows in the list (read only)",
353  "", false)
354  {}
355 
356  String get(const PropertyReceiver* receiver) const;
357  void set(PropertyReceiver* receiver, const String& value);
358 };
359 
360 
361 } // End of MultiColumnListProperties namespace section
362 
363 } // End of CEGUI namespace section
364 
365 
366 #endif // end of guard _CEGUIMultiColumnListProperties_h_