Property.h

/***********************************************************************
        filename:       CEGUIProperty.h
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines the Property class which forms part of a
                                PropertySet
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIProperty_h_
#define _CEGUIProperty_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/XMLSerializer.h" 

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT PropertyReceiver
{
public:
        PropertyReceiver() {}
        virtual ~PropertyReceiver() {}
};


class CEGUIEXPORT Property :
    public AllocatedObject<Property>
{
public:
    static const String XMLElementName;
    static const String NameXMLAttributeName;
    static const String ValueXMLAttributeName;

        Property(const String& name, const String& help, const String& defaultValue = "", bool writesXML = true, const String& dataType = "Unknown", const String& origin = "Unknown") :
          d_name(name),
          d_help(help),
          d_default(defaultValue),
          d_writeXML(writesXML),
      d_dataType(dataType),
      d_origin(origin)
    {}

        virtual ~Property(void) {}


        const String& getHelp(void) const               {return d_help;}


        const String& getName(void) const               {return d_name;}

    const String& getDataType(void) const   {return d_dataType;}

    const String& getOrigin(void) const   {return d_origin;}

        virtual String  get(const PropertyReceiver* receiver) const = 0;


        virtual void    set(PropertyReceiver* receiver, const String& value) = 0;


        virtual bool    isDefault(const PropertyReceiver* receiver) const;


        virtual String  getDefault(const PropertyReceiver* receiver) const;


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

    virtual bool isReadable() const;

    virtual bool isWritable() const;

    virtual bool doesWriteXML() const;

    virtual void initialisePropertyReceiver(PropertyReceiver* /*receiver*/) const {}

    virtual Property* clone() const = 0;

protected:
        String d_name;          
        String d_help;          
        String d_default;       
        bool d_writeXML; 
    // TODO: This is really ugly but PropertyDefinition forced me to do this to support operator=
    String d_dataType; 
    // TODO: This is really ugly but PropertyDefinition forced me to do this to support operator=
    String d_origin; 
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIProperty_h_