ContextMenu.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 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_CONTEXT_MENU_HPP
#define TGUI_CONTEXT_MENU_HPP
 
#include <TGUI/Widgets/MenuWidgetBase.hpp>
#include <TGUI/Renderers/ContextMenuRenderer.hpp>

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API ContextMenu : public MenuWidgetBase
    {
    public:
 
        using Ptr = std::shared_ptr<ContextMenu>; 
        using ConstPtr = std::shared_ptr<const ContextMenu>; 
 
        static constexpr const char StaticWidgetType[] = "ContextMenu"; 

        ContextMenu(const char* typeName = StaticWidgetType, bool initRenderer = true);

        TGUI_NODISCARD static ContextMenu::Ptr create();

        TGUI_NODISCARD static ContextMenu::Ptr copy(const ContextMenu::ConstPtr& menuBar);

        TGUI_NODISCARD ContextMenuRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const ContextMenuRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD ContextMenuRenderer* getRenderer() override;

        TGUI_NODISCARD bool isMenuOpen() const;

        void openMenu();

        void openMenu(Vector2f position);

        void openMenuAtMouseCursor();

        void closeMenu() override;

        void setItemHeight(float itemHeight);

        TGUI_NODISCARD float getItemHeight() const;

        template <typename Func, typename... Args>
        unsigned int connectMenuItem(const String& menuItem, Func&& handler, const Args&... args)
        {
            return connectMenuItem(std::vector<String>{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 addMenuItem(const String& text);

        bool addMenuItem(const std::vector<String>& hierarchy, bool createParents = true);

        bool changeMenuItem(const std::vector<String>& hierarchy, const String& text);

        void removeAllMenuItems();

        bool removeMenuItem(const String& menuItem);

        bool removeMenuItem(const std::vector<String>& hierarchy, bool removeParentsWhenEmpty = true);

        bool removeSubMenuItems(const std::vector<String>& hierarchy);

        bool setMenuItemEnabled(const String& menuItem, bool enabled);

        bool setMenuItemEnabled(const std::vector<String>& hierarchy, bool enabled);

        TGUI_NODISCARD bool getMenuItemEnabled(const String& menuItem) const;

        TGUI_NODISCARD bool getMenuItemEnabled(const std::vector<String>& hierarchy) const;

        void setMinimumMenuWidth(float minimumWidth);

        TGUI_NODISCARD float getMinimumMenuWidth() const;

        TGUI_NODISCARD std::vector<GetMenusElement> getMenuItems() const;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

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

        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 emitMenuItemClick(const std::vector<String>& hierarchy) override;

        TGUI_NODISCARD float getDefaultMenuItemHeight() const override;

        void leftMouseReleasedOnMenu() override;

        TGUI_NODISCARD bool isMouseOnOpenMenu(Vector2f pos) const override;

        void mouseMovedOnMenu(Vector2f pos) override;

        void deselectDeepestItem() override;

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

    protected:
 
        Menu m_menu;
        bool m_menuOpen = false;
        float m_itemHeight = 0;
    };

}

 
#endif // TGUI_CONTEXT_MENU_HPP