Container.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_CONTAINER_HPP
#define TGUI_CONTAINER_HPP
 
 
#include <list>
 
#include <TGUI/Widget.hpp>
 
 
namespace tgui
{
    class TGUI_API Container : public Widget
    {
    public:
 
        typedef std::shared_ptr<Container> Ptr; 
        typedef std::shared_ptr<const Container> ConstPtr; 
 
 
        // Default constructor
        Container();
 
 
        Container(const Container& copy);
 
 
        Container(Container&& copy);
 
 
        ~Container();
 
 
        Container& operator= (const Container& right);
 
 
        Container& operator= (Container&& right);
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        const std::vector<Widget::Ptr>& getWidgets() const
        {
            return m_widgets;
        }
 
        template<typename Function>
        void sortWidgets(Function&& function)
        {
            std::sort(m_widgets.begin(), m_widgets.end(), std::forward<Function>(function));
        }
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use getWidgets() and Widget::getWidgetName instead") const std::vector<sf::String> getWidgetNames() const
        {
            std::vector<sf::String> m_widgetNames;
            m_widgetNames.reserve(m_widgets.size());
            for (std::size_t i = 0; i < m_widgets.size(); ++i)
                m_widgetNames.emplace_back(m_widgets[i]->getWidgetName());
 
            return m_widgetNames;
        }
#endif
 
        virtual 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 std::dynamic_pointer_cast<T>(get(widgetName));
        }
 
 
        virtual bool remove(const Widget::Ptr& widget);
 
 
        virtual void removeAllWidgets();
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use Widget::setWidgetName instead") bool setWidgetName(const Widget::Ptr& widget, const std::string& name);
        using Widget::setWidgetName;
 
 
        TGUI_DEPRECATED("Use Widget::getWidgetName instead") std::string getWidgetName(const Widget::ConstPtr& widget) const;
#endif
 
        void uncheckRadioButtons();
 
 
        virtual Vector2f getInnerSize() const;
 
 
        virtual Vector2f getChildWidgetsOffset() const
        {
            return Vector2f{0, 0};
        }
 
 
        void setTextSize(unsigned int size) override;
 
 
        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 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);
 
 
        Widget::Ptr getFocusedChild() const;
 
 
        Widget::Ptr getFocusedLeaf() const;
 
 
        virtual Widget::Ptr getWidgetAtPosition(sf::Vector2f pos) const;
 
 
        bool focusNextWidget(bool recursive = true);
 
 
        bool focusPreviousWidget(bool recursive = true);
 
 
        void setFocused(bool focused) override;
 
 
        void childWidgetFocused(const Widget::Ptr& child);
 
 
        void leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void rightMousePressed(Vector2f pos) override;
 
        void rightMouseReleased(Vector2f pos) override;
 
        void mouseMoved(Vector2f pos) override;
 
        void keyPressed(const sf::Event::KeyEvent& event) override;
 
        void textEntered(std::uint32_t key) override;
 
        bool mouseWheelScrolled(float delta, Vector2f pos) override;
 
        void mouseNoLongerOnWidget() override;
 
        void leftMouseButtonNoLongerDown() override;
 
        void rightMouseButtonNoLongerDown() override;
 
 
        // Shows the tool tip when the widget is located below the mouse.
        // Returns its tool tip or the tool tip from a child widget if the mouse is on top of the widget.
        // A nullptr is returned when the mouse is not on top of the widget or when the tool tip is empty.
        Widget::Ptr askToolTip(Vector2f mousePos) override;
 
 
        // This function is called every frame with the time passed since the last frame.
        bool update(sf::Time elapsedTime) override;
 
 
        // The function returns true when the event is consumed and false when the event was ignored by all widgets.
        bool handleEvent(sf::Event& event);
 
 
    protected:
 
 
        void rendererChanged(const std::string& property) override;
 
 
        std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
        // Checks above which widget the mouse is standing.
        // If there is no widget below the mouse then this function will return a null pointer.
        Widget::Ptr mouseOnWhichWidget(Vector2f mousePos);
 
 
        // This function will call the draw function from all the widgets.
        virtual void drawWidgetContainer(sf::RenderTarget* target, const sf::RenderStates& states = sf::RenderStates::Default) const;
 
 
        // Find out what the index of the focused widget is. Returns 0 when no widget is focused and index+1 otherwise.
        std::size_t getFocusedWidgetIndex() const;
 
 
        // Try to focus the given child widget
        bool tryFocusWidget(const tgui::Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive);
 
 
    protected:
 
        std::vector<Widget::Ptr> m_widgets;
 
        Widget::Ptr m_widgetBelowMouse;
        Widget::Ptr m_focusedWidget;
 
        Vector2f m_prevInnerSize;
 
        // Did we enter handleEvent directly or because we got a MouseReleased event?
        bool m_handingMouseReleased = false;
 
        // Does focusing the next widget always keep a widget from this container focused (e.g. in a ChildWindow)?
        bool m_isolatedFocus = false;
 
 
        friend class SubwidgetContainer; // Needs access to save and load functions
 
    };
 
 
    class TGUI_API GuiContainer : public Container
    {
    public:
 
        typedef std::shared_ptr<GuiContainer> Ptr; 
        typedef std::shared_ptr<const GuiContainer> ConstPtr; 
 
 
        GuiContainer();
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        void setFocused(bool focused) override;
 
 
        bool mouseOnWidget(Vector2f pos) const override;
 
 
    private:
 
 
        // This function does nothing.
        void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
        // Returns a nullptr.
        Widget::Ptr clone() const override
        {
            return nullptr;
        }
 
 
    protected:
 
        friend class Gui; // Required to let Gui access protected members from container and Widget
 
    };
 
 
}
 
 
#endif // TGUI_CONTAINER_HPP