CEGUIPropertySet.h

/***********************************************************************
        filename:       CEGUIPropertySet.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 "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIIteratorBase.h"
#include "CEGUIProperty.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);


        void    clearProperties(void);


        bool    isPropertyPresent(const String& name) const;


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


        String  getProperty(const String& name) const;


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


        bool    isPropertyDefault(const String& name) const;


        String  getPropertyDefault(const String& name) const;

private:
        typedef std::map<String, Property*, String::FastLessCompare>    PropertyRegistry;
        PropertyRegistry        d_properties;


public:
        /*************************************************************************
                Iterator stuff
        *************************************************************************/
    typedef     ConstBaseIterator<PropertyRegistry> Iterator;

    Iterator getIterator(void) const;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIPropertySet_h_