CEGUIEditboxProperties.h

/***********************************************************************
        filename:       CEGUIEditboxProperties.h
        created:        9/7/2004
        author:         Paul D Turner
        
        purpose:        Interface to Properties for Editbox class
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIEditboxProperties_h_
#define _CEGUIEditboxProperties_h_

#include "../CEGUIProperty.h"


// Start of CEGUI namespace section
namespace CEGUI
{

// Start of EditboxProperties namespace section
namespace EditboxProperties
{
class ReadOnly : public Property
{
public:
        ReadOnly() : Property(
                "ReadOnly",
                "Property to get/set the read-only setting for the Editbox.  Value is either \"True\" or \"False\".",
                "False")
        {}

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


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

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


class MaskCodepoint : public Property
{
public:
        MaskCodepoint() : Property(
                "MaskCodepoint",
                "Property to get/set the utf32 codepoint value used for masking text.  Value is \"[uint]\".",
                "42")
        {}

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


class ValidationString : public Property
{
public:
        ValidationString() : Property(
                "ValidationString",
                "Property to get/set the validation string Editbox.  Value is a text string.",
                ".*")
        {}

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


class CaratIndex : public Property
{
public:
        CaratIndex() : Property(
                "CaratIndex",
                "Property to get/set the current carat index.  Value is \"[uint]\".",
                "0")
        {}

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


class SelectionStart : public Property
{
public:
        SelectionStart() : Property(
                "SelectionStart",
                "Property to get/set the zero based index of the selection start position within the text.  Value is \"[uint]\".",
                "0")
        {}

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


class SelectionLength : public Property
{
public:
        SelectionLength() : Property(
                "SelectionLength",
                "Property to get/set the length of the selection (as a count of the number of code points selected).  Value is \"[uint]\".",
                "0")
        {}

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


class MaxTextLength : public Property
{
public:
        MaxTextLength() : Property(
                "MaxTextLength",
                "Property to get/set the the maximum allowed text length (as a count of code points).  Value is \"[uint]\".",
                "1073741824")
        {}

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


class NormalTextColour : public Property
{
public:
        NormalTextColour() : Property(
                "NormalTextColour",
                "Property to get/set the normal, unselected, text colour used for rendering text.  Value is \"aarrggbb\" (hex).",
                "FFFFFFFF")
        {}

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


class SelectedTextColour : public Property
{
public:
        SelectedTextColour() : Property(
                "SelectedTextColour",
                "Property to get/set the colour used for rendering text within the selection area.  Value is \"aarrggbb\" (hex).",
                "FF000000")
        {}

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


class ActiveSelectionColour : public Property
{
public:
        ActiveSelectionColour() : Property(
                "ActiveSelectionColour",
                "Property to get/set the colour used for rendering the selection highlight when the edit box is active.  Value is \"aarrggbb\" (hex).",
                "FF6060FF")
        {}

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


class InactiveSelectionColour : public Property
{
public:
        InactiveSelectionColour() : Property(
                "InactiveSelectionColour",
                "Property to get/set the colour used for rendering the selection highlight when the edit box is inactive.  Value is \"aarrggbb\" (hex).",
                "FF808080")
        {}

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

} // End of  EditboxProperties namespace section

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIEditboxProperties_h_