Crazy Eddies GUI System: CEGUIDragContainerProperties.h Source File

Crazy Eddies GUI System 0.7.6

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

- File List

CEGUIDragContainerProperties.h

    00001 /***********************************************************************
    00002         filename:       CEGUIDragContainerProperties.h
    00003         created:        15/2/2005
    00004         author:         Paul D Turner
    00005 *************************************************************************/
    00006 /***************************************************************************
    00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
    00008  *
    00009  *   Permission is hereby granted, free of charge, to any person obtaining
    00010  *   a copy of this software and associated documentation files (the
    00011  *   "Software"), to deal in the Software without restriction, including
    00012  *   without limitation the rights to use, copy, modify, merge, publish,
    00013  *   distribute, sublicense, and/or sell copies of the Software, and to
    00014  *   permit persons to whom the Software is furnished to do so, subject to
    00015  *   the following conditions:
    00016  *
    00017  *   The above copyright notice and this permission notice shall be
    00018  *   included in all copies or substantial portions of the Software.
    00019  *
    00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
    00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
    00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    00026  *   OTHER DEALINGS IN THE SOFTWARE.
    00027  ***************************************************************************/
    00028 #ifndef _CEGUIDragContainerProperties_h_
    00029 #define _CEGUIDragContainerProperties_h_
    00030
    00031 #include "../CEGUIProperty.h"
    00032
    00033 // Start of CEGUI namespace section
    00034 namespace CEGUI
    00035 {
    00036 // Start of DragContainerProperties namespace section
    00037 namespace DragContainerProperties
    00038 {
    00051     class DraggingEnabled : public Property
    00052     {
    00053     public:
    00054             DraggingEnabled() : Property(
    00055                     "DraggingEnabled",
    00056                     "Property to get/set the state of the dragging enabled setting for the DragContainer.  Value is either \"True\" or \"False\".",
    00057                     "True")
    00058             {}
    00059
    00060             String      get(const PropertyReceiver* receiver) const;
    00061             void        set(PropertyReceiver* receiver, const String& value);
    00062     };
    00063
    00075     class DragAlpha : public Property
    00076     {
    00077     public:
    00078             DragAlpha() : Property(
    00079                     "DragAlpha",
    00080                     "Property to get/set the dragging alpha value.  Value is a float.",
    00081                     "0.500000")
    00082             {}
    00083
    00084             String get(const PropertyReceiver* receiver) const;
    00085             void set(PropertyReceiver* receiver, const String& value);
    00086     };
    00087
    00099     class DragThreshold : public Property
    00100     {
    00101     public:
    00102             DragThreshold() : Property(
    00103                     "DragThreshold",
    00104                     "Property to get/set the dragging threshold value.  Value is a float.",
    00105                     "8.000000")
    00106             {}
    00107
    00108             String get(const PropertyReceiver* receiver) const;
    00109             void set(PropertyReceiver* receiver, const String& value);
    00110     };
    00111
    00126     class DragCursorImage : public Property
    00127     {
    00128     public:
    00129             DragCursorImage() : Property(
    00130                     "DragCursorImage",
    00131                     "Property to get/set the mouse cursor image used when dragging.  Value should be \"set:<imageset name> image:<image name>\".",
    00132                     "")
    00133             {}
    00134
    00135             String      get(const PropertyReceiver* receiver) const;
    00136             void        set(PropertyReceiver* receiver, const String& value);
    00137     };
    00138
    00151     class StickyMode : public Property
    00152     {
    00153     public:
    00154         StickyMode() : Property(
    00155             "StickyMode",
    00156             "Property to get/set the state of the sticky mode setting for the "
    00157                 "DragContainer.  Value is either \"True\" or \"False\".",
    00158             "True")
    00159         {}
    00160
    00161         String get(const PropertyReceiver* receiver) const;
    00162         void set(PropertyReceiver* receiver, const String& value);
    00163     };
    00164
    00183     class FixedDragOffset : public Property
    00184     {
    00185     public:
    00186         FixedDragOffset() : Property(
    00187             "FixedDragOffset",
    00188             "Property to get/set the state of the fixed dragging offset "
    00189                 "setting for the DragContainer.  "
    00190                 "Value is a UVector2 property value.",
    00191             "{{0,0},{0,0}}")
    00192         {}
    00193
    00194         String get(const PropertyReceiver* receiver) const;
    00195         void set(PropertyReceiver* receiver, const String& value);
    00196     };
    00197
    00212     class UseFixedDragOffset : public Property
    00213     {
    00214     public:
    00215         UseFixedDragOffset() : Property(
    00216             "UseFixedDragOffset",
    00217             "Property to get/set the setting that control whether the fixed "
    00218                 "dragging offset will be used.  "
    00219                 "Value is either \"True\" or \"False\".",
    00220             "False")
    00221         {}
    00222
    00223         String get(const PropertyReceiver* receiver) const;
    00224         void set(PropertyReceiver* receiver, const String& value);
    00225     };
    00226
    00227
    00228 } // End of  DragContainerProperties namespace section
    00229 } // End of  CEGUI namespace section
    00230
    00231 #endif  // end of guard _CEGUIDragContainerProperties_h_