Gui.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 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_HPP
#define TGUI_GUI_HPP
 
 
#include <TGUI/Container.hpp>
#include <SFML/Graphics/RenderWindow.hpp>
#include <queue>
 
 
namespace tgui
{
    class TGUI_API Gui
    {
      public:
 
        Gui();
 
#if SFML_VERSION_MAJOR == 2 && SFML_VERSION_MINOR < 5
        Gui(sf::RenderWindow& window);
#endif
 
        Gui(sf::RenderTarget& target);
 
 
        // Deleted copy constructor
        Gui(const Gui& copy) = delete;
 
 
        // Deleted assignment operator overload
        Gui& operator=(const Gui& right) = delete;
 
#if SFML_VERSION_MAJOR == 2 && SFML_VERSION_MINOR < 5
        void setTarget(sf::RenderWindow& window);
#endif
 
        void setTarget(sf::RenderTarget& target);
 
 
        sf::RenderTarget* getTarget() const;
 
 
        void setView(const sf::View& view);
 
 
        const sf::View& getView() const;
 
 
        bool handleEvent(sf::Event event);
 
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use setTabKeyUsageEnabled instead") void enableTabKeyUsage();
 
 
        TGUI_DEPRECATED("Use setTabKeyUsageEnabled instead") void disableTabKeyUsage();
#endif
 
        void setTabKeyUsageEnabled(bool enabled);
 
 
        bool isTabKeyUsageEnabled() const;
 
 
        void draw();
 
 
        GuiContainer::Ptr getContainer() const;
 
 
        void setFont(const Font& font);
 
 
        std::shared_ptr<sf::Font> getFont() const;
 
 
        const std::vector<Widget::Ptr>& getWidgets() const;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use getWidgets() and Widget::getWidgetName instead") const std::vector<sf::String> getWidgetNames() const;
#endif
 
        void add(const Widget::Ptr& widgetPtr, const sf::String& widgetName = "");
 
 
        Widget::Ptr get(const sf::String& widgetName) const;
 
 
        template <class T>
        typename T::Ptr get(const sf::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(sf::Vector2f pos) const;
 
 
        Widget::Ptr getWidgetBelowMouseCursor(sf::Vector2i mousePos) const;
 
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use Widget::setWidgetName instead") bool setWidgetName(const Widget::Ptr& widget, const std::string& name);
 
 
        TGUI_DEPRECATED("Use Widget::getWidgetName instead") std::string getWidgetName(const Widget::Ptr& widget) const;
#endif
 
        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);
 
 
        void uncheckRadioButtons();
 
 
        void setOpacity(float opacity);
 
 
        float getOpacity() const;
 
 
        void setTextSize(unsigned int size);
 
 
        unsigned int getTextSize() const;
 
 
        void loadWidgetsFromFile(const std::string& filename, bool replaceExisting = true);
 
 
        void saveWidgetsToFile(const std::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 setDrawingUpdatesTime(bool drawUpdatesTime);
 
 
        bool updateTime();
 
 
        // Updates the internal clock to make animation possible. This function is called automatically by the draw function.
        // You will thus only need to call it yourself when you are drawing everything manually.
        bool updateTime(const sf::Time& elapsedTime);
 
 
      private:
 
        // Code that has to be run in each constructor
        void init();
 
 
      protected:
 
        // The internal clock which is used for animation of widgets
        sf::Clock m_clock;
 
        // The sfml render target to draw on
        sf::RenderTarget* m_target;
        bool m_windowFocused = true;
 
    #if SFML_VERSION_MAJOR == 2 && SFML_VERSION_MINOR < 5
        // Does m_target contains a sf::RenderWindow?
        bool m_accessToWindow;
    #endif
 
        // Internal container to store all widgets
        GuiContainer::Ptr m_container = std::make_shared<GuiContainer>();
 
        Widget::Ptr m_visibleToolTip = nullptr;
        sf::Time m_tooltipTime;
        bool m_tooltipPossible = false;
        Vector2f m_lastMousePos;
 
        sf::View m_view{{0, 0, 1, 1}};
 
        bool m_drawUpdatesTime = true;
        bool m_TabKeyUsageEnabled = true;
 
 
    };
 
 
}
 
 
#endif // TGUI_GUI_HPP