CEGUIDragContainerProperties.h

/***********************************************************************
        filename:       CEGUIDragContainerProperties.h
        created:        15/2/2005
        author:         Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIDragContainerProperties_h_
#define _CEGUIDragContainerProperties_h_

#include "../CEGUIProperty.h"

// Start of CEGUI namespace section
namespace CEGUI
{
// Start of DragContainerProperties namespace section
namespace DragContainerProperties
{
    class DraggingEnabled : public Property
    {
    public:
            DraggingEnabled() : Property(
                    "DraggingEnabled",
                    "Property to get/set the state of the dragging enabled setting for the DragContainer.  Value is either \"True\" or \"False\".",
                    "True")
            {}

            String      get(const PropertyReceiver* receiver) const;
            void        set(PropertyReceiver* receiver, const String& value);
    };

    class DragAlpha : public Property
    {
    public:
            DragAlpha() : Property(
                    "DragAlpha",
                    "Property to get/set the dragging alpha value.  Value is a float.",
                    "0.500000")
            {}

            String get(const PropertyReceiver* receiver) const;
            void set(PropertyReceiver* receiver, const String& value);
    };

    class DragThreshold : public Property
    {
    public:
            DragThreshold() : Property(
                    "DragThreshold",
                    "Property to get/set the dragging threshold value.  Value is a float.",
                    "8.000000")
            {}

            String get(const PropertyReceiver* receiver) const;
            void set(PropertyReceiver* receiver, const String& value);
    };

    class DragCursorImage : public Property
    {
    public:
            DragCursorImage() : Property(
                    "DragCursorImage",
                    "Property to get/set the mouse cursor image used when dragging.  Value should be \"set:<imageset name> image:<image name>\".",
                    "")
            {}

            String      get(const PropertyReceiver* receiver) const;
            void        set(PropertyReceiver* receiver, const String& value);
    };

    class StickyMode : public Property
    {
    public:
        StickyMode() : Property(
            "StickyMode",
            "Property to get/set the state of the sticky mode setting for the "
                "DragContainer.  Value is either \"True\" or \"False\".",
            "True")
        {}

        String get(const PropertyReceiver* receiver) const;
        void set(PropertyReceiver* receiver, const String& value);
    };

    class FixedDragOffset : public Property
    {
    public:
        FixedDragOffset() : Property(
            "FixedDragOffset",
            "Property to get/set the state of the fixed dragging offset "
                "setting for the DragContainer.  "
                "Value is a UVector2 property value.",
            "{{0,0},{0,0}}")
        {}

        String get(const PropertyReceiver* receiver) const;
        void set(PropertyReceiver* receiver, const String& value);
    };

    class UseFixedDragOffset : public Property
    {
    public:
        UseFixedDragOffset() : Property(
            "UseFixedDragOffset",
            "Property to get/set the setting that control whether the fixed "
                "dragging offset will be used.  "
                "Value is either \"True\" or \"False\".",
            "False")
        {}

        String get(const PropertyReceiver* receiver) const;
        void set(PropertyReceiver* receiver, const String& value);
    };


} // End of  DragContainerProperties namespace section
} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIDragContainerProperties_h_