GuiBase.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2022 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_GUI_BASE_HPP
#define TGUI_GUI_BASE_HPP
 
 
#include <TGUI/Container.hpp>
#include <TGUI/RelFloatRect.hpp>
#include <TGUI/Event.hpp>
#include <TGUI/Cursor.hpp>
#include <chrono>
#include <stack>
 
 
namespace tgui
{
    class TGUI_API GuiBase
    {
    public:
 
        // Default constructor
        GuiBase() = default;
 
        // Deleted copy constructor
        GuiBase(const GuiBase& copy) = delete;
 
        // Deleted assignment operator overload
        GuiBase& operator=(const GuiBase& right) = delete;
 
        // Virtual destructor
        virtual ~GuiBase();
 
 
        void setAbsoluteViewport(const FloatRect& viewport);
 
 
        void setRelativeViewport(const FloatRect& viewport);
 
 
        RelFloatRect getViewport() const;
 
 
        void setAbsoluteView(const FloatRect& view);
 
 
        void setRelativeView(const FloatRect& view);
 
 
        RelFloatRect getView() const;
 
 
        bool handleEvent(Event event);
 
 
        void setTabKeyUsageEnabled(bool enabled);
 
 
        bool isTabKeyUsageEnabled() const;
 
 
        virtual void draw() = 0;
 
 
        RootContainer::Ptr getContainer() const;
 
 
        void setFont(const Font& font);
 
 
        Font getFont() const;
 
 
        const std::vector<Widget::Ptr>& getWidgets() const;
 
 
        void add(const Widget::Ptr& widgetPtr, const String& widgetName = "");
 
 
        Widget::Ptr get(const String& widgetName) const;
 
 
        template <class T>
        typename T::Ptr get(const String& widgetName) const
        {
            return m_container->get<T>(widgetName);
        }
 
 
        bool remove(const Widget::Ptr& widget);
 
 
        void removeAllWidgets();
 
 
        Widget::Ptr getFocusedChild() const;
 
 
        Widget::Ptr getFocusedLeaf() const;
 
 
        Widget::Ptr getWidgetAtPosition(Vector2f pos) const;
 
 
        Widget::Ptr getWidgetBelowMouseCursor(Vector2i mousePos) const;
 
 
        bool focusNextWidget(bool recursive = true);
 
 
        bool focusPreviousWidget(bool recursive = true);
 
 
        void unfocusAllWidgets();
 
 
        void moveWidgetToFront(const Widget::Ptr& widget);
 
 
        void moveWidgetToBack(const Widget::Ptr& widget);
 
 
        std::size_t moveWidgetForward(const Widget::Ptr& widget);
 
 
        std::size_t moveWidgetBackward(const Widget::Ptr& widget);
 
 
        bool setWidgetIndex(const Widget::Ptr& widget, std::size_t index);
 
 
        int getWidgetIndex(const Widget::Ptr& widget) const;
 
 
        void setOpacity(float opacity);
 
 
        float getOpacity() const;
 
 
        void setTextSize(unsigned int size);
 
 
        unsigned int getTextSize() const;
 
 
        void loadWidgetsFromFile(const String& filename, bool replaceExisting = true);
 
 
        void saveWidgetsToFile(const String& filename);
 
 
        void loadWidgetsFromStream(std::stringstream& stream, bool replaceExisting = true);
 
 
        void loadWidgetsFromStream(std::stringstream&& stream, bool replaceExisting = true);
 
 
        void saveWidgetsToStream(std::stringstream& stream) const;
 
 
        void setOverrideMouseCursor(Cursor::Type type);
 
 
        void restoreOverrideMouseCursor();
 
 
        void requestMouseCursor(Cursor::Type type);
 
 
        void setDrawingUpdatesTime(bool drawUpdatesTime);
 
 
        bool updateTime();
 
 
        bool updateTime(Duration elapsedTime);
 
 
        Vector2f mapPixelToView(int x, int y) const;
 
 
        virtual void mainLoop() = 0;
 
 
    protected:
 
        // Function that has to be called when constructing the Gui, but after a backend already exists
        virtual void init();
 
 
        // Updates the view and changes the size of the root container when needed
        virtual void updateContainerSize();
 
 
    public:
 
        SignalFloatRect onViewChange = {"ViewChanged"}; 
 
 
    protected:
 
        std::chrono::steady_clock::time_point m_lastUpdateTime;
        bool m_windowFocused = true;
 
        RootContainer::Ptr m_container = nullptr;
 
        Widget::Ptr m_visibleToolTip = nullptr;
        Duration m_tooltipTime;
        bool m_tooltipPossible = false;
        Vector2f m_toolTipRelativePos;
        Vector2f m_lastMousePos;
 
        RelFloatRect m_viewport{RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}};
        RelFloatRect m_view{RelativeValue{0}, RelativeValue{0}, RelativeValue{1}, RelativeValue{1}};
        FloatRect m_lastView;
 
        bool m_drawUpdatesTime = true;
        bool m_tabKeyUsageEnabled = true;
 
        Cursor::Type m_requestedMouseCursor = Cursor::Type::Arrow;
        std::stack<Cursor::Type> m_overrideMouseCursors;
    };
 
}
 
 
#endif // TGUI_GUI_BASE_HPP