MenuWidgetBase.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 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_WIDGET_BASE_HPP
#define TGUI_MENU_WIDGET_BASE_HPP
 
#include <TGUI/Renderers/MenuWidgetBaseRenderer.hpp>
#include <TGUI/Text.hpp>
#include <TGUI/Widget.hpp>

 
namespace tgui
{
    class OpenMenuPlaceholder;

    class TGUI_API MenuWidgetBase : public Widget
    {
    public:
        struct GetMenusElement
        {
            String text;
            bool enabled;
            std::vector<GetMenusElement> menuItems;
        };
 
    public:
        // Copy constructor
        MenuWidgetBase(const MenuWidgetBase& other);

        // Move constructor
        MenuWidgetBase(MenuWidgetBase&& other) noexcept;

        // Copy assignment operator
        MenuWidgetBase& operator=(const MenuWidgetBase& other);

        // Move assignment operator
        MenuWidgetBase& operator=(MenuWidgetBase&& other) noexcept;

        [[nodiscard]] MenuWidgetBaseRenderer* getSharedRenderer() override;
        [[nodiscard]] const MenuWidgetBaseRenderer* getSharedRenderer() const override;

        [[nodiscard]] MenuWidgetBaseRenderer* getRenderer() override;

        virtual void closeMenu() = 0;

 
    protected:
        struct Menu
        {
            Text text;
            bool enabled = true;
            int selectedMenuItem = -1;
            std::vector<Menu> menuItems;
        };

 
    protected:
        MenuWidgetBase(const char* typeName, bool initRenderer);

        [[nodiscard]] Signal& getSignal(String signalName) override;

        void rendererChanged(const String& property) override;

        void createMenu(std::vector<Menu>& menus, const String& text);

        [[nodiscard]] Menu* findMenuItemParent(const std::vector<String>& hierarchy,
                                               unsigned int parentIndex,
                                               std::vector<Menu>& menus,
                                               bool createParents);

        [[nodiscard]] const Menu* findMenuItemParent(const std::vector<String>& hierarchy,
                                                     unsigned int parentIndex,
                                                     const std::vector<Menu>& menus) const;

        [[nodiscard]] Menu* findMenuItem(const std::vector<String>& hierarchy, std::vector<Menu>& menus);

        [[nodiscard]] const Menu* findMenuItem(const std::vector<String>& hierarchy, const std::vector<Menu>& menus) const;

        void loadMenus(const std::unique_ptr<DataIO::Node>& node, std::vector<Menu>& menus);

        void closeSubMenus(std::vector<Menu>& menus, int& selectedMenu);

        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);

        [[nodiscard]] float calculateMenuWidth(const Menu& menu) const;

        [[nodiscard]] float getMenuItemHeight(const Menu& menuItem) const;

        [[nodiscard]] float calculateOpenMenuHeight(const std::vector<Menu>& menuItems) const;

        [[nodiscard]] Vector2f calculateSubmenuOffset(
            const Menu& menu,
            float globalLeftPos,
            float menuWidth,
            float subMenuWidth,
            bool& openSubMenuToRight) const;

        [[nodiscard]] bool isMouseOnTopOfMenu(Vector2f menuPos, Vector2f mousePos, bool openSubMenuToRight, const Menu& menu, float menuWidth) const;

        [[nodiscard]] bool findMenuItemBelowMouse(
            Vector2f menuPos,
            Vector2f mousePos,
            bool openSubMenuToRight,
            Menu& menu,
            float menuWidth,
            Menu** resultMenu,
            std::size_t* resultSelectedMenuItem);

        static bool isSeparator(const Menu& menuItem);

        static bool removeMenuImpl(const std::vector<String>& hierarchy,
                                   bool removeParentsWhenEmpty,
                                   unsigned int parentIndex,
                                   std::vector<Menu>& menus);

        static bool removeSubMenusImpl(const std::vector<String>& hierarchy, unsigned int parentIndex, std::vector<Menu>& menus);

        static void setTextSizeImpl(std::vector<Menu>& menus, unsigned int textSize);

        static std::vector<GetMenusElement> getMenusImpl(const std::vector<Menu>& menus);

        static void saveMenus(const std::unique_ptr<DataIO::Node>& parentNode, const std::vector<Menu>& menus);

        void drawMenu(BackendRenderTarget& target,
                      RenderStates states,
                      const Menu& menu,
                      float menuWidth,
                      float globalLeftPos,
                      bool openSubMenuToRight) const;

        void leftMouseReleasedOnMenu(const Menu* menu);

        bool isMouseOnOpenMenu(Vector2f pos, const Menu& menu, Vector2f menuOffset) const;

        void mouseMovedOnMenu(Vector2f pos, Menu& menu, Vector2f menuOffset);

        void deselectDeepestItem(Menu* menu);

        void drawOpenMenu(BackendRenderTarget& target, RenderStates states, const Menu& menu, Vector2f menuOffset) const;

        virtual void emitMenuItemClick(const std::vector<String>& hierarchy) = 0;

        [[nodiscard]] virtual float getDefaultMenuItemHeight() const = 0;

        virtual void leftMouseReleasedOnMenu() = 0;

        [[nodiscard]] virtual bool isMouseOnOpenMenu(Vector2f pos) const = 0;

        virtual void mouseMovedOnMenu(Vector2f pos) = 0;

        virtual void deselectDeepestItem() = 0;

        virtual void drawOpenMenu(BackendRenderTarget& target, RenderStates states) const = 0;

 
    public:
        SignalItemHierarchy onMenuItemClick = {"MenuItemClicked"};

 
    protected:
        std::shared_ptr<OpenMenuPlaceholder> m_openMenuPlaceholder;
 
        float m_minimumMenuWidth = 125;
 
        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;
 
        bool m_invertedMenuDirection = false; // Only used by MenuBar
 
        friend class OpenMenuPlaceholder;
    };

    class OpenMenuPlaceholder : public Widget
    {
    public:
        // Instances of this class can't be copied
        OpenMenuPlaceholder(const OpenMenuPlaceholder&) = delete;
        OpenMenuPlaceholder& operator=(const OpenMenuPlaceholder&) = delete;

        explicit OpenMenuPlaceholder(MenuWidgetBase* menuWidget);

        [[nodiscard]] Vector2f getFullSize() const override;

        [[nodiscard]] Vector2f getWidgetOffset() const override;

        [[nodiscard]] bool isMouseOnWidget(Vector2f pos) const override;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

        void leftMouseButtonNoLongerDown() override;

        void rightMousePressed(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        void keyPressed(const Event::KeyEvent& event) override;

        // Makes a copy of the widget
        [[nodiscard]] Widget::Ptr clone() const override;

 
    private:
        MenuWidgetBase* m_menuWidget;
        bool m_mouseWasOnMenuWidget = true; // When a menu opens then the mouse will be on top of the menu bar
    };
 
    using MenuBarMenuPlaceholder TGUI_DEPRECATED("Use OpenMenuPlaceholder instead") = OpenMenuPlaceholder;

} // namespace tgui

 
#endif // TGUI_MENU_WIDGET_BASE_HPP