[1812] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIStaticProperties.h
|
---|
| 3 | created: 10/7/2004
|
---|
| 4 | author: Paul D Turner
|
---|
| 5 |
|
---|
| 6 | purpose: Interface to properties for Static (base class) widget.
|
---|
| 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 _CEGUIStaticProperties_h_
|
---|
| 27 | #define _CEGUIStaticProperties_h_
|
---|
| 28 |
|
---|
| 29 | #include "CEGUIProperty.h"
|
---|
| 30 |
|
---|
| 31 | // Start of CEGUI namespace section
|
---|
| 32 | namespace CEGUI
|
---|
| 33 | {
|
---|
| 34 |
|
---|
| 35 | // Start of StaticProperties namespace section
|
---|
| 36 | /*!
|
---|
| 37 | \brief
|
---|
| 38 | Namespace containing all classes that make up the properties interface for the Static (base) class
|
---|
| 39 | */
|
---|
| 40 | namespace StaticProperties
|
---|
| 41 | {
|
---|
| 42 | /*!
|
---|
| 43 | \brief
|
---|
| 44 | Property to access the state of the frame enabled setting for the Static widget.
|
---|
| 45 |
|
---|
| 46 | \par Usage:
|
---|
| 47 | - Name: FrameEnabled
|
---|
| 48 | - Format: "[text]".
|
---|
| 49 |
|
---|
| 50 | \par Where [Text] is:
|
---|
| 51 | - "True" to indicate that the frame is enabled.
|
---|
| 52 | - "False" to indicate that the frame is disabled.
|
---|
| 53 | */
|
---|
| 54 | class FrameEnabled : public Property
|
---|
| 55 | {
|
---|
| 56 | public:
|
---|
| 57 | FrameEnabled() : Property(
|
---|
| 58 | "FrameEnabled",
|
---|
| 59 | "Property to get/set the state of the frame enabled setting for the Static widget. Value is either \"True\" or \"False\".",
|
---|
| 60 | "True")
|
---|
| 61 | {}
|
---|
| 62 |
|
---|
| 63 | String get(const PropertyReceiver* receiver) const;
|
---|
| 64 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 65 | };
|
---|
| 66 |
|
---|
| 67 |
|
---|
| 68 | /*!
|
---|
| 69 | \brief
|
---|
| 70 | Property to access the state of the frame background setting for the Static widget.
|
---|
| 71 |
|
---|
| 72 | \par Usage:
|
---|
| 73 | - Name: BackgroundEnabled
|
---|
| 74 | - Format: "[text]".
|
---|
| 75 |
|
---|
| 76 | \par Where [Text] is:
|
---|
| 77 | - "True" to indicate that the background is enabled.
|
---|
| 78 | - "False" to indicate that the background is disabled.
|
---|
| 79 | */
|
---|
| 80 | class BackgroundEnabled : public Property
|
---|
| 81 | {
|
---|
| 82 | public:
|
---|
| 83 | BackgroundEnabled() : Property(
|
---|
| 84 | "BackgroundEnabled",
|
---|
| 85 | "Property to get/set the state of the frame background setting for the Static widget. Value is either \"True\" or \"False\".",
|
---|
| 86 | "True")
|
---|
| 87 | {}
|
---|
| 88 |
|
---|
| 89 | String get(const PropertyReceiver* receiver) const;
|
---|
| 90 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 91 | };
|
---|
| 92 |
|
---|
| 93 |
|
---|
| 94 | /*!
|
---|
| 95 | \brief
|
---|
| 96 | Property to access the frame colours for the Static widget.
|
---|
| 97 |
|
---|
| 98 | \par Usage:
|
---|
| 99 | - Name: FrameColours
|
---|
| 100 | - Format: "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".
|
---|
| 101 |
|
---|
| 102 | \par Where:
|
---|
| 103 | - tl:[aarrggbb] is the top-left colour value specified as ARGB (hex).
|
---|
| 104 | - tr:[aarrggbb] is the top-right colour value specified as ARGB (hex).
|
---|
| 105 | - bl:[aarrggbb] is the bottom-left colour value specified as ARGB (hex).
|
---|
| 106 | - br:[aarrggbb] is the bottom-right colour value specified as ARGB (hex).
|
---|
| 107 | */
|
---|
| 108 | class FrameColours : public Property
|
---|
| 109 | {
|
---|
| 110 | public:
|
---|
| 111 | FrameColours() : Property(
|
---|
| 112 | "FrameColours",
|
---|
| 113 | "Property to get/set the frame colours for the Static widget. Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
|
---|
| 114 | "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
|
---|
| 115 | {}
|
---|
| 116 |
|
---|
| 117 | String get(const PropertyReceiver* receiver) const;
|
---|
| 118 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 119 | };
|
---|
| 120 |
|
---|
| 121 |
|
---|
| 122 | /*!
|
---|
| 123 | \brief
|
---|
| 124 | Property to access the background colours for the Static widget.
|
---|
| 125 |
|
---|
| 126 | \par Usage:
|
---|
| 127 | - Name: BackgroundColours
|
---|
| 128 | - Format: "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".
|
---|
| 129 |
|
---|
| 130 | \par Where:
|
---|
| 131 | - tl:[aarrggbb] is the top-left colour value specified as ARGB (hex).
|
---|
| 132 | - tr:[aarrggbb] is the top-right colour value specified as ARGB (hex).
|
---|
| 133 | - bl:[aarrggbb] is the bottom-left colour value specified as ARGB (hex).
|
---|
| 134 | - br:[aarrggbb] is the bottom-right colour value specified as ARGB (hex).
|
---|
| 135 | */
|
---|
| 136 | class BackgroundColours : public Property
|
---|
| 137 | {
|
---|
| 138 | public:
|
---|
| 139 | BackgroundColours() : Property(
|
---|
| 140 | "BackgroundColours",
|
---|
| 141 | "Property to get/set the background colours for the Static widget. Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
|
---|
| 142 | "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
|
---|
| 143 | {}
|
---|
| 144 |
|
---|
| 145 | String get(const PropertyReceiver* receiver) const;
|
---|
| 146 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 147 | };
|
---|
| 148 |
|
---|
| 149 |
|
---|
| 150 | /*!
|
---|
| 151 | \brief
|
---|
| 152 | Property to access the background image for the Static widget.
|
---|
| 153 |
|
---|
| 154 | \par Usage:
|
---|
| 155 | - Name: BackgroundImage
|
---|
| 156 | - Format: "set:[text] image:[text]".
|
---|
| 157 |
|
---|
| 158 | \par Where:
|
---|
| 159 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 160 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 161 | */
|
---|
| 162 | class BackgroundImage : public Property
|
---|
| 163 | {
|
---|
| 164 | public:
|
---|
| 165 | BackgroundImage() : Property(
|
---|
| 166 | "BackgroundImage",
|
---|
| 167 | "Property to get/set the background image for the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 168 | "")
|
---|
| 169 | {}
|
---|
| 170 |
|
---|
| 171 | String get(const PropertyReceiver* receiver) const;
|
---|
| 172 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 173 | };
|
---|
| 174 |
|
---|
| 175 |
|
---|
| 176 | /*!
|
---|
| 177 | \brief
|
---|
| 178 | Property to access the top-left image for the frame of the Static widget.
|
---|
| 179 |
|
---|
| 180 | \par Usage:
|
---|
| 181 | - Name: TopLeftFrameImage
|
---|
| 182 | - Format: "set:[text] image:[text]".
|
---|
| 183 |
|
---|
| 184 | \par Where:
|
---|
| 185 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 186 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 187 | */
|
---|
| 188 | class TopLeftFrameImage : public Property
|
---|
| 189 | {
|
---|
| 190 | public:
|
---|
| 191 | TopLeftFrameImage() : Property(
|
---|
| 192 | "TopLeftFrameImage",
|
---|
| 193 | "Property to get/set the top-left image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 194 | "")
|
---|
| 195 | {}
|
---|
| 196 |
|
---|
| 197 | String get(const PropertyReceiver* receiver) const;
|
---|
| 198 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 199 | };
|
---|
| 200 |
|
---|
| 201 |
|
---|
| 202 | /*!
|
---|
| 203 | \brief
|
---|
| 204 | Property to access the top-right image for the frame of the Static widget.
|
---|
| 205 |
|
---|
| 206 | \par Usage:
|
---|
| 207 | - Name: TopRightFrameImage
|
---|
| 208 | - Format: "set:[text] image:[text]".
|
---|
| 209 |
|
---|
| 210 | \par Where:
|
---|
| 211 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 212 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 213 | */
|
---|
| 214 | class TopRightFrameImage : public Property
|
---|
| 215 | {
|
---|
| 216 | public:
|
---|
| 217 | TopRightFrameImage() : Property(
|
---|
| 218 | "TopRightFrameImage",
|
---|
| 219 | "Property to get/set the top-right image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 220 | "")
|
---|
| 221 | {}
|
---|
| 222 |
|
---|
| 223 | String get(const PropertyReceiver* receiver) const;
|
---|
| 224 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 225 | };
|
---|
| 226 |
|
---|
| 227 |
|
---|
| 228 | /*!
|
---|
| 229 | \brief
|
---|
| 230 | Property to access the bottom-left image for the frame of the Static widget.
|
---|
| 231 |
|
---|
| 232 | \par Usage:
|
---|
| 233 | - Name: BottomLeftFrameImage
|
---|
| 234 | - Format: "set:[text] image:[text]".
|
---|
| 235 |
|
---|
| 236 | \par Where:
|
---|
| 237 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 238 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 239 | */
|
---|
| 240 | class BottomLeftFrameImage : public Property
|
---|
| 241 | {
|
---|
| 242 | public:
|
---|
| 243 | BottomLeftFrameImage() : Property(
|
---|
| 244 | "BottomLeftFrameImage",
|
---|
| 245 | "Property to get/set the bottom-left image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 246 | "")
|
---|
| 247 | {}
|
---|
| 248 |
|
---|
| 249 | String get(const PropertyReceiver* receiver) const;
|
---|
| 250 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 251 | };
|
---|
| 252 |
|
---|
| 253 |
|
---|
| 254 | /*!
|
---|
| 255 | \brief
|
---|
| 256 | Property to access the bottom-right image for the frame of the Static widget.
|
---|
| 257 |
|
---|
| 258 | \par Usage:
|
---|
| 259 | - Name: BottomRightFrameImage
|
---|
| 260 | - Format: "set:[text] image:[text]".
|
---|
| 261 |
|
---|
| 262 | \par Where:
|
---|
| 263 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 264 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 265 | */
|
---|
| 266 | class BottomRightFrameImage : public Property
|
---|
| 267 | {
|
---|
| 268 | public:
|
---|
| 269 | BottomRightFrameImage() : Property(
|
---|
| 270 | "BottomRightFrameImage",
|
---|
| 271 | "Property to get/set the bottom-right image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 272 | "")
|
---|
| 273 | {}
|
---|
| 274 |
|
---|
| 275 | String get(const PropertyReceiver* receiver) const;
|
---|
| 276 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 277 | };
|
---|
| 278 |
|
---|
| 279 |
|
---|
| 280 | /*!
|
---|
| 281 | \brief
|
---|
| 282 | Property to access the left edge image for the frame of the Static widget.
|
---|
| 283 |
|
---|
| 284 | \par Usage:
|
---|
| 285 | - Name: LeftFrameImage
|
---|
| 286 | - Format: "set:[text] image:[text]".
|
---|
| 287 |
|
---|
| 288 | \par Where:
|
---|
| 289 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 290 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 291 | */
|
---|
| 292 | class LeftFrameImage : public Property
|
---|
| 293 | {
|
---|
| 294 | public:
|
---|
| 295 | LeftFrameImage() : Property(
|
---|
| 296 | "LeftFrameImage",
|
---|
| 297 | "Property to get/set the left edge image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 298 | "")
|
---|
| 299 | {}
|
---|
| 300 |
|
---|
| 301 | String get(const PropertyReceiver* receiver) const;
|
---|
| 302 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 303 | };
|
---|
| 304 |
|
---|
| 305 |
|
---|
| 306 | /*!
|
---|
| 307 | \brief
|
---|
| 308 | Property to access the right edge image for the frame of the Static widget.
|
---|
| 309 |
|
---|
| 310 | \par Usage:
|
---|
| 311 | - Name: RightFrameImage
|
---|
| 312 | - Format: "set:[text] image:[text]".
|
---|
| 313 |
|
---|
| 314 | \par Where:
|
---|
| 315 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 316 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 317 | */
|
---|
| 318 | class RightFrameImage : public Property
|
---|
| 319 | {
|
---|
| 320 | public:
|
---|
| 321 | RightFrameImage() : Property(
|
---|
| 322 | "RightFrameImage",
|
---|
| 323 | "Property to get/set the right edge image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 324 | "")
|
---|
| 325 | {}
|
---|
| 326 |
|
---|
| 327 | String get(const PropertyReceiver* receiver) const;
|
---|
| 328 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 329 | };
|
---|
| 330 |
|
---|
| 331 |
|
---|
| 332 | /*!
|
---|
| 333 | \brief
|
---|
| 334 | Property to access the top edge image for the frame of the Static widget.
|
---|
| 335 |
|
---|
| 336 | \par Usage:
|
---|
| 337 | - Name: TopFrameImage
|
---|
| 338 | - Format: "set:[text] image:[text]".
|
---|
| 339 |
|
---|
| 340 | \par Where:
|
---|
| 341 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 342 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 343 | */
|
---|
| 344 | class TopFrameImage : public Property
|
---|
| 345 | {
|
---|
| 346 | public:
|
---|
| 347 | TopFrameImage() : Property(
|
---|
| 348 | "TopFrameImage",
|
---|
| 349 | "Property to get/set the top edge image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 350 | "")
|
---|
| 351 | {}
|
---|
| 352 |
|
---|
| 353 | String get(const PropertyReceiver* receiver) const;
|
---|
| 354 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 355 | };
|
---|
| 356 |
|
---|
| 357 |
|
---|
| 358 | /*!
|
---|
| 359 | \brief
|
---|
| 360 | Property to access the bottom edge image for the frame of the Static widget.
|
---|
| 361 |
|
---|
| 362 | \par Usage:
|
---|
| 363 | - Name: BottomFrameImage
|
---|
| 364 | - Format: "set:[text] image:[text]".
|
---|
| 365 |
|
---|
| 366 | \par Where:
|
---|
| 367 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 368 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 369 | */
|
---|
| 370 | class BottomFrameImage : public Property
|
---|
| 371 | {
|
---|
| 372 | public:
|
---|
| 373 | BottomFrameImage() : Property(
|
---|
| 374 | "BottomFrameImage",
|
---|
| 375 | "Property to get/set the bottom edge image for the frame of the Static widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 376 | "")
|
---|
| 377 | {}
|
---|
| 378 |
|
---|
| 379 | String get(const PropertyReceiver* receiver) const;
|
---|
| 380 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 381 | };
|
---|
| 382 |
|
---|
| 383 |
|
---|
| 384 |
|
---|
| 385 |
|
---|
| 386 | } // End of StaticProperties namespace section
|
---|
| 387 |
|
---|
| 388 | } // End of CEGUI namespace section
|
---|
| 389 |
|
---|
| 390 |
|
---|
| 391 | #endif // end of guard _CEGUIStaticProperties_h_
|
---|