PropertySet.h

/***********************************************************************
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines interface for the PropertySet 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 _CEGUIPropertySet_h_
#define _CEGUIPropertySet_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/IteratorBase.h"
#include "CEGUI/Property.h"
#include "CEGUI/PropertyHelper.h"
#include "CEGUI/TypedProperty.h"
// not needed in this header but you are likely to use it if you include this,
// we also define the CEGUI_DEFINE_PROPERTY macro that relies on this here
#include "CEGUI/TplWindowProperty.h"
#include "CEGUI/Exceptions.h"
#include <map>

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT PropertySet : public PropertyReceiver
{
public:
    PropertySet(void) {}


    virtual ~PropertySet(void) {}


    void addProperty(Property* property);


    void removeProperty(const String& name);


    Property* getPropertyInstance(const String& name) const;


    void clearProperties(void);


    bool isPropertyPresent(const String& name) const;


    const String& getPropertyHelp(const String& name) const;


    String getProperty(const String& name) const;

    template<typename T>
    typename PropertyHelper<T>::return_type getProperty(const String& name) const
    {
        PropertyRegistry::const_iterator pos = d_properties.find(name);

        if (pos == d_properties.end())
        {
            CEGUI_THROW(UnknownObjectException("There is no Property named '" + name + "' available in the set."));
        }

        Property* baseProperty = pos->second;
        TypedProperty<T>* typedProperty = dynamic_cast<TypedProperty<T>* >(baseProperty);

        if (typedProperty)
        {
            // yay, we can get native!
            return typedProperty->getNative(this);
        }
        else
        {
            // fall back to string get
            return PropertyHelper<T>::fromString(baseProperty->get(this));
        }
    }

    void setProperty(const String& name, const String& value);

    template<typename T>
    void    setProperty(const String& name, typename PropertyHelper<T>::pass_type value)
    {
        PropertyRegistry::iterator pos = d_properties.find(name);

        if (pos == d_properties.end())
        {
            CEGUI_THROW(UnknownObjectException("There is no Property named '" + name + "' available in the set."));
        }

        Property* baseProperty = pos->second;
        TypedProperty<T>* typedProperty = dynamic_cast<TypedProperty<T>* >(baseProperty);

        if (typedProperty)
        {
            // yay, we can set native!
            typedProperty->setNative(this, value);
        }
        else
        {
            // fall back to string set
            baseProperty->set(this, PropertyHelper<T>::toString(value));
        }
    }

    bool isPropertyDefault(const String& name) const;


    String getPropertyDefault(const String& name) const;

private:
    typedef std::map<String, Property*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, Property*)> PropertyRegistry;
    PropertyRegistry    d_properties;


public:
    /*************************************************************************
                Iterator stuff
        *************************************************************************/
    typedef     ConstMapIterator<PropertyRegistry> PropertyIterator;

    PropertyIterator getPropertyIterator(void) const;
};

#define CEGUI_DEFINE_PROPERTY(class_type, property_native_type, name, help, setter, getter, default_value)\
{\
    static ::CEGUI::TplWindowProperty<class_type, property_native_type> sProperty(\
            name, help, propertyOrigin, setter, getter, default_value);\
    \
    this->addProperty(&sProperty);\
}

#define CEGUI_DEFINE_PROPERTY_NO_XML(class_type, property_native_type, name, help, setter, getter, default_value)\
{\
    static ::CEGUI::TplWindowProperty<class_type, property_native_type> sProperty(\
            name, help, propertyOrigin, setter, getter, default_value, false);\
    \
    this->addProperty(&sProperty);\
}

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIPropertySet_h_