GUILayout_xmlHandler.h

/***********************************************************************
        created:        5/7/2004
        author:         Paul D Turner
        
        purpose:        Interface to XML parser for GUILayout files
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIGUILayout_xmlHandler_h_
#define _CEGUIGUILayout_xmlHandler_h_

#include "CEGUI/WindowManager.h"
#include "CEGUI/Window.h"
#include "CEGUI/XMLHandler.h"

#include <vector>

// Start of CEGUI namespace section
namespace CEGUI
{
class GUILayout_xmlHandler : public XMLHandler
{
        typedef WindowManager::PropertyCallback PropertyCallback;
public:
    static const String NativeVersion;                  
    
        /*************************************************************************
                Construction & Destruction
        *************************************************************************/
        GUILayout_xmlHandler(PropertyCallback* callback = 0, void* userdata = 0) :
          d_root(0),
          d_propertyCallback(callback),
          d_userData(userdata)
        {}

        virtual ~GUILayout_xmlHandler(void) {}

    virtual const String& getSchemaName() const;
    virtual const String& getDefaultResourceGroup() const;

        /*************************************************************************
                SAX2 Handler overrides
        *************************************************************************/ 
    virtual void elementStart(const String& element, const XMLAttributes& attributes);
    virtual void elementEnd(const String& element);
    virtual void text(const String& text);

        /*************************************************************************
                Functions used by our implementation
        *************************************************************************/
        void    cleanupLoadedWindows(void);


        Window* getLayoutRootWindow(void) const;
    
        static const String GUILayoutElement;                           
        static const String LayoutImportElement;                        
        static const String EventElement;                                       
        static const String LayoutImportFilenameAttribute;
    static const String LayoutImportResourceGroupAttribute; 
        static const String EventNameAttribute;                 
        static const String EventFunctionAttribute;             
    static const String GUILayoutVersionAttribute;  

private:
    void elementGUILayoutStart(const XMLAttributes& attributes);

    void elementWindowStart(const XMLAttributes& attributes);

    void elementAutoWindowStart(const XMLAttributes& attributes);

    void elementUserStringStart(const XMLAttributes& attributes);

    void elementPropertyStart(const XMLAttributes& attributes);

    void elementLayoutImportStart(const XMLAttributes& attributes);

    void elementEventStart(const XMLAttributes& attributes);

    void elementWindowEnd();

    void elementAutoWindowEnd();

    void elementUserStringEnd();

    void elementPropertyEnd();

    void operator=(const GUILayout_xmlHandler&) {}

    /*************************************************************************
                Implementation Data
        *************************************************************************/
    typedef std::pair<Window*, bool> WindowStackEntry; 
        typedef std::vector<WindowStackEntry
        CEGUI_VECTOR_ALLOC(WindowStackEntry)> WindowStack;
        Window* d_root;                         
        WindowStack     d_stack;                
        PropertyCallback*       d_propertyCallback; 
        void*                           d_userData;                     
    String d_stringItemName; 
    String d_stringItemValue; 
};


} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIGUILayout_xmlHandler_h_