StelActionMgr Class Reference

Manager for StelAction instances. Allows registration of new actions, and finding an existing one by name. More...

#include <StelActionMgr.hpp>

Public Slots
void	setAllActionsEnabled (bool value)
	Enable/disable all actions of application. More...

Signals
void	actionToggled (const QString &id, bool value)
	Emitted when any action registered with this StelActionMgr is toggled. More...
void	shortcutsChanged ()

Public Member Functions
StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="", bool global=false)
	Create and add a new StelAction, connected to an object property or slot. More...
StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *context, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="", bool global=false)
	Create and add a new StelAction, connected to an object slot. More...
StelAction *	findAction (const QString &id)
StelAction *	findActionFromShortcut (const QString &shortcut)
bool	pushKey (int key, bool global=false)
QStringList	getGroupList () const
	Returns a list of all current StelAction groups.
QList< StelAction * >	getActionList (const QString &group) const
	Returns all StelActions in the specified group.
QList< StelAction * >	getActionList () const
	Returns all registered StelActions.
QStringList	getShortcutsList () const
void	saveShortcuts ()
	Save current shortcuts to file.
void	restoreDefaultShortcuts ()
	Restore the default shortcuts combinations.
void	restoreDefaultShortcut (StelAction *action)

Detailed Description

Manager for StelAction instances. Allows registration of new actions, and finding an existing one by name.

Member Function Documentation

actionToggled

void StelActionMgr::actionToggled ( const QString &  id, bool  value  )

signal

Emitted when any action registered with this StelActionMgr is toggled.

Parameters

id	The id of the action that was toggled
value	The new value of the action

addAction() [1/2]

StelAction* StelActionMgr::addAction	(	const QString &	id,
		const QString &	groupId,
		const QString &	text,
		QObject *	context,
		std::function< void()>	lambda,
		const QString &	shortcut = "",
		const QString &	altShortcut = "",
		bool	global = false
	)

Create and add a new StelAction, connected to an object slot.

Parameters

id	Global identifier.
groupId	Group identifier.
text	Short human-readable description in English.
context	a reference object. When this is deleted, the Lambda function will not be called.
lambda	a void function (Lambda). This can call slots and other functions.
shortcut	Default shortcut/key combination for this action
altShortcut	Alternative shortcut
global	determines QAction shortcut context (not necessary anymore?)

addAction() [2/2]

StelAction* StelActionMgr::addAction	(	const QString &	id,
		const QString &	groupId,
		const QString &	text,
		QObject *	target,
		const char *	slot,
		const QString &	shortcut = "",
		const QString &	altShortcut = "",
		bool	global = false
	)

Create and add a new StelAction, connected to an object property or slot.

Parameters

id	Global identifier.
groupId	Group identifier.
text	Short human-readable description in English.
target	The QObject the action is linked to.
slot	The target slot or property that the action will trigger. Either a slot name of the form 'func()' and in that case the action is made non checkable, a slot name of the form 'func(bool)' and in that case the action is made checkable, or a property name and in that case the action is made checkable.
shortcut	Default shortcut/key combination for this action
altShortcut	Alternative shortcut
global	determines QAction shortcut context (not necessary anymore?)

setAllActionsEnabled

void StelActionMgr::setAllActionsEnabled ( bool  value )

inlineslot

Enable/disable all actions of application.

need for editing shortcuts without triggering any actions