libraries/ui/src/ui/Menu.h

//
//  Created by Stephen Birarda on 8/12/13.
//  Copyright 2013 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
 
#ifndef hifi_ui_Menu_h
#define hifi_ui_Menu_h
 
#include <functional>
 
#include <QtCore/QDir>
#include <QtCore/QPointer>
#include <QtCore/QStandardPaths>
#include <QtCore/QHash>
#include <QtGui/QKeySequence>
#include <QtWidgets/QMenuBar>
 
class Settings;
namespace ui {
    class Menu;
}
 
class MenuWrapper : public QObject {
public:
 
    QList<QAction*> actions();
    MenuWrapper* addMenu(const QString& menuName);
    void setEnabled(bool enabled = true);
 
    bool isVisible();
    void setVisible(bool visible = true);
    QAction* addSeparator();
    void addAction(QAction* action);
 
    QAction* addAction(const QString& menuName);
    void insertAction(QAction* before, QAction* menuName);
 
    QAction* addAction(const QString& menuName, const QObject* receiver, const char* member, const QKeySequence& shortcut = 0);
    void removeAction(QAction* action);
 
    QAction* newAction() {
        return new QAction(_realMenu);
    }
 
private:
    MenuWrapper(ui::Menu& rootMenu, QMenu* menu);
    ui::Menu& _rootMenu;
    QMenu* const _realMenu;
    friend class ui::Menu;
};
 
namespace ui {
 
class Menu : public QMenuBar {
    Q_OBJECT
public:
    static const int UNSPECIFIED_POSITION = -1;
 
    Menu();
 
    void loadSettings();
    void saveSettings();
 
    MenuWrapper* getMenu(const QString& menuName);
    MenuWrapper* getSubMenuFromName(const QString& menuName, MenuWrapper* menu);
 
    QAction* getActionForOption(const QString& menuOption);
 
    QAction* addActionToQMenuAndActionHash(MenuWrapper* destinationMenu,
                                           const QString& actionName,
                                           const QKeySequence& shortcut = 0,
                                           const QObject* receiver = NULL,
                                           const char* member = NULL,
                                           QAction::MenuRole role = QAction::NoRole,
                                           int menuItemLocation = UNSPECIFIED_POSITION,
                                           const QString& grouping = QString());
 
    QAction* addActionToQMenuAndActionHash(MenuWrapper* destinationMenu,
                                           QAction* action,
                                           const QString& actionName = QString(),
                                           const QKeySequence& shortcut = 0,
                                           QAction::MenuRole role = QAction::NoRole,
                                           int menuItemLocation = UNSPECIFIED_POSITION,
                                           const QString& grouping = QString());
 
    QAction* addCheckableActionToQMenuAndActionHash(MenuWrapper* destinationMenu,
                                                    const QString& actionName,
                                                    const QKeySequence& shortcut = 0,
                                                    const bool checked = false,
                                                    const QObject* receiver = NULL,
                                                    const char* member = NULL,
                                                    int menuItemLocation = UNSPECIFIED_POSITION,
                                                    const QString& grouping = QString());
 
    QAction* addCheckableActionToQMenuAndActionHash(MenuWrapper* destinationMenu,
                                                    const QString& actionName,
                                                    const std::function<void(bool)>& handler,
                                                    const QKeySequence& shortcut = 0,
                                                    const bool checked = false,
                                                    int menuItemLocation = UNSPECIFIED_POSITION,
                                                    const QString& grouping = QString());
 
    void removeAction(MenuWrapper* menu, const QString& actionName);
 
public slots:
    MenuWrapper* addMenu(const QString& menuName, const QString& grouping = QString());
    void removeMenu(const QString& menuName);
    bool menuExists(const QString& menuName);
    void addSeparator(const QString& menuName, const QString& separatorName, const QString& grouping = QString());
    void removeSeparator(const QString& menuName, const QString& separatorName);
    void removeMenuItem(const QString& menuName, const QString& menuitem);
    bool menuItemExists(const QString& menuName, const QString& menuitem);
    bool isOptionChecked(const QString& menuOption) const;
    void setIsOptionChecked(const QString& menuOption, bool isChecked);
 
    bool isMenuEnabled(const QString& menuName);
    void setMenuEnabled(const QString& menuName, bool isEnabled);
 
    bool getGroupingIsVisible(const QString& grouping);
    void setGroupingIsVisible(const QString& grouping, bool isVisible); 
 
    void toggleDeveloperMenus();
    void toggleAdvancedMenus();
 
    void triggerOption(const QString& menuOption);
 
    static bool isSomeSubmenuShown() { return _isSomeSubmenuShown; }
 
protected:
    typedef void(*settingsAction)(Settings&, QAction&);
    static void loadAction(Settings& settings, QAction& action);
    static void saveAction(Settings& settings, QAction& action);
    void scanMenuBar(settingsAction modifySetting);
    void scanMenu(QMenu& menu, settingsAction modifySetting, Settings& settings);
 
    void addDisabledActionAndSeparator(MenuWrapper* destinationMenu, 
                                       const QString& actionName,
                                       int menuItemLocation = UNSPECIFIED_POSITION, 
                                       const QString& grouping = QString());
 
    QAction* getActionFromName(const QString& menuName, MenuWrapper* menu);
    MenuWrapper* getMenuParent(const QString& menuName, QString& finalMenuPart);
 
    QAction* getMenuAction(const QString& menuName);
    int findPositionOfMenuItem(MenuWrapper* menu, const QString& searchMenuItem);
    int positionBeforeSeparatorIfNeeded(MenuWrapper* menu, int requestedPosition);
 
    // There is a design flaw here -- _actionHash is system-wide and hashes the names of menu-items to their
    // QActions.  The path (parent submenu name etc) isn't included in the hash key.  This generally works,
    // but we add "Home" twice -- once for "go home" and once for "set startup location to home".  Anytime
    // a user bookmarks a place and gives it a name like an existing menu-item, something will go wrong.
    // TODO: change the js api to require the full path when referring to a specific menu item.
    QHash<QString, QAction*> _actionHash;
 
    bool isValidGrouping(const QString& grouping) const { return grouping == "Advanced" || grouping == "Developer"; }
    QHash<QString, bool> _groupingVisible;
    QHash<QString, QSet<QAction*>> _groupingActions;
    QHash<QMenu*, MenuWrapper*> _backMap;
 
    static bool _isSomeSubmenuShown;
    friend class ::MenuWrapper;
};
 
} // namespace ui
 
#endif // hifi_Menu_h