documented (nearly) ever class
This commit is contained in:
+106
-1
@@ -24,24 +24,129 @@
|
||||
#include <QMenuBar>
|
||||
#include <QMenu>
|
||||
|
||||
/**
|
||||
* @brief A menu widget for context menus and menu bars
|
||||
*
|
||||
* A QMenu subclass with functions for creating menus and menu items that conform to Olive's menu and keyboard shortcut
|
||||
* system.
|
||||
*
|
||||
* In Olive, menu items in the menu bar are also responsible for keyboard shortcuts throughout the application. To allow
|
||||
* these to be configurable and these configurations saveable, every item needs a unique ID. This ID gets linked to the
|
||||
* keyboard shortcuts in config files. The ID doesn't get translated so it can also persist through language changes.
|
||||
*
|
||||
* The ID gets stored in the QAction's "id" property. If a keyboard shortcut is provided, it gets stored in the
|
||||
* QAction's "keydefault" property.
|
||||
*
|
||||
* It is always recommended to use this over QMenu in any situation.
|
||||
*/
|
||||
class Menu : public QMenu
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a Menu and add it to a QMenuBar
|
||||
*
|
||||
* This Menu can be connected to a slot that's triggered when the Menu is "about to show". Use `receiver` and
|
||||
* `member` to connect this (same syntax as QObject::connect) or leave as nullptr to not.
|
||||
*/
|
||||
Menu(QMenuBar* bar, const QObject* receiver = nullptr, const char* member = nullptr);
|
||||
|
||||
/**
|
||||
* @brief Construct a Menu and add it as a submenu to another Menu
|
||||
*
|
||||
* This Menu can be connected to a slot that's triggered when the Menu is "about to show". Use `receiver` and
|
||||
* `member` to connect this (same syntax as QObject::connect) or leave as nullptr to not.
|
||||
*/
|
||||
Menu(Menu* bar, const QObject* receiver = nullptr, const char* member = nullptr);
|
||||
|
||||
/**
|
||||
* @brief Create a menu item and add it to this menu
|
||||
*
|
||||
* @param id
|
||||
*
|
||||
* The action's unique ID
|
||||
*
|
||||
* @param receiver
|
||||
*
|
||||
* The QObject to receive the signal when this item is triggered
|
||||
*
|
||||
* @param member
|
||||
*
|
||||
* The QObject slot to connect this action's triggered signal to
|
||||
*
|
||||
* @param key
|
||||
*
|
||||
* Default keyboard sequence
|
||||
*
|
||||
* @return
|
||||
*
|
||||
* The QAction that was created and added to this Menu
|
||||
*/
|
||||
QAction* AddItem(const QString& id,
|
||||
const QObject* receiver,
|
||||
const char* member,
|
||||
const QString &key = QString());
|
||||
|
||||
/**
|
||||
* @brief Create a menu item
|
||||
*
|
||||
* @param parent
|
||||
*
|
||||
* The QAction's parent
|
||||
*
|
||||
* @param id
|
||||
*
|
||||
* The action's unique ID
|
||||
*
|
||||
* @param receiver
|
||||
*
|
||||
* The QObject to receive the signal when this item is triggered
|
||||
*
|
||||
* @param member
|
||||
*
|
||||
* The QObject slot to connect this action's triggered signal to
|
||||
*
|
||||
* @param key
|
||||
*
|
||||
* Default keyboard sequence
|
||||
*
|
||||
* @return
|
||||
*
|
||||
* The QAction that was created and added to this Menu
|
||||
*/
|
||||
static QAction* CreateItem(QObject* parent,
|
||||
const QString& id,
|
||||
const QObject* receiver,
|
||||
const char* member,
|
||||
const QString& key = QString());
|
||||
|
||||
static void ConformItem(QAction *a, const QString& id,
|
||||
/**
|
||||
* @brief Conform a QAction to Olive's ID/keydefault system
|
||||
*
|
||||
* If a QAction was created elsewhere (e.g. through QUndoStack::createUndoAction()), this function will give it
|
||||
* properties conforming it to Olive's menu item system
|
||||
*
|
||||
* @param a
|
||||
*
|
||||
* The QAction's to conform
|
||||
*
|
||||
* @param id
|
||||
*
|
||||
* The action's unique ID
|
||||
*
|
||||
* @param receiver
|
||||
*
|
||||
* The QObject to receive the signal when this item is triggered
|
||||
*
|
||||
* @param member
|
||||
*
|
||||
* The QObject slot to connect this action's triggered signal to
|
||||
*
|
||||
* @param key
|
||||
*
|
||||
* Default keyboard sequence
|
||||
*/
|
||||
static void ConformItem(QAction *a,
|
||||
const QString& id,
|
||||
const QObject* receiver,
|
||||
const char* member,
|
||||
const QString& key = QString());
|
||||
|
||||
@@ -23,6 +23,9 @@
|
||||
|
||||
#include "widget/menu/menu.h"
|
||||
|
||||
/**
|
||||
* @brief A static object that provides various "stock" menus for use throughout the application
|
||||
*/
|
||||
class MenuShared : public QObject {
|
||||
public:
|
||||
MenuShared();
|
||||
|
||||
Reference in New Issue
Block a user