Crazy Eddies GUI System 0.7.5

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  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00010  *
00011  *   Permission is hereby granted, free of charge, to any person obtaining
00012  *   a copy of this software and associated documentation files (the
00013  *   "Software"), to deal in the Software without restriction, including
00014  *   without limitation the rights to use, copy, modify, merge, publish,
00015  *   distribute, sublicense, and/or sell copies of the Software, and to
00016  *   permit persons to whom the Software is furnished to do so, subject to
00017  *   the following conditions:
00018  *
00019  *   The above copyright notice and this permission notice shall be
00020  *   included in all copies or substantial portions of the Software.
00021  *
00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00028  *   OTHER DEALINGS IN THE SOFTWARE.
00029  ***************************************************************************/
00030 #ifndef _CEGUIFrameWindowProperties_h_
00031 #define _CEGUIFrameWindowProperties_h_
00032 
00033 #include "../CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of FrameWindowProperties namespace section
00045 namespace FrameWindowProperties
00046 {
00059 class SizingEnabled : public Property
00060 {
00061 public:
00062         SizingEnabled() : Property(
00063                 "SizingEnabled",
00064                 "Property to get/set the state of the sizable setting for the FrameWindow.  Value is either \"True\" or \"False\".",
00065                 "True")
00066         {}
00067 
00068         String  get(const PropertyReceiver* receiver) const;
00069         void    set(PropertyReceiver* receiver, const String& value);
00070 };
00071 
00072 
00085 class FrameEnabled : public Property
00086 {
00087 public:
00088         FrameEnabled() : Property(
00089                 "FrameEnabled",
00090                 "Property to get/set the setting for whether the window frame will be displayed.  Value is either \"True\" or \"False\".",
00091                 "True")
00092         {}
00093 
00094         String  get(const PropertyReceiver* receiver) const;
00095         void    set(PropertyReceiver* receiver, const String& value);
00096 };
00097 
00098 
00111 class TitlebarEnabled : public Property
00112 {
00113 public:
00114         TitlebarEnabled() : Property(
00115                 "TitlebarEnabled",
00116                 "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\".",
00117                 "") 
00118         {}
00119 
00120         String  get(const PropertyReceiver* receiver) const;
00121         void    set(PropertyReceiver* receiver, const String& value);
00122 };
00123 
00124 
00137 class CloseButtonEnabled : public Property
00138 {
00139 public:
00140         CloseButtonEnabled() : Property(
00141                 "CloseButtonEnabled",
00142                 "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\".",
00143                 "True")
00144         {}
00145 
00146         String  get(const PropertyReceiver* receiver) const;
00147         void    set(PropertyReceiver* receiver, const String& value);
00148 };
00149 
00150 
00163 class RollUpEnabled : public Property
00164 {
00165 public:
00166         RollUpEnabled() : Property(
00167                 "RollUpEnabled",
00168                 "Property to get/set the setting for whether the user is able to roll-up / shade the window.  Value is either \"True\" or \"False\".",
00169                 "True")
00170         {}
00171 
00172         String  get(const PropertyReceiver* receiver) const;
00173         void    set(PropertyReceiver* receiver, const String& value);
00174 };
00175 
00176 
00189 class RollUpState : public Property
00190 {
00191 public:
00192         RollUpState() : Property(
00193                 "RollUpState",
00194                 "Property to get/set the roll-up / shade state of the window.  Value is either \"True\" or \"False\".",
00195                 "False")
00196         {}
00197 
00198         String  get(const PropertyReceiver* receiver) const;
00199         void    set(PropertyReceiver* receiver, const String& value);
00200 };
00201 
00202 
00215 class DragMovingEnabled : public Property
00216 {
00217 public:
00218         DragMovingEnabled() : Property(
00219                 "DragMovingEnabled",
00220                 "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\".",
00221                 "True")
00222         {}
00223 
00224         String  get(const PropertyReceiver* receiver) const;
00225         void    set(PropertyReceiver* receiver, const String& value);
00226 };
00227 
00228 
00240 class SizingBorderThickness : public Property
00241 {
00242 public:
00243         SizingBorderThickness() : Property(
00244                 "SizingBorderThickness",
00245                 "Property to get/set the setting for the sizing border thickness.  Value is a float specifying the border thickness in pixels.",
00246                 "8")
00247         {}
00248 
00249         String  get(const PropertyReceiver* receiver) const;
00250         void    set(PropertyReceiver* receiver, const String& value);
00251 };
00252 
00253 
00263 class NSSizingCursorImage : public Property
00264 {
00265 public:
00266    NSSizingCursorImage() : Property(
00267            "NSSizingCursorImage",
00268            "Property to get/set the N-S (up-down) sizing cursor image for the FramwWindow.  Value should be \"set:[imageset name] image:[image name]\".",
00269            "")
00270    {}
00271 
00272    String   get(const PropertyReceiver* receiver) const;
00273    void   set(PropertyReceiver* receiver, const String& value);
00274 };
00275 
00285 class EWSizingCursorImage : public Property
00286 {
00287 public:
00288    EWSizingCursorImage() : Property(
00289            "EWSizingCursorImage",
00290            "Property to get/set the E-W (left-right) sizing cursor image for the FramwWindow.  Value should be \"set:[imageset name] image:[image name]\".",
00291            "")
00292    {}
00293 
00294    String   get(const PropertyReceiver* receiver) const;
00295    void   set(PropertyReceiver* receiver, const String& value);
00296 };
00297 
00307 class NWSESizingCursorImage : public Property
00308 {
00309 public:
00310    NWSESizingCursorImage() : Property(
00311            "NWSESizingCursorImage",
00312            "Property to get/set the NW-SE diagonal 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 NESWSizingCursorImage : public Property
00330 {
00331 public:
00332    NESWSizingCursorImage() : Property(
00333            "NESWSizingCursorImage",
00334            "Property to get/set the NE-SW diagonal 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 
00342 } // End of  FrameWindowProperties namespace section
00343 
00344 } // End of  CEGUI namespace section
00345 
00346 
00347 #endif  // end of guard _CEGUIFrameWindowProperties_h_