WidgetLookManager.h

/***********************************************************************
    created:    Mon Jun 13 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 _CEGUIFalWidgetLookManager_h_
#define _CEGUIFalWidgetLookManager_h_

#include "../Singleton.h"
#include "../String.h"
#include "../Exceptions.h"
#include "./WidgetLookFeel.h"
#include <map>

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

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT WidgetLookManager :
        public Singleton<WidgetLookManager>,
        public AllocatedObject<WidgetLookManager>
    {
    public:
        WidgetLookManager();

        ~WidgetLookManager();

              static    WidgetLookManager&      getSingleton(void);


              static    WidgetLookManager*      getSingletonPtr(void);


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

        typedef std::map<String, WidgetLookFeel*, StringFastLessCompare CEGUI_MAP_ALLOC(String, WidgetLookFeel*)> WidgetLookPointerMap;

        void parseLookNFeelSpecificationFromContainer(const RawDataContainer& source);
        
        void parseLookNFeelSpecificationFromFile(const String& filename, const String& resourceGroup = "");
        
        void parseLookNFeelSpecificationFromString(const String& source);

        bool isWidgetLookAvailable(const String& widget) const;


        const WidgetLookFeel& getWidgetLook(const String& widget) const;


        void eraseWidgetLook(const String& widget);

        void eraseAllWidgetLooks();

        void addWidgetLook(const WidgetLookFeel& look);


        void writeWidgetLookToStream(const String& widgetLookName, OutStream& out_stream) const;

        String getWidgetLookAsString(const String& widgetLookName) const;
 
        String getWidgetLookSetAsString(const WidgetLookNameSet& widgetLookNameSet) const;

        void writeWidgetLookSeriesToStream(const String& prefix, OutStream& out_stream) const;

        void writeWidgetLookSetToStream(const WidgetLookNameSet& widgetLookNameSet, OutStream& out_stream) const;

        static const String& getDefaultResourceGroup()
            { return d_defaultResourceGroup; }

        static void setDefaultResourceGroup(const String& resourceGroup)
            { d_defaultResourceGroup = resourceGroup; }

        WidgetLookPointerMap getWidgetLookPointerMap();

    private:
        static const String FalagardSchemaName; 
        static String d_defaultResourceGroup;


        // \deprecated  Will use the correct allocator in the next version and will
        // be renamed to "WidgetLookMap"
        typedef std::map<String, WidgetLookFeel, StringFastLessCompare> WidgetLookList;

        WidgetLookList  d_widgetLooks;  

    public:
        typedef ConstMapIterator<WidgetLookList> WidgetLookIterator;
        WidgetLookIterator getWidgetLookIterator() const;
    };

} // End of  CEGUI namespace section


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

#endif  // end of guard _CEGUIFalWidgetLookManager_h_