menuaction.h

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
#ifndef SWIFT_GUI_MENUS_MENUACTION_H
#define SWIFT_GUI_MENUS_MENUACTION_H
 
#include <QIcon>
#include <QKeySequence>
#include <QList>
#include <QMap>
#include <QMultiMap>
#include <QString>
 
#include "misc/slot.h"
 
class QAction;
class QMenu;
class QObject;
 
namespace swift::gui::menus
{
    class CMenuAction
    {
    public:
        CMenuAction(const QIcon &icon, const QString &title, const QString &path = pathNone(), bool separator = false);
 
        CMenuAction(const QString &path = pathNone(), bool separator = false);
 
        CMenuAction(QAction *action, const QString &path = pathNone(), bool separator = false);
 
        void setTitle(const QString &title) { m_title = title; }
 
        void setIcon(const QIcon &icon) { m_icon = icon; }
 
        void setPath(const QString &path) { m_path = path; }
 
        QAction *getQAction() const { return m_action; }
 
        bool isCheckableQAction() const;
 
        void setActionChecked(bool checked);
 
        bool isActionEnabled() const;
 
        void setActionEnabled(bool enabled);
 
        const QString &getPath() const { return m_path; }
 
        QString getLastPathPart() const;
 
        const QString &getTitle() const { return m_title; }
 
        bool hasTitle() const { return !m_title.isEmpty(); }
 
        bool isSubMenu() const { return m_isMenu; }
 
        bool isSeparator() const { return m_title == "_SEP_"; }
 
        void setSubMenu(bool menu) { m_isMenu = menu; }
 
        bool hasNoPathWithSeparator() const;
 
        bool hasNoPath() const;
 
        const QIcon &getIcon() const { return m_icon; }
 
        QPixmap getPixmap() const;
 
        bool hasIcon() const { return !m_icon.isNull(); }
 
        void setEnabled(bool enabled);
 
        operator QAction *() const { return this->m_action; }
 
        // ---- paths for menus ----
 
        static const QString &pathNone()
        {
            static const QString p("_NONE");
            return p;
        }
 
        static const QString &pathSeparator()
        {
            static const QString p("_SEPARATOR");
            return p;
        }
 
        static const QString &pathSimulator()
        {
            static const QString p("Custom.10.Simulator/Simulator");
            return p;
        }
 
        static const QString &pathSimulatorModelsReload()
        {
            static const QString p("Custom.10.Simulator/Simulator/Reload models");
            return p;
        }
 
        static const QString &pathSimulatorModelsClearCache()
        {
            static const QString p("Custom.10.Simulator/Simulator/Clear model caches");
            return p;
        }
 
        static const QString &pathModel()
        {
            static const QString p("Custom.11.Model");
            return p;
        }
 
        static const QString &pathModelSet()
        {
            static const QString p("Custom.11.Model/Model set");
            return p;
        }
 
        static const QString &pathModelSetNew()
        {
            static const QString p("Custom.11.Model/Model set/New set");
            return p;
        }
 
        static const QString &pathModelConsolidate()
        {
            static const QString p("Custom.11.Model/Consolidate");
            return p;
        }
 
        static const QString &pathModelStash()
        {
            static const QString p("Custom.11.Model/Stash/Stash");
            return p;
        }
 
        static const QString &pathModelStashEditor()
        {
            static const QString p("Custom.11.Model/Stash/Editor");
            return p;
        }
 
        static const QString &pathVPilot()
        {
            static const QString p("Custom.14.vPilot/vPilot");
            return p;
        }
 
        static const QString &pathLog()
        {
            static const QString p("Custom15.Log");
            return p;
        }
 
        static const QString &pathFont()
        {
            static const QString p("Custom20.Font");
            return p;
        }
 
        // ---- client ----
 
        static const QString &pathClientCom()
        {
            static const QString p("Client.ATC/COM");
            return p;
        }
 
        static const QString &pathClientFlightPlan()
        {
            static const QString p("Client.FlightPlan");
            return p;
        }
 
        static const QString &pathClientFollowInSim()
        {
            static const QString p("Client.FollowInSim");
            return p;
        }
 
        static const QString &pathClientSimulation()
        {
            static const QString p("ClientSimulation");
            return p;
        }
 
        static const QString &pathClientSimulationDisplay()
        {
            static const QString p("ClientSimulation.Display/Display");
            return p;
        }
 
        static const QString &pathClientSimulationRender()
        {
            static const QString p("ClientSimulation.Display/Render");
            return p;
        }
 
        static const QString &pathClientSimulationTransfer()
        {
            static const QString p("ClientSimulation.Transfer/Transfer");
            return p;
        }
 
        static const QString &pathClientModelSet()
        {
            static const QString p("Client.Model set");
            return p;
        }
 
        static const QString &pathClientNetwork()
        {
            static const QString p("ClientNetwork/Network");
            return p;
        }
 
        // ---- standard view paths --------
 
        static const QString &pathViewDatabase()
        {
            static const QString p("View.10.Database/Database");
            return p;
        }
 
        static const QString &pathViewAddRemove()
        {
            static const QString p("View.12.AddRemove");
            return p;
        }
 
        static const QString &pathViewSelection()
        {
            static const QString p("View.13.Selection/Selection");
            return p;
        }
 
        static const QString &pathViewOrder()
        {
            static const QString p("View.14.Order/Order");
            return p;
        }
 
        static const QString &pathViewResize()
        {
            static const QString p("View.15.Resize");
            return p;
        }
 
        static const QString &pathViewWordWrap()
        {
            static const QString p("View.16.WordWrap");
            return p;
        }
 
        static const QString &pathViewClearHighlighting()
        {
            static const QString p("View.17.ClearHighlight");
            return p;
        }
 
        static const QString &pathViewFilter()
        {
            static const QString p("View.18.Filter");
            return p;
        }
 
        static const QString &pathViewUpdates()
        {
            static const QString p("View.19.Updates");
            return p;
        }
 
        static const QString &pathViewLoadSave()
        {
            static const QString p("View.19.LoadSave");
            return p;
        }
 
        static const QString &pathViewCutPaste()
        {
            static const QString p("View.19.CutPaste");
            return p;
        }
 
        // ---- nested dock widgets ----
 
        static const QString &pathDockWidgetNested()
        {
            static const QString p("DockWidget.Nested");
            return p;
        }
 
        static const CMenuAction &subMenuDatabase();
        static const CMenuAction &subMenuSimulator();
        static const CMenuAction &subMenuConsolidateModels();
        static const CMenuAction &subMenuCom();
        static const CMenuAction &subMenuDisplayModels();
        static const CMenuAction &subMenuRenderModels();
        static const CMenuAction &subMenuDataTransfer();
 
    private:
        QAction *m_action = nullptr; 
        QIcon m_icon; 
        QString m_title; 
        QString m_path; 
        bool m_separator = false; 
        bool m_isMenu = false; 
    };
 
    class CMenuActions
    {
    public:
        CMenuActions() {}
 
        CMenuActions(const QList<CMenuAction> &actions);
 
        CMenuActions getActions() const { return m_actions.values(); }
 
        QList<QAction *> getQActions() const;
 
        CMenuActions getMenuActions(const QString &path) const;
 
        bool containsMenu(const QString &path) const;
 
        bool isEmpty() const { return m_actions.isEmpty(); }
 
        int size() const { return m_actions.size(); }
 
        CMenuAction addMenu(const CMenuAction &subdirAction);
 
        CMenuAction addMenu(const QString &title, const QString &path);
 
        void addSeparator(const QString &path);
 
        CMenuAction addMenu(const QIcon &icon, const QString &title, const QString &path);
 
        CMenuAction addAction(const CMenuAction &menuAction);
 
        CMenuActions addActions(const CMenuActions &actions);
 
        CMenuAction addAction(QAction *action, const QString &path);
 
        CMenuActions addActions(const QList<QAction *> &actions, const QString &path);
 
        CMenuAction addAction(QAction *action, const QString &text, const QString &path,
                              const swift::misc::CSlot<void()> &slot, const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(QAction *action, const QString &text, const QString &path, QObject *actionOwner,
                              const swift::misc::CSlot<void()> &slot, const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(QAction *action, const QIcon &icon, const QString &text, const QString &path,
                              const swift::misc::CSlot<void()> &slot, const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(QAction *action, const QIcon &icon, const QString &text, const QString &path,
                              QObject *actionOwner, const swift::misc::CSlot<void()> &slot,
                              const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(const QString &text, const QString &path, QObject *actionOwner,
                              const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(const QIcon &actionIcon, const QString &text, const QString &path, QObject *actionOwner,
                              const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(const QIcon &actionIcon, const QString &text, const QString &path, QObject *actionOwner,
                              const swift::misc::CSlot<void()> &slot, const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(const QIcon &actionIcon, const QString &text, const QString &path);
 
        CMenuAction addAction(const QIcon &actionIcon, const QString &text, const QString &path,
                              const swift::misc::CSlot<void()> &slot, const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(const QString &text, const QString &path, const swift::misc::CSlot<void()> &slot,
                              const QKeySequence &shortcut = 0);
 
        CMenuAction addAction(const QString &text, const QString &path, QObject *actionOwner,
                              const swift::misc::CSlot<void()> &slot, const QKeySequence &shortcut = 0);
 
        void toQMenu(QMenu &menu, bool separateGroups) const;
 
        QList<CMenuAction> toQList() const;
 
        CMenuAction first() const { return m_actions.first(); }
 
        CMenuAction last() const { return m_actions.last(); }
 
        operator QList<QAction *>() const;
 
        operator QList<CMenuAction>() const { return toQList(); }
 
 
        CMenuAction addMenuViewOrder();
 
        CMenuAction addMenuSimulator();
 
        CMenuAction addMenuStash();
 
        CMenuAction addMenuStashEditor();
 
        CMenuAction addMenuDatabase();
 
        CMenuAction addMenuConsolidateModels();
 
        CMenuAction addMenuModelSet();
 
        CMenuAction addMenuModelConverterX();
 
        CMenuAction addMenuCom();
 
        CMenuAction addMenuDisplayModels();
 
        CMenuAction addMenuRenderModels();
 
        CMenuAction addMenuDataTransfer();
 
 
    private:
        QMultiMap<QString, CMenuAction> m_actions; 
 
        void splitSubMenus(const QString &key, QList<CMenuAction> &actions, QList<CMenuAction> &menus) const;
 
        static int pathDepth(const QString &path);
 
        static QMenu *currentMenuForAction(QMenu &menu, const CMenuAction &menuAction, const QList<CMenuAction> &menus,
                                           QMap<QString, QMenu *> &subMenus, const QString &key, int pd);
 
        static QString parentPath(const QString &cuurentPath);
 
        static QString keyRoot(const QString &key);
 
        static bool isSameKeyRoot(const QString &key1, const QString &key2);
 
        static QMenu *findUpwardsInMenus(const QString &key, const QMap<QString, QMenu *> &menus);
    };
} // namespace swift::gui::menus
 
#endif // SWIFT_GUI_MENUS_MENUACTION_H