CEGUIFalWidgetLookFeel.h

/***********************************************************************
    filename:   CEGUIFalWidgetLookFeel.h
    created:    Mon Jun 13 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIFalWidgetLookFeel_h_
#define _CEGUIFalWidgetLookFeel_h_

#include "CEGUIFalStateImagery.h"
#include "CEGUIFalWidgetComponent.h"
#include "CEGUIFalImagerySection.h"
#include "CEGUIFalPropertyInitialiser.h"
#include "CEGUIFalPropertyDefinition.h"
#include "CEGUIFalPropertyLinkDefinition.h"
#include "CEGUIFalNamedArea.h"
#include <map>

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


// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT WidgetLookFeel
    {
    public:
        WidgetLookFeel(const String& name);
        WidgetLookFeel() {}

        const StateImagery& getStateImagery(const CEGUI::String& state) const;

        const ImagerySection& getImagerySection(const CEGUI::String& section) const;

        const String& getName() const;

        void addImagerySection(const ImagerySection& section);

        void addWidgetComponent(const WidgetComponent& widget);

        void addStateSpecification(const StateImagery& state);

        void addPropertyInitialiser(const PropertyInitialiser& initialiser);

        void clearImagerySections();

        void clearWidgetComponents();

        void clearStateSpecifications();

        void clearPropertyInitialisers();

        void initialiseWidget(Window& widget) const;

        void cleanUpWidget(Window& widget) const;

        bool isStateImageryPresent(const String& state) const;

        void addNamedArea(const NamedArea& area);

        void clearNamedAreas();

        const NamedArea& getNamedArea(const String& name) const;

        bool isNamedAreaDefined(const String& name) const;

        void layoutChildWidgets(const Window& owner) const;

        void addPropertyDefinition(const PropertyDefinition& propdef);

        void addPropertyLinkDefinition(const PropertyLinkDefinition& propdef);

        void clearPropertyDefinitions();

        void clearPropertyLinkDefinitions();

        void addAnimationName(const String& anim_name);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

        void renameChildren(const Window& widget, const String& newBaseName) const;

        const PropertyInitialiser* findPropertyInitialiser(const String& propertyName) const;

        const WidgetComponent* findWidgetComponent(const String& nameSuffix) const;

        typedef std::vector<PropertyInitialiser>  PropertyList;
        typedef std::vector<PropertyDefinition>   PropertyDefinitionList;
        typedef std::vector<PropertyLinkDefinition> PropertyLinkDefinitionList;

        const PropertyDefinitionList& getPropertyDefinitions() const { return d_propertyDefinitions; } 

        const PropertyLinkDefinitionList& getPropertyLinkDefinitions() const { return d_propertyLinkDefinitions; } 

        const PropertyList& getProperties() const { return d_properties; } 

    private:
        typedef std::map<String, StateImagery, String::FastLessCompare>    StateList;
        typedef std::map<String, ImagerySection, String::FastLessCompare>  ImageryList;
        typedef std::map<String, NamedArea, String::FastLessCompare>       NamedAreaList;
        typedef std::vector<WidgetComponent>      WidgetList;
        typedef std::vector<String> AnimationList;
            typedef std::multimap<Window*, AnimationInstance*> AnimationInstanceMap;

        CEGUI::String   d_lookName;         
        ImageryList     d_imagerySections;  
        WidgetList      d_childWidgets;     
        StateList       d_stateImagery;     
        PropertyList    d_properties;       
        NamedAreaList   d_namedAreas;       
        mutable PropertyDefinitionList  d_propertyDefinitions;  
        mutable PropertyLinkDefinitionList d_propertyLinkDefinitions;  

        AnimationList d_animations;
        mutable AnimationInstanceMap d_animationInstances;
    };


} // End of  CEGUI namespace section


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

#endif  // end of guard _CEGUIFalWidgetLookFeel_h_