# CEGUIFrameWindowProperties.h

    00001 /************************************************************************
    00002         filename:       CEGUIFrameWindowProperties.h
    00003         created:        10/7/2004
    00004         author:         Paul D Turner
    00005
    00006         purpose:        Interface to properties for FrameWIndow class
    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 _CEGUIFrameWindowProperties_h_
    00027 #define _CEGUIFrameWindowProperties_h_
    00028
    00029 #include "CEGUIProperty.h"
    00030
    00031
    00032 // Start of CEGUI namespace section
    00033 namespace CEGUI
    00034 {
    00035
    00036 // Start of FrameWindowProperties namespace section
    00041 namespace FrameWindowProperties
    00042 {
    00055 class SizingEnabled : public Property
    00056 {
    00057 public:
    00058         SizingEnabled() : Property(
    00059                 "SizingEnabled",
    00060                 "Property to get/set the state of the sizable setting for the FrameWindow.  Value is either \"True\" or \"False\".",
    00061                 "True")
    00062         {}
    00063
    00064         String  get(const PropertyReceiver* receiver) const;
    00065         void    set(PropertyReceiver* receiver, const String& value);
    00066 };
    00067
    00068
    00081 class FrameEnabled : public Property
    00082 {
    00083 public:
    00084         FrameEnabled() : Property(
    00085                 "FrameEnabled",
    00086                 "Property to get/set the setting for whether the window frame will be displayed.  Value is either \"True\" or \"False\".",
    00087                 "True")
    00088         {}
    00089
    00090         String  get(const PropertyReceiver* receiver) const;
    00091         void    set(PropertyReceiver* receiver, const String& value);
    00092 };
    00093
    00094
    00107 class TitlebarEnabled : public Property
    00108 {
    00109 public:
    00110         TitlebarEnabled() : Property(
    00111                 "TitlebarEnabled",
    00112                 "Property to get/set the setting for whether the window title-bar will be enabled (or displayed depending upon choice of final widget type).  Value is either \"True\" or \"False\".",
    00113                 "")
    00114         {}
    00115
    00116         String  get(const PropertyReceiver* receiver) const;
    00117         void    set(PropertyReceiver* receiver, const String& value);
    00118 };
    00119
    00120
    00133 class CloseButtonEnabled : public Property
    00134 {
    00135 public:
    00136         CloseButtonEnabled() : Property(
    00137                 "CloseButtonEnabled",
    00138                 "Property to get/set the setting for whether the window close button will be enabled (or displayed depending upon choice of final widget type).  Value is either \"True\" or \"False\".",
    00139                 "True")
    00140         {}
    00141
    00142         String  get(const PropertyReceiver* receiver) const;
    00143         void    set(PropertyReceiver* receiver, const String& value);
    00144 };
    00145
    00146
    00159 class RollUpEnabled : public Property
    00160 {
    00161 public:
    00162         RollUpEnabled() : Property(
    00163                 "RollUpEnabled",
    00164                 "Property to get/set the setting for whether the user is able to roll-up / shade the window.  Value is either \"True\" or \"False\".",
    00165                 "True")
    00166         {}
    00167
    00168         String  get(const PropertyReceiver* receiver) const;
    00169         void    set(PropertyReceiver* receiver, const String& value);
    00170 };
    00171
    00172
    00185 class RollUpState : public Property
    00186 {
    00187 public:
    00188         RollUpState() : Property(
    00189                 "RollUpState",
    00190                 "Property to get/set the roll-up / shade state of the window.  Value is either \"True\" or \"False\".",
    00191                 "False")
    00192         {}
    00193
    00194         String  get(const PropertyReceiver* receiver) const;
    00195         void    set(PropertyReceiver* receiver, const String& value);
    00196 };
    00197
    00198
    00211 class DragMovingEnabled : public Property
    00212 {
    00213 public:
    00214         DragMovingEnabled() : Property(
    00215                 "DragMovingEnabled",
    00216                 "Property to get/set the setting for whether the user may drag the window around by its title bar.  Value is either \"True\" or \"False\".",
    00217                 "True")
    00218         {}
    00219
    00220         String  get(const PropertyReceiver* receiver) const;
    00221         void    set(PropertyReceiver* receiver, const String& value);
    00222 };
    00223
    00224
    00236 class SizingBorderThickness : public Property
    00237 {
    00238 public:
    00239         SizingBorderThickness() : Property(
    00240                 "SizingBorderThickness",
    00241                 "Property to get/set the setting for the sizing border thickness.  Value is a float specifying the border thickness in pixels.",
    00242                 "8.000000")
    00243         {}
    00244
    00245         String  get(const PropertyReceiver* receiver) const;
    00246         void    set(PropertyReceiver* receiver, const String& value);
    00247 };
    00248
    00249
    00261 class TitlebarFont : public Property
    00262 {
    00263 public:
    00264         TitlebarFont() : Property(
    00265                 "TitlebarFont",
    00266                 "Property to get/set the Font set for the windows title bar.  Value is the name of the font to use (must be loaded already).",
    00267                 "")
    00268         {}
    00269
    00270         String  get(const PropertyReceiver* receiver) const;
    00271         void    set(PropertyReceiver* receiver, const String& value);
    00272 };
    00273
    00285 class CaptionColour : public Property
    00286 {
    00287 public:
    00288         CaptionColour() : Property(
    00289                 "CaptionColour",
    00290                 "Property to get/set the colour used for rendering the caption text.  Value is \"aarrggbb\" (hex).",
    00291                 "FF000000")
    00292         {}
    00293
    00294         String  get(const PropertyReceiver* receiver) const;
    00295         void    set(PropertyReceiver* receiver, const String& value);
    00296 };
    00297
    00307 class NSSizingCursorImage : public Property
    00308 {
    00309 public:
    00310    NSSizingCursorImage() : Property(
    00311            "NSSizingCursorImage",
    00312            "Property to get/set the N-S (up-down) sizing cursor image for the FramwWindow.  Value should be \"set:[imageset name] image:[image name]\".",
    00313            "")
    00314    {}
    00315
    00316    String   get(const PropertyReceiver* receiver) const;
    00317    void   set(PropertyReceiver* receiver, const String& value);
    00318 };
    00319
    00329 class EWSizingCursorImage : public Property
    00330 {
    00331 public:
    00332    EWSizingCursorImage() : Property(
    00333            "EWSizingCursorImage",
    00334            "Property to get/set the E-W (left-right) sizing cursor image for the FramwWindow.  Value should be \"set:[imageset name] image:[image name]\".",
    00335            "")
    00336    {}
    00337
    00338    String   get(const PropertyReceiver* receiver) const;
    00339    void   set(PropertyReceiver* receiver, const String& value);
    00340 };
    00341
    00351 class NWSESizingCursorImage : public Property
    00352 {
    00353 public:
    00354    NWSESizingCursorImage() : Property(
    00355            "NWSESizingCursorImage",
    00356            "Property to get/set the NW-SE diagonal sizing cursor image for the FramwWindow.  Value should be \"set:[imageset name] image:[image name]\".",
    00357            "")
    00358    {}
    00359
    00360    String   get(const PropertyReceiver* receiver) const;
    00361    void   set(PropertyReceiver* receiver, const String& value);
    00362 };
    00363
    00373 class NESWSizingCursorImage : public Property
    00374 {
    00375 public:
    00376    NESWSizingCursorImage() : Property(
    00377            "NESWSizingCursorImage",
    00378            "Property to get/set the NE-SW diagonal sizing cursor image for the FramwWindow.  Value should be \"set:[imageset name] image:[image name]\".",
    00379            "")
    00380    {}
    00381
    00382    String   get(const PropertyReceiver* receiver) const;
    00383    void   set(PropertyReceiver* receiver, const String& value);
    00384 };
    00385
    00386 } // End of  FrameWindowProperties namespace section
    00387
    00388 } // End of  CEGUI namespace section
    00389
    00390
    00391 #endif  // end of guard _CEGUIFrameWindowProperties_h_