Crazy Eddies GUI System  0.7.1
CEGUIScrollablePaneProperties.h
1 /***********************************************************************
2  filename: CEGUIScrollablePaneProperties.h
3  created: 3/3/2005
4  author: Paul D Turner
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIScrollablePaneProperties_h_
29 #define _CEGUIScrollablePaneProperties_h_
30 
31 #include "../CEGUIProperty.h"
32 
33 // Start of CEGUI namespace section
34 namespace CEGUI
35 {
36 // Start of ScrollablePaneProperties namespace section
41 namespace ScrollablePaneProperties
42 {
57  {
58  public:
60  "ContentPaneAutoSized",
61  "Property to get/set the setting which controls whether the content pane will auto-size itself. Value is either \"True\" or \"False\".",
62  "True")
63  {}
64 
65  String get(const PropertyReceiver* receiver) const;
66  void set(PropertyReceiver* receiver, const String& value);
67  };
68 
83  class ContentArea : public Property
84  {
85  public:
87  "ContentArea",
88  "Property to get/set the current content area rectangle of the content pane. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom).",
89  "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
90  {}
91 
92  String get(const PropertyReceiver* receiver) const;
93  void set(PropertyReceiver* receiver, const String& value);
94  };
95 
110  {
111  public:
113  "ForceVertScrollbar",
114  "Property to get/set the setting which controls whether the vertical scroll bar is aways shown. Value is either \"True\" or \"False\".",
115  "False")
116  {}
117 
118  String get(const PropertyReceiver* receiver) const;
119  void set(PropertyReceiver* receiver, const String& value);
120  };
121 
122 
137  {
138  public:
140  "ForceHorzScrollbar",
141  "Property to get/set the setting which controls whether the horizontal scroll bar is aways shown. Value is either \"True\" or \"False\".",
142  "False")
143  {}
144 
145  String get(const PropertyReceiver* receiver) const;
146  void set(PropertyReceiver* receiver, const String& value);
147  };
148 
160  class HorzStepSize : public Property
161  {
162  public:
164  "HorzStepSize",
165  "Property to get/set the step size for the horizontal Scrollbar. Value is a float.",
166  "0.100000")
167  {}
168 
169  String get(const PropertyReceiver* receiver) const;
170  void set(PropertyReceiver* receiver, const String& value);
171  };
172 
184  class HorzOverlapSize : public Property
185  {
186  public:
188  "HorzOverlapSize",
189  "Property to get/set the overlap size for the horizontal Scrollbar. Value is a float.",
190  "0.010000")
191  {}
192 
193  String get(const PropertyReceiver* receiver) const;
194  void set(PropertyReceiver* receiver, const String& value);
195  };
196 
209  {
210  public:
212  "HorzScrollPosition",
213  "Property to get/set the scroll position of the horizontal Scrollbar as a fraction. Value is a float.",
214  "0.000000")
215  {}
216 
217  String get(const PropertyReceiver* receiver) const;
218  void set(PropertyReceiver* receiver, const String& value);
219  };
220 
232  class VertStepSize : public Property
233  {
234  public:
236  "VertStepSize",
237  "Property to get/set the step size for the vertical Scrollbar. Value is a float.",
238  "0.100000")
239  {}
240 
241  String get(const PropertyReceiver* receiver) const;
242  void set(PropertyReceiver* receiver, const String& value);
243  };
244 
256  class VertOverlapSize : public Property
257  {
258  public:
260  "VertOverlapSize",
261  "Property to get/set the overlap size for the vertical Scrollbar. Value is a float.",
262  "0.010000")
263  {}
264 
265  String get(const PropertyReceiver* receiver) const;
266  void set(PropertyReceiver* receiver, const String& value);
267  };
268 
281  {
282  public:
284  "VertScrollPosition",
285  "Property to get/set the scroll position of the vertical Scrollbar as a fraction. Value is a float.",
286  "0.000000")
287  {}
288 
289  String get(const PropertyReceiver* receiver) const;
290  void set(PropertyReceiver* receiver, const String& value);
291  };
292 
293 } // End of ScrollablePaneProperties namespace section
294 } // End of CEGUI namespace section
295 
296 
297 #endif // end of guard _CEGUIScrollablePaneProperties_h_