MyGUI_Gui.h

Go to the documentation of this file.

/*
 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
 * Distributed under the MIT License
 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
 */

#ifndef __MYGUI_GUI_H__
#define __MYGUI_GUI_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_Types.h"
#include "MyGUI_Singleton.h"
#include "MyGUI_XmlDocument.h"
#include "MyGUI_IUnlinkWidget.h"
#include "MyGUI_Widget.h"
#include "MyGUI_BackwardCompatibility.h"

namespace MyGUI
{

    typedef delegates::CMultiDelegate1<float> EventHandle_FrameEventDelegate;

    class MYGUI_EXPORT Gui :
        public Singleton<Gui>,
        public IUnlinkWidget,
        public MemberObsolete<Gui>
    {
        friend class WidgetManager;

    public:
        Gui();

        void initialise(const std::string& _core = "MyGUI_Core.xml");

#ifndef MYGUI_DONT_USE_OBSOLETE
        MYGUI_OBSOLETE(" is deprecated, use : void Gui::initialise(const std::string& _core) and set log filename in Platform")
        void initialise(const std::string& _core, const std::string& _logFileName);
#endif // MYGUI_DONT_USE_OBSOLETE

        void shutdown();

        // methods for creating widgets
        Widget* createWidgetT(const std::string& _type, const std::string& _skin, const IntCoord& _coord, Align _align, const std::string& _layer, const std::string& _name = "");
        Widget* createWidgetT(const std::string& _type, const std::string& _skin, int _left, int _top, int _width, int _height, Align _align, const std::string& _layer, const std::string& _name = "");
        Widget* createWidgetRealT(const std::string& _type, const std::string& _skin, const FloatCoord& _coord, Align _align, const std::string& _layer, const std::string& _name = "");
        Widget* createWidgetRealT(const std::string& _type, const std::string& _skin, float _left, float _top, float _width, float _height, Align _align, const std::string& _layer, const std::string& _name = "");

        // templates for creating widgets by type
        template <typename T>
        T* createWidget(const std::string& _skin, const IntCoord& _coord, Align _align, const std::string& _layer, const std::string& _name = "")
        {
            return static_cast<T*>(createWidgetT(T::getClassTypeName(), _skin, _coord, _align, _layer, _name));
        }
        template <typename T>
        T* createWidget(const std::string& _skin, int _left, int _top, int _width, int _height, Align _align, const std::string& _layer, const std::string& _name = "")
        {
            return static_cast<T*>(createWidgetT(T::getClassTypeName(), _skin, IntCoord(_left, _top, _width, _height), _align, _layer, _name));
        }
        template <typename T>
        T* createWidgetReal(const std::string& _skin, const FloatCoord& _coord, Align _align, const std::string& _layer, const std::string& _name = "")
        {
            return static_cast<T*>(createWidgetRealT(T::getClassTypeName(), _skin, _coord, _align, _layer, _name));
        }
        template <typename T>
        T* createWidgetReal(const std::string& _skin, float _left, float _top, float _width, float _height, Align _align, const std::string& _layer, const std::string& _name = "")
        {
            return static_cast<T*>(createWidgetRealT(T::getClassTypeName(), _skin, _left, _top, _width, _height, _align, _layer, _name));
        }

        void destroyWidget(Widget* _widget);

        void destroyWidgets(const VectorWidgetPtr& _widgets);

        void destroyWidgets(EnumeratorWidgetPtr& _widgets);

        Widget* findWidgetT(const std::string& _name, bool _throw = true);

        Widget* findWidgetT(const std::string& _name, const std::string& _prefix, bool _throw = true);

        template <typename T>
        T* findWidget(const std::string& _name, bool _throw = true)
        {
            Widget* widget = findWidgetT(_name, _throw);
            if (nullptr == widget) return nullptr;
            return widget->castType<T>(_throw);
        }

        template <typename T>
        T* findWidget(const std::string& _name, const std::string& _prefix, bool _throw = true)
        {
            return findWidget<T>(_prefix + _name, _throw);
        }

        void destroyChildWidget(Widget* _widget);

        void destroyAllChildWidget();

        EnumeratorWidgetPtr getEnumerator() const;

        void frameEvent(float _time);

        /*events:*/
        EventHandle_FrameEventDelegate eventFrameStart;

        /*internal:*/
        void _linkChildWidget(Widget* _widget);
        void _unlinkChildWidget(Widget* _widget);

    private:
        // создает виджет
        Widget* baseCreateWidget(WidgetStyle _style, const std::string& _type, const std::string& _skin, const IntCoord& _coord, Align _align, const std::string& _layer, const std::string& _name);

        // удяляет неудачника
        void _destroyChildWidget(Widget* _widget);

        // удаляет всех детей
        void _destroyAllChildWidget();

        virtual void _unlinkWidget(Widget* _widget);

    private:
        // вектор всех детей виджетов
        VectorWidgetPtr mWidgetChild;

        // синглтоны гуя
        InputManager* mInputManager;
        SubWidgetManager* mSubWidgetManager;
        LayerManager* mLayerManager;
        SkinManager* mSkinManager;
        WidgetManager* mWidgetManager;
        FontManager* mFontManager;
        ControllerManager* mControllerManager;
        PointerManager* mPointerManager;
        ClipboardManager* mClipboardManager;
        LayoutManager* mLayoutManager;
        DynLibManager* mDynLibManager;
        PluginManager* mPluginManager;
        LanguageManager* mLanguageManager;
        ResourceManager* mResourceManager;
        FactoryManager* mFactoryManager;
        ToolTipManager* mToolTipManager;

        bool mIsInitialise;
    };

} // namespace MyGUI

#endif // __MYGUI_GUI_H__