forked from qt-creator/qt-creator
Doc: Added some documentation
...to ioutputpane, inavigationwidgetfactory, ioptionspage and
removed now redundant comments
Authors:
Falko Arps <fjarps@aol.com>
Sven Klein <klein.sven@gmx.de>
Giuliano Schneider <gs93@gmx.net>
Change-Id: I49651dfd4304a2e9a0ba2262a16f812d1fca773e
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
@@ -54,6 +54,7 @@ using namespace Core::Internal;
|
||||
/*!
|
||||
\class Core::ActionManager
|
||||
\mainclass
|
||||
\inmodule Qt Creator
|
||||
|
||||
\brief The ActionManager class is responsible for registration of menus and
|
||||
menu items and keyboard shortcuts.
|
||||
@@ -140,6 +141,18 @@ using namespace Core::Internal;
|
||||
\sa Core::IContext
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void ActionManager::commandListChanged()
|
||||
|
||||
Emitted when the command list has changed.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void ActionManager::commandAdded(const QString &id)
|
||||
|
||||
Emitted when a command (with the \a id) is added.
|
||||
*/
|
||||
|
||||
static ActionManager *m_instance = 0;
|
||||
static ActionManagerPrivate *d;
|
||||
|
||||
@@ -162,8 +175,8 @@ ActionManager::~ActionManager()
|
||||
}
|
||||
|
||||
/*!
|
||||
* \return Singleton action manager instance
|
||||
*/
|
||||
Returns the pointer to the instance, which is only used for connecting to signals.
|
||||
*/
|
||||
ActionManager *ActionManager::instance()
|
||||
{
|
||||
return m_instance;
|
||||
@@ -330,8 +343,8 @@ ActionContainer *ActionManager::actionContainer(Id id)
|
||||
}
|
||||
|
||||
/*!
|
||||
* Returns all commands that have been registered.
|
||||
*/
|
||||
Returns all commands that have been registered.
|
||||
*/
|
||||
QList<Command *> ActionManager::commands()
|
||||
{
|
||||
// transform list of CommandPrivate into list of Command
|
||||
@@ -397,7 +410,11 @@ void ActionManager::unregisterShortcut(Id id)
|
||||
emit m_instance->commandListChanged();
|
||||
}
|
||||
|
||||
|
||||
/*!
|
||||
Handles the display of the used shortcuts in the presentation mode. The presentation mode is
|
||||
enabled when starting \QC with the command line argument \c{-presentationMode}. In the
|
||||
presentation mode, \QC displays any pressed shortcut in a grey box.
|
||||
*/
|
||||
void ActionManager::setPresentationModeEnabled(bool enabled)
|
||||
{
|
||||
if (enabled == isPresentationModeEnabled())
|
||||
|
||||
Reference in New Issue
Block a user