CEGUIWindowManager.h

/***********************************************************************
        filename:       CEGUIWindowManager.h
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines the interface for the WindowManager object
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIWindowManager_h_
#define _CEGUIWindowManager_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUISingleton.h"
#include "CEGUILogger.h"
#include "CEGUIIteratorBase.h"
#include "CEGUIEventSet.h"
#include <map>
#include <vector>

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


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT WindowManager : public Singleton <WindowManager>,
                                  public EventSet
{
public:
    /*************************************************************************
        Public static data
    *************************************************************************/
    static const String GeneratedWindowNameBase;      

    static const String EventNamespace;
    static const String EventWindowCreated;
    static const String EventWindowDestroyed;

        typedef bool PropertyCallback(Window* window, String& propname, String& propvalue, void* userdata);
        
        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        WindowManager(void);


        ~WindowManager(void);


        /*************************************************************************
                Window Related Methods
        *************************************************************************/
        Window* createWindow(const String& type, const String& name = "");


        void    destroyWindow(Window* window);


        void    destroyWindow(const String& window);


        Window* getWindow(const String& name) const;


        bool    isWindowPresent(const String& name) const;


        void    destroyAllWindows(void);


        Window* loadWindowLayout(const String& filename, const String& name_prefix = "", const String& resourceGroup = "", PropertyCallback* callback = 0, void* userdata = 0);

    bool isDeadPoolEmpty(void) const;

    void cleanDeadPool(void);

    void writeWindowLayoutToStream(const Window& window, OutStream& out_stream, bool writeParent = false) const;

    void writeWindowLayoutToStream(const String& window, OutStream& out_stream, bool writeParent = false) const;

    void saveWindowLayout(const String& window, const String& filename, const bool writeParent = false) const;

    void saveWindowLayout(const Window& window, const String& filename, const bool writeParent = false) const;

    void renameWindow(const String& window, const String& new_name);

    void renameWindow(Window* window, const String& new_name);

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

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

    void lock();

    void unlock();

    bool isLocked() const;

private:
    /*************************************************************************
        Implementation Methods
    *************************************************************************/
    String generateUniqueWindowName();

    void initialiseRenderEffect(Window* wnd, const String& effect) const;

        /*************************************************************************
                Implementation Constants
        *************************************************************************/
        static const char       GUILayoutSchemaName[];                  


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        typedef std::map<String, Window*, String::FastLessCompare>                      WindowRegistry;                         
    typedef std::vector<Window*>    WindowVector;   

        WindowRegistry                  d_windowRegistry;                       
    WindowVector    d_deathrow;     

    unsigned long   d_uid_counter;  
    static String d_defaultResourceGroup;   

    uint    d_lockCount;

public:
        /*************************************************************************
                Iterator stuff
        *************************************************************************/
        typedef ConstBaseIterator<WindowRegistry>       WindowIterator;

        WindowIterator  getIterator(void) const;

    void DEBUG_dumpWindowNames(String zone);    
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIWindowManager_h_