WidgetLookFeel.h

/***********************************************************************
    created:    Mon Jun 13 2005
    author:     Paul D Turner <paul@cegui.org.uk>
                edited by Lukas E Meindl in Jul 2014
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIFalWidgetLookFeel_h_
#define _CEGUIFalWidgetLookFeel_h_

#include "./StateImagery.h"
#include "./WidgetComponent.h"
#include "./ImagerySection.h"
#include "./PropertyInitialiser.h"
#include "./PropertyDefinition.h"
#include "./PropertyLinkDefinition.h"
#include "./EventLinkDefinition.h"
#include "./NamedArea.h"
#include "./NamedDefinitionCollator.h"
#include <map>

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


namespace CEGUI
{
class CEGUIEXPORT WidgetLookFeel :
    public AllocatedObject<WidgetLookFeel>
{
public:
    WidgetLookFeel(const String& name, const String& inherits);
    WidgetLookFeel() {}
    WidgetLookFeel(const WidgetLookFeel& other);
    WidgetLookFeel& operator=(const WidgetLookFeel& other);

    virtual ~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 renameImagerySection(const String& oldName, const String& newName);

    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;

    void renameNamedArea(const String& oldName, const String& newName);

    bool isNamedAreaDefined(const String& name) const;

    void layoutChildWidgets(const Window& owner) const;

    void addPropertyDefinition(PropertyDefinitionBase* propdef);

    void addPropertyLinkDefinition(PropertyDefinitionBase* propdef);

    void clearPropertyDefinitions();

    void clearPropertyLinkDefinitions();

    void addAnimationName(const String& anim_name);

    void addEventLinkDefinition(const EventLinkDefinition& evtdef); 

    void clearEventLinkDefinitions();

    void writeXMLToStream(XMLSerializer& xml_stream) const;

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

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


    WidgetComponent* retrieveWidgetComponentFromList(const String& name, bool includeInheritedElements = false);

    PropertyInitialiser* retrievePropertyInitialiserFromList(const String& name, bool includeInheritedElements = false);

    PropertyDefinitionBase* retrievePropertyDefinitionFromList(const String& name, bool includeInheritedElements = false);

    PropertyDefinitionBase* retrievePropertyLinkDefinitionFromList(const String& name, bool includeInheritedElements = false);

    EventLinkDefinition* retrieveEventLinkDefinitionFromList(const String& name, bool includeInheritedElements = false);
    

    typedef std::set<String, StringFastLessCompare
        CEGUI_SET_ALLOC(String)> StringSet;

    typedef std::map<String, StateImagery*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, StateImagery*)> StateImageryPointerMap;
    typedef std::map<String, ImagerySection*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, ImagerySection*)> ImagerySectionPointerMap;
    typedef std::map<String, NamedArea*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, NamedArea*)> NamedAreaPointerMap;
    typedef std::map<String, WidgetComponent*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, WidgetComponent*)> WidgetComponentPointerMap;
    typedef std::map<String, AnimationInstance*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, AnimationInstance*)> AnimationInstancePointerMap;
    typedef std::map<String, EventLinkDefinition*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, EventLinkDefinition*)> EventLinkDefinitionPointerMap;

    typedef std::map<String, PropertyInitialiser*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, PropertyInitialiser*)> PropertyInitialiserPointerMap;
    typedef std::map<String, PropertyDefinitionBase*, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, PropertyDefinitionBase*)> PropertyDefinitionBasePointerMap;



    typedef std::vector<PropertyInitialiser
        CEGUI_VECTOR_ALLOC(PropertyInitialiser)> PropertyList;
    typedef std::vector<PropertyDefinitionBase*
        CEGUI_VECTOR_ALLOC(PropertyDefinitionBase*)> PropertyDefinitionList;
    typedef std::vector<PropertyDefinitionBase*
        CEGUI_VECTOR_ALLOC(PropertyDefinitionBase*)> PropertyLinkDefinitionList;



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

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

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

    bool handleFontRenderSizeChange(Window& window, const Font* font) const;



    StateImageryPointerMap getStateImageryMap(bool includeInheritedElements = false);
    
    ImagerySectionPointerMap getImagerySectionMap(bool includeInheritedElements = false);

    NamedAreaPointerMap getNamedAreaMap(bool includeInheritedElements = false);

    WidgetComponentPointerMap getWidgetComponentMap(bool includeInheritedElements = false);
  
    PropertyInitialiserPointerMap getPropertyInitialiserMap(bool includeInheritedElements = false);

    PropertyDefinitionBasePointerMap getPropertyDefinitionMap(bool includeInheritedElements = false);

    PropertyDefinitionBasePointerMap getPropertyLinkDefinitionMap(bool includeInheritedElements = false);

    EventLinkDefinitionPointerMap getEventLinkDefinitionMap(bool includeInheritedElements = false);

    const CEGUI::String& getInheritedWidgetLookName() const;

    StringSet getStateImageryNames(bool inherits = false) const;
    StringSet getStateNames(bool inherits = false) const;
    StringSet getImagerySectionNames(bool inherits = false) const;
    StringSet getImageryNames(bool inherits = false) const;
    StringSet getNamedAreaNames(bool inherits = false) const;
    StringSet getWidgetComponentNames(bool inherits = false) const;
    StringSet getWidgetNames(bool inherits = false) const;
    StringSet getPropertyInitialiserNames(bool inherits = false) const;
    StringSet getPropertyDefinitionNames(bool inherits = false) const;
    StringSet getPropertyLinkDefinitionNames(bool inherits = false) const;
    StringSet getEventLinkDefinitionNames(bool inherits = false) const;
    StringSet getAnimationNames(bool inherits = false) const;

private:

    WidgetLookFeel* getInheritedWidgetLookFeel();


    typedef std::map<String, StateImagery, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, StateImagery)> StateList;
    typedef std::map<String, ImagerySection, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, ImagerySection)> ImageryList;
    typedef std::map<String, NamedArea, StringFastLessCompare
        CEGUI_MAP_ALLOC(String, NamedArea)> NamedAreaList;

    typedef std::vector<WidgetComponent
        CEGUI_VECTOR_ALLOC(WidgetComponent)> WidgetList;

    typedef std::vector<String
        CEGUI_VECTOR_ALLOC(String)> AnimationList;
    typedef std::multimap<Window*, AnimationInstance*
        /*CEGUI_MULTIMAP_ALLOC(Window*, AnimationInstance*)*/> AnimationInstanceMap;

    typedef std::vector<EventLinkDefinition
        CEGUI_VECTOR_ALLOC(EventLinkDefinition)> EventLinkDefinitionList;

    CEGUI::String d_lookName;
    CEGUI::String d_inheritedLookName;
    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;
    EventLinkDefinitionList d_eventLinkDefinitions;

    // these are container types used when composing final collections of
    // objects that come via inheritence.
    typedef NamedDefinitionCollator<String, const WidgetComponent*> WidgetComponentCollator;
    typedef NamedDefinitionCollator<String, PropertyDefinitionBase*> PropertyDefinitionCollator;
    typedef NamedDefinitionCollator<String, PropertyDefinitionBase*> PropertyLinkDefinitionCollator;
    typedef NamedDefinitionCollator<String, const PropertyInitialiser*> PropertyInitialiserCollator;
    typedef NamedDefinitionCollator<String, const EventLinkDefinition*> EventLinkDefinitionCollator;
    typedef std::set<String, StringFastLessCompare
        CEGUI_SET_ALLOC(String)> AnimationNameSet;

    // functions to populate containers with collections of objects that we
    // gain through inheritence.
    void appendChildWidgetComponents(WidgetComponentCollator& col, bool inherits = true) const;
    void appendPropertyDefinitions(PropertyDefinitionCollator& col, bool inherits = true) const;
    void appendPropertyLinkDefinitions(PropertyLinkDefinitionCollator& col, bool inherits = true) const;
    void appendPropertyInitialisers(PropertyInitialiserCollator& col, bool inherits = true) const;
    void appendEventLinkDefinitions(EventLinkDefinitionCollator& col, bool inherits = true) const;
    void appendAnimationNames(AnimationNameSet& set, bool inherits = true) const;

    void swap(WidgetLookFeel& other);

public:
    /*************************************************************************
        Iterator stuff
    *************************************************************************/

    typedef ConstMapIterator<StateList> StateIterator;
    typedef ConstMapIterator<ImageryList> ImageryIterator;
    typedef ConstMapIterator<NamedAreaList> NamedAreaIterator;

    typedef ConstVectorIterator<WidgetComponentCollator> WidgetComponentIterator;
    typedef ConstVectorIterator<PropertyDefinitionCollator> PropertyDefinitionIterator;
    typedef ConstVectorIterator<PropertyLinkDefinitionCollator> PropertyLinkDefinitionIterator;
    typedef ConstVectorIterator<PropertyInitialiserCollator> PropertyInitialiserIterator;
    typedef ConstVectorIterator<EventLinkDefinitionCollator> EventLinkDefinitionIterator;
    typedef ConstVectorIterator<AnimationNameSet> AnimationNameIterator;

    StateIterator getStateIterator(bool inherits = false) const;
    ImageryIterator getImageryIterator(bool inherits = false) const;

    NamedAreaIterator getNamedAreaIterator(bool inherits = false) const;

    WidgetComponentIterator getWidgetComponentIterator(bool inherits = false) const;

    PropertyDefinitionIterator getPropertyDefinitionIterator(bool inherits = false) const;

    PropertyLinkDefinitionIterator getPropertyLinkDefinitionIterator(bool inherits = false) const;

    PropertyInitialiserIterator getPropertyInitialiserIterator(bool inherits = false) const;

    EventLinkDefinitionIterator getEventLinkDefinitionIterator(bool inherits = false) const;

    AnimationNameIterator getAnimationNameIterator(bool inherits = false) const;
};

}


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

#endif