Crazy Eddies GUI System: CEGUIStaticProperties.h Source File

- Main Page
- Namespaces
- Classes
- Files
- Directories
- Related Pages

# CEGUIStaticProperties.h

    00001 /************************************************************************
    00002         filename:       CEGUIStaticProperties.h
    00003         created:        10/7/2004
    00004         author:         Paul D Turner
    00005
    00006         purpose:        Interface to properties for Static (base class) widget.
    00007 *************************************************************************/
    00008 /*************************************************************************
    00009     Crazy Eddie's GUI System (http://www.cegui.org.uk)
    00010     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
    00011
    00012     This library is free software; you can redistribute it and/or
    00013     modify it under the terms of the GNU Lesser General Public
    00014     License as published by the Free Software Foundation; either
    00015     version 2.1 of the License, or (at your option) any later version.
    00016
    00017     This library is distributed in the hope that it will be useful,
    00018     but WITHOUT ANY WARRANTY; without even the implied warranty of
    00019     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00020     Lesser General Public License for more details.
    00021
    00022     You should have received a copy of the GNU Lesser General Public
    00023     License along with this library; if not, write to the Free Software
    00024     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    00025 *************************************************************************/
    00026 #ifndef _CEGUIStaticProperties_h_
    00027 #define _CEGUIStaticProperties_h_
    00028
    00029 #include "CEGUIProperty.h"
    00030
    00031 // Start of CEGUI namespace section
    00032 namespace CEGUI
    00033 {
    00034
    00035 // Start of StaticProperties namespace section
    00040 namespace StaticProperties
    00041 {
    00054 class FrameEnabled : public Property
    00055 {
    00056 public:
    00057         FrameEnabled() : Property(
    00058                 "FrameEnabled",
    00059                 "Property to get/set the state of the frame enabled setting for the Static widget.  Value is either \"True\" or \"False\".",
    00060                 "True")
    00061         {}
    00062
    00063         String  get(const PropertyReceiver* receiver) const;
    00064         void    set(PropertyReceiver* receiver, const String& value);
    00065 };
    00066
    00067
    00080 class BackgroundEnabled : public Property
    00081 {
    00082 public:
    00083         BackgroundEnabled() : Property(
    00084                 "BackgroundEnabled",
    00085                 "Property to get/set the state of the frame background setting for the Static widget.  Value is either \"True\" or \"False\".",
    00086                 "True")
    00087         {}
    00088
    00089         String  get(const PropertyReceiver* receiver) const;
    00090         void    set(PropertyReceiver* receiver, const String& value);
    00091 };
    00092
    00093
    00108 class FrameColours : public Property
    00109 {
    00110 public:
    00111         FrameColours() : Property(
    00112                 "FrameColours",
    00113                 "Property to get/set the frame colours for the Static widget.  Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
    00114                 "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
    00115         {}
    00116
    00117         String  get(const PropertyReceiver* receiver) const;
    00118         void    set(PropertyReceiver* receiver, const String& value);
    00119 };
    00120
    00121
    00136 class BackgroundColours : public Property
    00137 {
    00138 public:
    00139         BackgroundColours() : Property(
    00140                 "BackgroundColours",
    00141                 "Property to get/set the background colours for the Static widget.  Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
    00142                 "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
    00143         {}
    00144
    00145         String  get(const PropertyReceiver* receiver) const;
    00146         void    set(PropertyReceiver* receiver, const String& value);
    00147 };
    00148
    00149
    00162 class BackgroundImage : public Property
    00163 {
    00164 public:
    00165         BackgroundImage() : Property(
    00166                 "BackgroundImage",
    00167                 "Property to get/set the background image for the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00168                 "")
    00169         {}
    00170
    00171         String  get(const PropertyReceiver* receiver) const;
    00172         void    set(PropertyReceiver* receiver, const String& value);
    00173 };
    00174
    00175
    00188 class TopLeftFrameImage : public Property
    00189 {
    00190 public:
    00191         TopLeftFrameImage() : Property(
    00192                 "TopLeftFrameImage",
    00193                 "Property to get/set the top-left image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00194                 "")
    00195         {}
    00196
    00197         String  get(const PropertyReceiver* receiver) const;
    00198         void    set(PropertyReceiver* receiver, const String& value);
    00199 };
    00200
    00201
    00214 class TopRightFrameImage : public Property
    00215 {
    00216 public:
    00217         TopRightFrameImage() : Property(
    00218                 "TopRightFrameImage",
    00219                 "Property to get/set the top-right image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00220                 "")
    00221         {}
    00222
    00223         String  get(const PropertyReceiver* receiver) const;
    00224         void    set(PropertyReceiver* receiver, const String& value);
    00225 };
    00226
    00227
    00240 class BottomLeftFrameImage : public Property
    00241 {
    00242 public:
    00243         BottomLeftFrameImage() : Property(
    00244                 "BottomLeftFrameImage",
    00245                 "Property to get/set the bottom-left image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00246                 "")
    00247         {}
    00248
    00249         String  get(const PropertyReceiver* receiver) const;
    00250         void    set(PropertyReceiver* receiver, const String& value);
    00251 };
    00252
    00253
    00266 class BottomRightFrameImage : public Property
    00267 {
    00268 public:
    00269         BottomRightFrameImage() : Property(
    00270                 "BottomRightFrameImage",
    00271                 "Property to get/set the bottom-right image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00272                 "")
    00273         {}
    00274
    00275         String  get(const PropertyReceiver* receiver) const;
    00276         void    set(PropertyReceiver* receiver, const String& value);
    00277 };
    00278
    00279
    00292 class LeftFrameImage : public Property
    00293 {
    00294 public:
    00295         LeftFrameImage() : Property(
    00296                 "LeftFrameImage",
    00297                 "Property to get/set the left edge image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00298                 "")
    00299         {}
    00300
    00301         String  get(const PropertyReceiver* receiver) const;
    00302         void    set(PropertyReceiver* receiver, const String& value);
    00303 };
    00304
    00305
    00318 class RightFrameImage : public Property
    00319 {
    00320 public:
    00321         RightFrameImage() : Property(
    00322                 "RightFrameImage",
    00323                 "Property to get/set the right edge image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00324                 "")
    00325         {}
    00326
    00327         String  get(const PropertyReceiver* receiver) const;
    00328         void    set(PropertyReceiver* receiver, const String& value);
    00329 };
    00330
    00331
    00344 class TopFrameImage : public Property
    00345 {
    00346 public:
    00347         TopFrameImage() : Property(
    00348                 "TopFrameImage",
    00349                 "Property to get/set the top edge image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00350                 "")
    00351         {}
    00352
    00353         String  get(const PropertyReceiver* receiver) const;
    00354         void    set(PropertyReceiver* receiver, const String& value);
    00355 };
    00356
    00357
    00370 class BottomFrameImage : public Property
    00371 {
    00372 public:
    00373         BottomFrameImage() : Property(
    00374                 "BottomFrameImage",
    00375                 "Property to get/set the bottom edge image for the frame of the Static widget.  Value should be \"set:[imageset name] image:[image name]\".",
    00376                 "")
    00377         {}
    00378
    00379         String  get(const PropertyReceiver* receiver) const;
    00380         void    set(PropertyReceiver* receiver, const String& value);
    00381 };
    00382
    00383
    00384
    00385
    00386 } // End of  StaticProperties namespace section
    00387
    00388 } // End of  CEGUI namespace section
    00389
    00390
    00391 #endif  // end of guard _CEGUIStaticProperties_h_