Crazy Eddies GUI System  0.7.6
CEGUIFalPropertyLinkDefinition.h
00001 /***********************************************************************
00002     filename:   CEGUIFalPropertyLinkDefinition.h
00003     created:    Sat Oct 8 2005
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIFalPropertyLinkDefinition_h_
00029 #define _CEGUIFalPropertyLinkDefinition_h_
00030 
00031 #include "CEGUIFalPropertyDefinitionBase.h"
00032 #include <vector>
00033 
00034 #if defined (_MSC_VER)
00035 #       pragma warning(push)
00036 #       pragma warning(disable : 4251)
00037 #endif
00038 
00039 // Start of CEGUI namespace section
00040 namespace CEGUI
00041 {
00047     class CEGUIEXPORT PropertyLinkDefinition : public PropertyDefinitionBase
00048     {
00049     public:
00050         PropertyLinkDefinition(const String& propertyName, const String& widgetNameSuffix, const String& targetProperty, const String& initialValue, bool redrawOnWrite, bool layoutOnWrite);
00051 
00053         void addLinkTarget(const String& widget, const String& property);
00055         void clearLinkTargets();
00056 
00057         // override members from PropertyDefinitionBase
00058         String get(const PropertyReceiver* receiver) const;
00059         void set(PropertyReceiver* receiver, const String& value);
00060 
00061     protected:
00062         void writeXMLElementType(XMLSerializer& xml_stream) const;
00063         void writeXMLAttributes(XMLSerializer& xml_stream) const;
00064 
00077         const Window* getTargetWindow(const PropertyReceiver* receiver) const;
00078 
00084         Window* getTargetWindow(PropertyReceiver* receiver);
00085 
00087         const Window* getTargetWindow(const PropertyReceiver* receiver,
00088                                       const String& name_suffix) const;
00089 
00091         Window* getTargetWindow(PropertyReceiver* receiver,
00092                                 const String& name_suffix);
00093 
00095         struct LinkTarget
00096         {
00098             String d_widgetNameSuffix;
00100             String d_targetProperty;
00101         };
00102 
00104         typedef std::vector<LinkTarget> LinkTargetCollection;
00105 
00107         LinkTargetCollection d_targets;
00108     };
00109 
00110 } // End of  CEGUI namespace section
00111 
00112 #if defined (_MSC_VER)
00113 #       pragma warning(pop)
00114 #endif
00115 
00116 #endif  // end of guard _CEGUIFalPropertyLinkDefinition_h_