MenuBar.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_MENU_BAR_HPP
#define TGUI_MENU_BAR_HPP
 
#include <TGUI/Widget.hpp>
#include <TGUI/Renderers/MenuBarRenderer.hpp>
#include <TGUI/Text.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
    class MenuBarMenuPlaceholder;
 
    class TGUI_API MenuBar : public Widget
    {
    public:
 
        using Ptr = std::shared_ptr<MenuBar>; 
        using ConstPtr = std::shared_ptr<const MenuBar>; 
 
        static constexpr const char StaticWidgetType[] = "MenuBar"; 
 
        struct GetMenusElement
        {
            String text;
            bool enabled;
            std::vector<GetMenusElement> menuItems;
        };
 
        struct Menu
        {
            Text text;
            bool enabled = true;
            int selectedMenuItem = -1;
            std::vector<Menu> menuItems;
        };
 
        MenuBar(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
        // Copy constructor
        MenuBar(const MenuBar& other);
 
        // Move constructor
        MenuBar(MenuBar&& other) noexcept;
 
        // Copy assignment operator
        MenuBar& operator=(const MenuBar& other);
 
        // Move assignment operator
        MenuBar& operator=(MenuBar&& other) noexcept;
 
        TGUI_NODISCARD static MenuBar::Ptr create();
 
        TGUI_NODISCARD static MenuBar::Ptr copy(const MenuBar::ConstPtr& menuBar);
 
        TGUI_NODISCARD MenuBarRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const MenuBarRenderer* getSharedRenderer() const override;
 
        TGUI_NODISCARD MenuBarRenderer* getRenderer() override;
 
        template <typename Func, typename... Args>
        unsigned int connectMenuItem(const String& menu, const String& menuItem, Func&& handler, const Args&... args)
        {
            return connectMenuItem({menu, menuItem}, std::forward<Func>(handler), args...);
        }
 
        template <typename Func, typename... Args>
        unsigned int connectMenuItem(const std::vector<String>& hierarchy, Func&& handler, const Args&... args)
        {
#if defined(__cpp_lib_invoke) && (__cpp_lib_invoke >= 201411L)
            return onMenuItemClick.connect(
                [=](const std::vector<String>& clickedMenuItem)
                {
                    if (clickedMenuItem == hierarchy)
                        std::invoke(handler, args...);
                }
            );
#else
            return onMenuItemClick.connect(
                [f=std::function<void(const Args&...)>(handler),args...,hierarchy](const std::vector<String>& clickedMenuItem)
                {
                    if (clickedMenuItem == hierarchy)
                        f(args...);
                }
            );
#endif
        }
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
        void setEnabled(bool enabled) override;
 
        void addMenu(const String& text);
 
        bool addMenuItem(const String& text);
 
        bool addMenuItem(const String& menu, const String& text);
 
        bool addMenuItem(const std::vector<String>& hierarchy, bool createParents = true);
 
        bool changeMenuItem(const std::vector<String>& hierarchy, const String& text);
 
        void removeAllMenus();
 
        bool removeMenu(const String& menu);
 
        bool removeMenuItem(const String& menu, const String& menuItem);
 
        bool removeMenuItem(const std::vector<String>& hierarchy, bool removeParentsWhenEmpty = true);
 
        bool removeMenuItems(const String& menu);
 
        bool removeSubMenuItems(const std::vector<String>& hierarchy);
 
        bool setMenuEnabled(const String& menu, bool enabled);
 
        TGUI_NODISCARD bool getMenuEnabled(const String& menu) const;
 
        bool setMenuItemEnabled(const String& menu, const String& menuItem, bool enabled);
 
        bool setMenuItemEnabled(const std::vector<String>& hierarchy, bool enabled);
 
        TGUI_NODISCARD bool getMenuItemEnabled(const String& menu, const String& menuItem) const;
 
        TGUI_NODISCARD bool getMenuItemEnabled(const std::vector<String>& hierarchy) const;
 
        void setMinimumSubMenuWidth(float minimumWidth);
 
        TGUI_NODISCARD float getMinimumSubMenuWidth() const;
 
        void setInvertedMenuDirection(bool invertDirection);
 
        TGUI_NODISCARD bool getInvertedMenuDirection() const;
 
        TGUI_NODISCARD std::vector<GetMenusElement> getMenus() const;
 
        void closeMenu();
 
        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
        bool leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void mouseMoved(Vector2f pos) override;
 
        void draw(BackendRenderTarget& target, RenderStates states) const override;
 
    protected:
 
        TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
        void rendererChanged(const String& property) override;
 
        TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
        void updateTextSize() override;
 
        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;
 
        void openMenu(std::size_t menuIndex);
 
        void createMenu(std::vector<Menu>& menus, const String& text);
 
        TGUI_NODISCARD Menu* findMenu(const std::vector<String>& hierarchy, unsigned int parentIndex, std::vector<Menu>& menus, bool createParents);
 
        TGUI_NODISCARD const Menu* findMenu(const std::vector<String>& hierarchy, unsigned int parentIndex, const std::vector<Menu>& menus) const;
 
        TGUI_NODISCARD Menu* findMenuItem(const std::vector<String>& hierarchy);
 
        TGUI_NODISCARD const Menu* findMenuItem(const std::vector<String>& hierarchy) const;
 
        void loadMenus(const std::unique_ptr<DataIO::Node>& node, std::vector<Menu>& menus);
 
        void closeSubMenus(std::vector<Menu>& menus, int& selectedMenu);
 
        void deselectBottomItem();
 
        void updateMenuTextColor(Menu& menu, bool selected);
 
        void updateTextColors(std::vector<Menu>& menus, int selectedMenu);
 
        void updateTextOpacity(std::vector<Menu>& menus);
 
        void updateTextFont(std::vector<Menu>& menus);
 
        TGUI_NODISCARD float calculateMenuWidth(const Menu& menu) const;
 
        TGUI_NODISCARD float getMenuItemHeight(const Menu& menuItem) const;
 
        TGUI_NODISCARD float calculateOpenMenuHeight(const std::vector<Menu>& menuItems) const;
 
        TGUI_NODISCARD Vector2f calculateSubmenuOffset(const Menu& menu, float globalLeftPos, float menuWidth, float subMenuWidth, bool& openSubMenuToRight) const;
 
        TGUI_NODISCARD bool isMouseOnTopOfMenu(Vector2f menuPos, Vector2f mousePos, bool openSubMenuToRight, const Menu& menu, float menuWidth) const;
 
        TGUI_NODISCARD bool findMenuItemBelowMouse(Vector2f menuPos, Vector2f mousePos, bool openSubMenuToRight, Menu& menu, float menuWidth, Menu** resultMenu, std::size_t* resultSelectedMenuItem);
 
        void drawMenusOnBar(BackendRenderTarget& target, RenderStates states) const;
 
        void drawMenu(BackendRenderTarget& target, RenderStates states, const Menu& menu, float menuWidth, float globalLeftPos, bool openSubMenuToRight) const;
 
        TGUI_NODISCARD bool isMouseOnOpenMenu(Vector2f pos) const;
 
        void leftMouseReleasedOnMenu();
 
        void mouseMovedOnMenu(Vector2f pos);
 
        void drawOpenMenu(BackendRenderTarget& target, RenderStates states) const;
 
    public:
 
        SignalItemHierarchy onMenuItemClick = {"MenuItemClicked"};
 
    protected:
 
        std::vector<Menu> m_menus;
        std::shared_ptr<MenuBarMenuPlaceholder> m_menuWidgetPlaceholder;
 
        int m_visibleMenu = -1;
 
        float m_minimumSubMenuWidth = 125;
 
        bool m_invertedMenuDirection = false;
 
        Sprite m_spriteBackground;
        Sprite m_spriteItemBackground;
        Sprite m_spriteSelectedItemBackground;
 
        // Cached renderer properties
        Color m_backgroundColorCached;
        Color m_selectedBackgroundColorCached;
        Color m_textColorCached;
        Color m_selectedTextColorCached;
        Color m_textColorDisabledCached;
        Color m_separatorColorCached = Color::Black;
        float m_separatorThicknessCached = 1;
        float m_separatorVerticalPaddingCached = 0;
        float m_separatorSidePaddingCached = 0;
        float m_distanceToSideCached = 0;
 
 
        friend class MenuBarMenuPlaceholder;
    };
 
    class MenuBarMenuPlaceholder : public Widget
    {
    public:
 
        // Instances of this class can't be copied
        MenuBarMenuPlaceholder(const MenuBarMenuPlaceholder&) = delete;
        MenuBarMenuPlaceholder& operator=(const MenuBarMenuPlaceholder&) = delete;
 
        MenuBarMenuPlaceholder(MenuBar* menuBar);
 
        TGUI_NODISCARD Vector2f getFullSize() const override;
 
        TGUI_NODISCARD Vector2f getWidgetOffset() const override;
 
        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
        void draw(BackendRenderTarget& target, RenderStates states) const override;
 
        void leftMouseButtonNoLongerDown() override;
 
        void mouseMoved(Vector2f pos) override;
 
        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;
 
    private:
        MenuBar* m_menuBar;
        bool m_mouseWasOnMenuBar = true; // When a menu opens then the mouse will be on top of the menu bar
    };
 
}
 
 
#endif // TGUI_MENU_BAR_HPP