1 | /************************************************************************
|
---|
2 | filename: CEGUIListboxProperties.h
|
---|
3 | created: 11/7/2004
|
---|
4 | author: Paul D Turner
|
---|
5 |
|
---|
6 | purpose: Interface to Listbox property classes
|
---|
7 | *************************************************************************/
|
---|
8 | /*************************************************************************
|
---|
9 | Crazy Eddie's GUI System (http://www.cegui.org.uk)
|
---|
10 | Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
|
---|
11 |
|
---|
12 | This library is free software; you can redistribute it and/or
|
---|
13 | modify it under the terms of the GNU Lesser General Public
|
---|
14 | License as published by the Free Software Foundation; either
|
---|
15 | version 2.1 of the License, or (at your option) any later version.
|
---|
16 |
|
---|
17 | This library is distributed in the hope that it will be useful,
|
---|
18 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
20 | Lesser General Public License for more details.
|
---|
21 |
|
---|
22 | You should have received a copy of the GNU Lesser General Public
|
---|
23 | License along with this library; if not, write to the Free Software
|
---|
24 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
---|
25 | *************************************************************************/
|
---|
26 | #ifndef _CEGUIListboxProperties_h_
|
---|
27 | #define _CEGUIListboxProperties_h_
|
---|
28 |
|
---|
29 | #include "CEGUIProperty.h"
|
---|
30 |
|
---|
31 |
|
---|
32 | // Start of CEGUI namespace section
|
---|
33 | namespace CEGUI
|
---|
34 | {
|
---|
35 |
|
---|
36 | // Start of ListboxProperties namespace section
|
---|
37 | /*!
|
---|
38 | \brief
|
---|
39 | Namespace containing all classes that make up the properties interface for the Listbox class
|
---|
40 | */
|
---|
41 | namespace ListboxProperties
|
---|
42 | {
|
---|
43 | /*!
|
---|
44 | \brief
|
---|
45 | Property to access the sort setting of the list box.
|
---|
46 |
|
---|
47 | \par Usage:
|
---|
48 | - Name: Sort
|
---|
49 | - Format: "[text]"
|
---|
50 |
|
---|
51 | \par Where [Text] is:
|
---|
52 | - "True" to indicate the list items should be sorted.
|
---|
53 | - "False" to indicate the list items should not be sorted.
|
---|
54 | */
|
---|
55 | class Sort : public Property
|
---|
56 | {
|
---|
57 | public:
|
---|
58 | Sort() : Property(
|
---|
59 | "Sort",
|
---|
60 | "Property to get/set the sort setting of the list box. Value is either \"True\" or \"False\".",
|
---|
61 | "False")
|
---|
62 | {}
|
---|
63 |
|
---|
64 | String get(const PropertyReceiver* receiver) const;
|
---|
65 | void set(PropertyReceiver* receiver, const String& value);
|
---|
66 | };
|
---|
67 |
|
---|
68 |
|
---|
69 | /*!
|
---|
70 | \brief
|
---|
71 | Property to access the multi-select setting of the list box.
|
---|
72 |
|
---|
73 | \par Usage:
|
---|
74 | - Name: MultiSelect
|
---|
75 | - Format: "[text]"
|
---|
76 |
|
---|
77 | \par Where [Text] is:
|
---|
78 | - "True" to indicate that multiple items may be selected.
|
---|
79 | - "False" to indicate that only a single item may be selected.
|
---|
80 | */
|
---|
81 | class MultiSelect : public Property
|
---|
82 | {
|
---|
83 | public:
|
---|
84 | MultiSelect() : Property(
|
---|
85 | "MultiSelect",
|
---|
86 | "Property to get/set the multi-select setting of the list box. Value is either \"True\" or \"False\".",
|
---|
87 | "False")
|
---|
88 | {}
|
---|
89 |
|
---|
90 | String get(const PropertyReceiver* receiver) const;
|
---|
91 | void set(PropertyReceiver* receiver, const String& value);
|
---|
92 | };
|
---|
93 |
|
---|
94 |
|
---|
95 | /*!
|
---|
96 | \brief
|
---|
97 | Property to access the 'always show' setting for the vertical scroll bar of the list box.
|
---|
98 |
|
---|
99 | \par Usage:
|
---|
100 | - Name: ForceVertScrollbar
|
---|
101 | - Format: "[text]"
|
---|
102 |
|
---|
103 | \par Where [Text] is:
|
---|
104 | - "True" to indicate that the vertical scroll bar will always be shown.
|
---|
105 | - "False" to indicate that the vertical scroll bar will only be shown when it is needed.
|
---|
106 | */
|
---|
107 | class ForceVertScrollbar : public Property
|
---|
108 | {
|
---|
109 | public:
|
---|
110 | ForceVertScrollbar() : Property(
|
---|
111 | "ForceVertScrollbar",
|
---|
112 | "Property to get/set the 'always show' setting for the vertical scroll bar of the list box. Value is either \"True\" or \"False\".",
|
---|
113 | "False")
|
---|
114 | {}
|
---|
115 |
|
---|
116 | String get(const PropertyReceiver* receiver) const;
|
---|
117 | void set(PropertyReceiver* receiver, const String& value);
|
---|
118 | };
|
---|
119 |
|
---|
120 |
|
---|
121 | /*!
|
---|
122 | \brief
|
---|
123 | Property to access the 'always show' setting for the horizontal scroll bar of the list box.
|
---|
124 |
|
---|
125 | \par Usage:
|
---|
126 | - Name: ForceHorzScrollbar
|
---|
127 | - Format: "[text]"
|
---|
128 |
|
---|
129 | \par Where [Text] is:
|
---|
130 | - "True" to indicate that the horizontal scroll bar will always be shown.
|
---|
131 | - "False" to indicate that the horizontal scroll bar will only be shown when it is needed.
|
---|
132 | */
|
---|
133 | class ForceHorzScrollbar : public Property
|
---|
134 | {
|
---|
135 | public:
|
---|
136 | ForceHorzScrollbar() : Property(
|
---|
137 | "ForceHorzScrollbar",
|
---|
138 | "Property to get/set the 'always show' setting for the horizontal scroll bar of the list box. Value is either \"True\" or \"False\".",
|
---|
139 | "False")
|
---|
140 | {}
|
---|
141 |
|
---|
142 | String get(const PropertyReceiver* receiver) const;
|
---|
143 | void set(PropertyReceiver* receiver, const String& value);
|
---|
144 | };
|
---|
145 |
|
---|
146 | /*!
|
---|
147 | \brief
|
---|
148 | Property to access the show item tooltips setting of the list box.
|
---|
149 |
|
---|
150 | \par Usage:
|
---|
151 | - Name: ItemTooltips
|
---|
152 | - Format: "[text]"
|
---|
153 |
|
---|
154 | \par Where [Text] is:
|
---|
155 | - "True" to indicate that the tooltip of the list box will be set by the item below the mouse pointer
|
---|
156 | - "False" to indicate that the list box has a static tooltip.
|
---|
157 | */
|
---|
158 | class ItemTooltips : public Property
|
---|
159 | {
|
---|
160 | public:
|
---|
161 | ItemTooltips() : Property(
|
---|
162 | "ItemTooltips",
|
---|
163 | "Property to access the show item tooltips setting of the list box. Value is either \"True\" or \"False\".",
|
---|
164 | "False")
|
---|
165 | {}
|
---|
166 |
|
---|
167 | String get(const PropertyReceiver* receiver) const;
|
---|
168 | void set(PropertyReceiver* receiver, const String& value);
|
---|
169 | };
|
---|
170 |
|
---|
171 | } // End of ListboxProperties namespace section
|
---|
172 |
|
---|
173 | } // End of CEGUI namespace section
|
---|
174 |
|
---|
175 | #endif // end of guard _CEGUIListboxProperties_h_
|
---|