CEGUIFalPropertyLinkDefinition.h

/***********************************************************************
    filename:   CEGUIFalPropertyLinkDefinition.h
    created:    Sat Oct 8 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 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 _CEGUIFalPropertyLinkDefinition_h_
#define _CEGUIFalPropertyLinkDefinition_h_

#include "CEGUIFalPropertyDefinitionBase.h"
#include <vector>

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

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT PropertyLinkDefinition : public PropertyDefinitionBase
    {
    public:
        PropertyLinkDefinition(const String& propertyName, const String& widgetNameSuffix, const String& targetProperty, const String& initialValue, bool redrawOnWrite, bool layoutOnWrite);

        void addLinkTarget(const String& widget, const String& property);
        void clearLinkTargets();

        // override members from PropertyDefinitionBase
        String get(const PropertyReceiver* receiver) const;
        void set(PropertyReceiver* receiver, const String& value);
        // overrides
        void initialisePropertyReceiver(PropertyReceiver* receiver) const;

    protected:
        void writeXMLElementType(XMLSerializer& xml_stream) const;
        void writeXMLAttributes(XMLSerializer& xml_stream) const;

        const Window* getTargetWindow(const PropertyReceiver* receiver) const;

        Window* getTargetWindow(PropertyReceiver* receiver) const;

        const Window* getTargetWindow(const PropertyReceiver* receiver,
                                      const String& name_suffix) const;

        Window* getTargetWindow(PropertyReceiver* receiver,
                                const String& name_suffix) const;

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

        struct LinkTarget
        {
            String d_widgetNameSuffix;
            String d_targetProperty;
        };

        typedef std::vector<LinkTarget> LinkTargetCollection;

        LinkTargetCollection d_targets;
    };

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIFalPropertyLinkDefinition_h_