Crazy Eddies GUI System  0.6.2
CEGUIThumbProperties.h
1 /***********************************************************************
2  filename: CEGUIThumbProperties.h
3  created: 10/7/2004
4  author: Paul D Turner
5 
6  purpose: Interface for Thumb 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 _CEGUIThumbProperties_h_
31 #define _CEGUIThumbProperties_h_
32 
33 #include "CEGUIProperty.h"
34 
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
39 
40 // Start of ThumbProperties namespace section
45 namespace ThumbProperties
46 {
59 class HotTracked : public Property
60 {
61 public:
62  HotTracked() : Property(
63  "HotTracked",
64  "Property to get/set the state of the state of the 'hot-tracked' setting for the thumb. 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 VertFree : public Property
86 {
87 public:
88  VertFree() : Property(
89  "VertFree",
90  "Property to get/set the state the setting to free the thumb vertically. Value is either \"True\" or \"False\".",
91  "False")
92  {}
93 
94  String get(const PropertyReceiver* receiver) const;
95  void set(PropertyReceiver* receiver, const String& value);
96 };
97 
98 
111 class HorzFree : public Property
112 {
113 public:
114  HorzFree() : Property(
115  "HorzFree",
116  "Property to get/set the state the setting to free the thumb horizontally. Value is either \"True\" or \"False\".",
117  "False")
118  {}
119 
120  String get(const PropertyReceiver* receiver) const;
121  void set(PropertyReceiver* receiver, const String& value);
122 };
123 
124 
137 class VertRange : public Property
138 {
139 public:
140  VertRange() : Property(
141  "VertRange",
142  "Property to get/set the vertical movement range for the thumb. Value is \"min:[float] max:[float]\".",
143  "min:0.000000 max:1.000000")
144  {}
145 
146  String get(const PropertyReceiver* receiver) const;
147  void set(PropertyReceiver* receiver, const String& value);
148 };
149 
150 
163 class HorzRange : public Property
164 {
165 public:
166  HorzRange() : Property(
167  "HorzRange",
168  "Property to get/set the horizontal movement range for the thumb. Value is \"min:[float] max:[float]\".",
169  "min:0.000000 max:1.000000")
170  {}
171 
172  String get(const PropertyReceiver* receiver) const;
173  void set(PropertyReceiver* receiver, const String& value);
174 };
175 
176 
177 } // End of ThumbProperties namespace section
178 
179 } // End of CEGUI namespace section
180 
181 
182 #endif // end of guard _CEGUIThumbProperties_h_