feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Fixup Core::Command API documentation

Browse Source 
Adaptions to multiple shortcuts feature and minor corrections.

Change-Id: I70f89036f292920d894d3bb760199004fc99ade8
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
2020-04-24 15:09:08 +02:00
parent 96934b9eeb
commit fd527a4828
1 changed files with 55 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
src/plugins/coreplugin/actionmanager/command.cpp
View File

@@ -50,11 +50,13 @@
action and its properties. If multiple actions are registered with the same ID (but action and its properties. If multiple actions are registered with the same ID (but
different contexts) the returned Command is the shared one between these actions. different contexts) the returned Command is the shared one between these actions.
A Command has two basic properties: a default shortcut and a default text. The default A Command has two basic properties: a list of default shortcuts and a
shortcut is a key sequence that the user can use to trigger the active action that default text. The default shortcuts are key sequence that the user can use
the Command represents. The default text is e.g. used for representing the Command to trigger the active action that the Command represents. The first
in the keyboard shortcut preference pane. If the default text is empty, the text shortcut in that list is the main shortcut that is for example also shown
of the visible action is used. in tool tips and menus. The default text is used for representing the
Command in the keyboard shortcut preference pane. If the default text is
empty, the text of the visible action is used.
The user visible action is updated to represent the state of the active action (if any). The user visible action is updated to represent the state of the active action (if any).
For performance reasons only the enabled and visible state are considered by default though. For performance reasons only the enabled and visible state are considered by default though.
@@ -79,37 +81,56 @@
When there is no active action, hide the user-visible action, instead of just When there is no active action, hide the user-visible action, instead of just
disabling it. disabling it.
\value CA_NonConfigurable \value CA_NonConfigurable
Flag to indicate that the keyboard shortcut of this Command should not be Flag to indicate that the keyboard shortcuts of this Command should not
configurable by the user. be configurable by the user.
*/ */
/*! /*!
\fn void Core::Command::setDefaultKeySequence(const QKeySequence &key) \fn void Core::Command::setDefaultKeySequence(const QKeySequence &key)
Sets the default keyboard shortcut that can be used to activate this command to \a key.
This is used if the user didn't customize the shortcut, or resets the shortcut Sets the default keyboard shortcut that can be used to activate this
to the default one. command to \a key. This is used if the user didn't customize the shortcut,
or resets the shortcut to the default.
*/ */
/*! /*!
\fn void Core::Command::defaultKeySequence() const \fn void Core::Command::setDefaultKeySequences(const QList<QKeySequence> &keys)
Returns the default keyboard shortcut that can be used to activate this command.
\sa setDefaultKeySequence() Sets the default keyboard shortcuts that can be used to activate this
command to \a keys. This is used if the user didn't customize the
shortcuts, or resets the shortcuts to the default.
*/
/*!
\fn QList<QKeySequence> Core::Command::defaultKeySequences() const
Returns the default keyboard shortcuts that can be used to activate this
command.
\sa setDefaultKeySequences()
*/ */
/*! /*!
\fn void Core::Command::keySequenceChanged() \fn void Core::Command::keySequenceChanged()
Sent when the keyboard shortcut assigned to this Command changes, e.g. Sent when the keyboard shortcuts assigned to this Command change, e.g.
when the user sets it in the keyboard shortcut settings dialog. when the user sets them in the keyboard shortcut settings dialog.
*/
/*!
\fn QList<QKeySequence> Core::Command::keySequences() const
Returns the current keyboard shortcuts assigned to this Command.
\sa defaultKeySequences()
*/ */
/*! /*!
\fn QKeySequence Core::Command::keySequence() const \fn QKeySequence Core::Command::keySequence() const
Returns the current keyboard shortcut assigned to this Command.
\sa defaultKeySequence() Returns the current main keyboard shortcut assigned to this Command.
\sa defaultKeySequences()
*/ */
/*! /*!
\fn void Core::Command::setKeySequence(const QKeySequence &key) \fn void Core::Command::setKeySequences(const QList<QKeySequence> &keys)
\internal \internal
*/ */
@@ -134,21 +155,20 @@
/*! /*!
\fn QString Core::Command::stringWithAppendedShortcut(const QString &string) const \fn QString Core::Command::stringWithAppendedShortcut(const QString &string) const
Returns the \a string with an appended representation of the keyboard shortcut
that is currently assigned to this Command. Returns the \a string with an appended representation of the main keyboard
shortcut that is currently assigned to this Command.
*/ */
/*! /*!
\fn QAction *Core::Command::action() const \fn QAction *Core::Command::action() const
Returns the user visible action for this Command.
If the Command represents a shortcut, it returns null. Returns the user visible action for this Command. Use this action to put it
Use this action to put it on e.g. tool buttons. The action on e.g. tool buttons. The action automatically forwards \c triggered() and
automatically forwards trigger and toggle signals to the \c toggled() signals to the action that is currently active for this
action that is currently active for this Command. Command. It also shows the current main keyboard shortcut in its tool tip
It also shows the current keyboard shortcut in its (in addition to the tool tip of the active action) and gets disabled/hidden
tool tip (in addition to the tool tip of the active action) when there is no active action for the current context.
and gets disabled/hidden when there is
no active action for the current context.
*/ */
/*! /*!
@@ -182,8 +202,8 @@
/*! /*!
\fn bool Core::Command::isActive() const \fn bool Core::Command::isActive() const
Returns whether the Command has an active action or shortcut for the current
context. Returns whether the Command has an active action for the current context.
*/ */
/*! /*!
@@ -230,7 +250,7 @@
/*! \fn virtual QAction *Core::Command::touchBarAction() const /*! \fn virtual QAction *Core::Command::touchBarAction() const
Adds an action to the touch bar. \internal
*/ */
namespace Core { namespace Core {
@@ -503,8 +523,8 @@ QAction *Action::touchBarAction() const
} // namespace Internal } // namespace Internal
/*! /*!
Appends the keyboard shortcut that is currently assigned to the action \a a Appends the main keyboard shortcut that is currently assigned to the action
to its tool tip. \a a to its tool tip.
*/ */
void Command::augmentActionWithShortcutToolTip(QAction *a) const void Command::augmentActionWithShortcutToolTip(QAction *a) const
{ {
@@ -520,7 +540,7 @@ void Command::augmentActionWithShortcutToolTip(QAction *a) const
/*! /*!
Returns a tool button for \a action. Returns a tool button for \a action.
Appends the keyboard shortcut \a cmd to the tool tip of the action. Appends the main keyboard shortcut \a cmd to the tool tip of the action.
*/ */
QToolButton *Command::toolButtonWithAppendedShortcut(QAction *action, Command *cmd) QToolButton *Command::toolButtonWithAppendedShortcut(QAction *action, Command *cmd)
{ {