diff options
Diffstat (limited to 'src/plugins/coreplugin/actionmanager/command.cpp')
| -rw-r--r-- | src/plugins/coreplugin/actionmanager/command.cpp | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/plugins/coreplugin/actionmanager/command.cpp b/src/plugins/coreplugin/actionmanager/command.cpp index b49eb5274e..66b07f030e 100644 --- a/src/plugins/coreplugin/actionmanager/command.cpp +++ b/src/plugins/coreplugin/actionmanager/command.cpp @@ -44,13 +44,13 @@ \class Core::Command \mainclass - \brief The class Command represents an action like a menu item, tool button, or shortcut. - You don't create Command objects directly, instead use \l{ActionManager::registerAction()} + \brief The Command class represents an action, such as a menu item, tool button, or shortcut. + You do not create Command objects directly, but use \l{ActionManager::registerAction()} to register an action and retrieve a Command. The Command object represents the user visible 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. - A Command has two basic properties: A default shortcut and a default text. The default + A Command has two basic properties: a default shortcut and a default text. The default shortcut is a key sequence that the user can use to trigger the active action that the Command represents. The default text is e.g. used for representing the Command in the keyboard shortcut preference pane. If the default text is empty, the text @@ -68,7 +68,7 @@ /*! \enum Command::CommandAttribute - Defines how the user visible action is updated when the active action changes. + This enum defines how the user visible action is updated when the active action changes. The default is to update the enabled and visible state, and to disable the user visible action when there is no active action. \omitvalue CA_Mask @@ -86,7 +86,7 @@ /*! \fn void Command::setDefaultKeySequence(const QKeySequence &key) - Set the default keyboard shortcut that can be used to activate this command to \a 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 to the default one. */ @@ -116,10 +116,10 @@ /*! \fn void Command::setDescription(const QString &text) - Set the \a text that is used to represent the Command in the - keyboard shortcut settings dialog. If you don't set this, + Sets the \a text that is used to represent the Command in the + keyboard shortcut settings dialog. If you do not set this, the current text from the user visible action is taken (which - is ok in many cases). + is fine in many cases). */ /*! @@ -160,7 +160,7 @@ /*! \fn void Command::setAttribute(CommandAttribute attribute) - Add the \a attribute to the attributes of this Command. + Adds \a attribute to the attributes of this Command. \sa CommandAttribute \sa removeAttribute() \sa hasAttribute() @@ -168,14 +168,14 @@ /*! \fn void Command::removeAttribute(CommandAttribute attribute) - Remove the \a attribute from the attributes of this Command. + Removes \a attribute from the attributes of this Command. \sa CommandAttribute \sa setAttribute() */ /*! \fn bool Command::hasAttribute(CommandAttribute attribute) const - Returns if the Command has the \a attribute set. + Returns whether the Command has the \a attribute set. \sa CommandAttribute \sa removeAttribute() \sa setAttribute() @@ -183,19 +183,19 @@ /*! \fn bool Command::isActive() const - Returns if the Command has an active action/shortcut for the current + Returns whether the Command has an active action or shortcut for the current context. */ /*! \fn bool Command::isScriptable() const - Returns if the Command is scriptable. A scriptable command can be called + Returns whether the Command is scriptable. A scriptable command can be called from a script without the need for the user to interact with it. */ /*! \fn bool Command::isScriptable(const Context &) const - Returns if the Command is scriptable for the given context. + Returns whether the Command is scriptable for the given context. A scriptable command can be called from a script without the need for the user to interact with it. */ |