CEGUIWindowProperties.h

/***********************************************************************
        filename:       CEGUIWindowProperties.h
        created:        5/7/2004
        author:         Paul D Turner

        purpose:        Interface to available window base class properties
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIWindowProperties_h_
#define _CEGUIWindowProperties_h_

#include "CEGUIProperty.h"
#include "CEGUIXMLSerializer.h"

// Start of CEGUI namespace section
namespace CEGUI
{

// Start of WindowProperties namespace section
namespace WindowProperties
{
class ID : public Property
{
public:
        ID() : Property(
                "ID",
                "Property to get/set the ID value of the Window.  Value is an unsigned integer number.",
                "0")
        {}

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


class Alpha : public Property
{
public:
        Alpha() : Property(
                "Alpha",
                "Property to get/set the alpha value of the Window.  Value is floating point number.",
                "1")
        {}

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


class Font : public Property
{
public:
        Font() : Property(
                "Font",
                "Property to get/set the font for the Window.  Value is the name of the font to use (must be loaded already).",
                "")
        {}

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


class Text : public Property
{
public:
        Text() : Property(
                "Text",
                "Property to get/set the text / caption for the Window.  Value is the text string to use.",
                "")
        {}

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


class MouseCursorImage : public Property
{
public:
        MouseCursorImage() : Property(
                "MouseCursorImage",
                "Property to get/set the mouse cursor image for the Window.  Value should be \"set:<imageset name> image:<image name>\".",
                "")
        {}

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


class ClippedByParent : public Property
{
public:
        ClippedByParent() : Property(
                "ClippedByParent",
                "Property to get/set the 'clipped by parent' setting for the Window.  Value is either \"True\" or \"False\".",
                "True")
        {}

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


class InheritsAlpha : public Property
{
public:
        InheritsAlpha() : Property(
                "InheritsAlpha",
                "Property to get/set the 'inherits alpha' setting for the Window.  Value is either \"True\" or \"False\".",
                "True")
        {}

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


class AlwaysOnTop : public Property
{
public:
        AlwaysOnTop() : Property(
                "AlwaysOnTop",
                "Property to get/set the 'always on top' setting for the Window.  Value is either \"True\" or \"False\".",
                "False")
        {}

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


class Disabled : public Property
{
public:
        Disabled() : Property(
                "Disabled",
                "Property to get/set the 'disabled state' setting for the Window.  Value is either \"True\" or \"False\".",
                "False")
        {}

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


class Visible : public Property
{
public:
        Visible() : Property(
                "Visible",
                "Property to get/set the 'visible state' setting for the Window.  Value is either \"True\" or \"False\".",
                "True")
        {}

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


class RestoreOldCapture : public Property
{
public:
        RestoreOldCapture() : Property(
                "RestoreOldCapture",
                "Property to get/set the 'restore old capture' setting for the Window.  Value is either \"True\" or \"False\".",
                "False")
        {}

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


class DestroyedByParent : public Property
{
public:
        DestroyedByParent() : Property(
                "DestroyedByParent",
                "Property to get/set the 'destroyed by parent' setting for the Window.  Value is either \"True\" or \"False\".",
                "True")
        {}

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


class ZOrderChangeEnabled : public Property
{
public:
        ZOrderChangeEnabled() : Property(
                "ZOrderChangeEnabled",
                "Property to get/set the 'z-order changing enabled' setting for the Window.  Value is either \"True\" or \"False\".",
                "True")
        {}

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


class WantsMultiClickEvents : public Property
{
public:
    WantsMultiClickEvents() : Property(
        "WantsMultiClickEvents",
        "Property to get/set whether the window will receive double-click and triple-click events.  Value is either \"True\" or \"False\".",
        "True")
    {}

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


class MouseButtonDownAutoRepeat : public Property
{
public:
    MouseButtonDownAutoRepeat() : Property(
        "MouseButtonDownAutoRepeat",
        "Property to get/set whether the window will receive autorepeat mouse button down events.  Value is either \"True\" or \"False\".",
        "False")
    {}

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


class AutoRepeatDelay : public Property
{
public:
    AutoRepeatDelay() : Property(
        "AutoRepeatDelay",
        "Property to get/set the autorepeat delay.  Value is a floating point number indicating the delay required in seconds.",
        "0.3")
    {}

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


class AutoRepeatRate : public Property
{
public:
    AutoRepeatRate() : Property(
        "AutoRepeatRate",
        "Property to get/set the autorepeat rate.  Value is a floating point number indicating the rate required in seconds.",
        "0.06")
    {}

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

class DistributeCapturedInputs : public Property
{
public:
        DistributeCapturedInputs() : Property(
                "DistributeCapturedInputs",
                "Property to get/set whether captured inputs are passed to child windows.  Value is either \"True\" or \"False\".",
                "False")
        {}

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

class CustomTooltipType : public Property
{
public:
    CustomTooltipType() : Property(
    "CustomTooltipType",
    "Property to get/set the custom tooltip for the window.  Value is the type name of the custom tooltip.",
    "")
    {}

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

class Tooltip : public Property
{
public:
    Tooltip() : Property(
    "Tooltip",
    "Property to get/set the tooltip text for the window.  Value is the tooltip text for the window.",
    "")
    {}

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

class InheritsTooltipText : public Property
{
public:
    InheritsTooltipText() : Property(
        "InheritsTooltipText",
        "Property to get/set whether the window inherits its parents tooltip text when it has none of its own.  Value is either \"True\" or \"False\".",
        "True")
    {}

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


class RiseOnClick : public Property
{
public:
    RiseOnClick() : Property(
                "RiseOnClick",
                "Property to get/set whether the window will come tot he top of the z order hwn clicked.  Value is either \"True\" or \"False\".",
                "True")
        {}

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


class VerticalAlignment : public Property
{
    public:
        VerticalAlignment() : Property(
        "VerticalAlignment",
        "Property to get/set the windows vertical alignment.  Value is one of \"Top\", \"Centre\" or \"Bottom\".",
        "Top")
        {}

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


class HorizontalAlignment : public Property
{
    public:
        HorizontalAlignment() : Property(
        "HorizontalAlignment",
        "Property to get/set the windows horizontal alignment.  Value is one of \"Left\", \"Centre\" or \"Right\".",
        "Left")
        {}

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


class UnifiedAreaRect : public Property
{
        public:
                UnifiedAreaRect() : Property(
                "UnifiedAreaRect",
                "Property to get/set the windows unified area rectangle.  Value is a \"URect\".",
                "{{0,0},{0,0},{0,0},{0,0}}")
                {}

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


class UnifiedPosition : public Property
{
        public:
                UnifiedPosition() : Property(
                "UnifiedPosition",
                "Property to get/set the windows unified position.  Value is a \"UVector2\".",
                "{{0,0},{0,0}}", false)
                {}

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


class UnifiedXPosition : public Property
{
        public:
                UnifiedXPosition() : Property(
                "UnifiedXPosition",
                "Property to get/set the windows unified position x-coordinate.  Value is a \"UDim\".",
                "{0,0}", false)
                {}

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


class UnifiedYPosition : public Property
{
        public:
                UnifiedYPosition() : Property(
                "UnifiedYPosition",
                "Property to get/set the windows unified position y-coordinate.  Value is a \"UDim\".",
                "{0,0}", false)
                {}

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


class UnifiedSize : public Property
{
        public:
                UnifiedSize() : Property(
                "UnifiedSize",
                "Property to get/set the windows unified size.  Value is a \"UVector2\".",
                "{{0,0},{0,0}}", false)
                {}

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


class UnifiedWidth : public Property
{
        public:
                UnifiedWidth() : Property(
                "UnifiedWidth",
                "Property to get/set the windows unified width.  Value is a \"UDim\".",
                "{0,0}", false)
                {}

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


class UnifiedHeight : public Property
{
        public:
                UnifiedHeight() : Property(
                "UnifiedHeight",
                "Property to get/set the windows unified height.  Value is a \"UDim\".",
                "{0,0}", false)
                {}

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


class UnifiedMinSize : public Property
{
        public:
                UnifiedMinSize() : Property(
                "UnifiedMinSize",
                "Property to get/set the windows unified minimum size.  Value is a \"UVector2\".",
                "{{0,0},{0,0}}")
                {}

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


class UnifiedMaxSize : public Property
{
        public:
                UnifiedMaxSize() : Property(
                "UnifiedMaxSize",
                "Property to get/set the windows unified maximum size.  Value is a \"UVector2\".",
                "{{1,0},{1,0}}")
                {}

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


class MousePassThroughEnabled : public Property
{
    public:
        MousePassThroughEnabled() : Property(
        "MousePassThroughEnabled",
        "Property to get/set whether the window ignores mouse events and pass them through to any windows behind it. Value is either \"True\" or \"False\".",
        "False")
        {}

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


class WindowRenderer : public Property
{
    public:
        WindowRenderer() : Property(
        "WindowRenderer",
        "Property to get/set the windows assigned window renderer objects name.  Value is a string.",
        "")
        {}

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

        void writeXMLToStream(const PropertyReceiver* receiver, XMLSerializer& xml_stream) const;
};


class LookNFeel : public Property
{
    public:
        LookNFeel() : Property(
        "LookNFeel",
        "Property to get/set the windows assigned look'n'feel.  Value is a string.",
        "")
        {}

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

        void writeXMLToStream(const PropertyReceiver* receiver, XMLSerializer& xml_stream) const;
};

class DragDropTarget : public Property
{
public:
    DragDropTarget() : Property(
        "DragDropTarget",
        "Property to get/set whether the Window will receive drag and drop related notifications.  Value is either \"True\" or \"False\".",
        "True")
    {}

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

class AutoRenderingSurface : public Property
{
public:
    AutoRenderingSurface() : Property(
        "AutoRenderingSurface",
        "Property to get/set whether the Window will automatically attempt to "
        "use a full imagery caching RenderingSurface (if supported by the "
        "renderer).  Here, full imagery caching usually will mean caching a "
        "window's representation onto a texture (although no such "
        "implementation requirement is specified.)"
        "  Value is either \"True\" or \"False\".",
        "False")
    {}

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

class Rotation : public Property
{
    public:
        Rotation() : Property(
        "Rotation",
        "Property to get/set the windows rotation factors.  Value is "
        "\"x:[x_float] y:[y_float] z:[z_float]\".",
        "x:0 y:0 z:0")
        {}

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

class XRotation : public Property
{
    public:
        XRotation() : Property(
        "XRotation",
        "Property to get/set the window's x axis rotation factor.  Value is "
        "\"[float]\".",
        "0", false)
        {}

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

class YRotation : public Property
{
    public:
        YRotation() : Property(
        "YRotation",
        "Property to get/set the window's y axis rotation factor.  Value is "
        "\"[float]\".",
        "0", false)
        {}

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

class ZRotation : public Property
{
    public:
        ZRotation() : Property(
        "ZRotation",
        "Property to get/set the window's z axis rotation factor.  Value is "
        "\"[float]\".",
        "0", false)
        {}

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

class NonClient : public Property
{
public:
    NonClient() : Property(
        "NonClient",
        "Property to get/set the 'non-client' setting for the Window.  "
        "Value is either \"True\" or \"False\".",
        "False")
    {}

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

class TextParsingEnabled : public Property
{
public:
    TextParsingEnabled() : Property(
        "TextParsingEnabled",
        "Property to get/set the text parsing setting for the Window.  "
        "Value is either \"True\" or \"False\".",
        "True")
    {}

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

class Margin : public Property
{
public:
    Margin() : Property(
        "Margin",
                "Property to get/set margin for the Window. Value format:"
        "{top:{[tops],[topo]},left:{[lefts],[lefto]},bottom:{[bottoms],[bottomo]},right:{[rights],[righto]}}.",
        "{top:{0,0},left:{0,0},bottom:{0,0},right:{0,0}}")
    {}

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

class UpdateMode : public Property
{
    public:
        UpdateMode() : Property(
        "UpdateMode",
        "Property to get/set the window update mode setting.  "
        "Value is one of \"Always\", \"Never\" or \"Visible\".",
        "Visible")
        {}

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

class MouseInputPropagationEnabled : public Property
{
public:
    MouseInputPropagationEnabled() : Property(
        "MouseInputPropagationEnabled",
        "Property to get/set whether unhandled mouse inputs should be "
        "propagated back to the Window's parent.  "
        "Value is either \"True\" or \"False\".",
        "False")
    {}

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

} // End of  WindowProperties namespace section


} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIWindowProperties_h_