Manages a set of actions accessible by unique identifier. More...

#include <QtxActionMgr.h>

Inheritance diagram for QtxActionMgr:

Classes
class	Creator
	Generic actions creator class. More...

class	Reader
	Generic actions description files reader class. More...

class	SeparatorAction
	Separator action class. More...

class	XMLReader
	XML file reader. More...

Public Member Functions
	QtxActionMgr (QObject *parent)
	Constructor. More...

virtual	~QtxActionMgr ()
	Destructor. More...

virtual int	registerAction (QAction *, const int=-1)
	Register an action in the internal map. More...

virtual void	unRegisterAction (const int)
	Unregister action from internal map. More...

QAction *	action (const int) const
	Get action by specified identifier. More...

int	actionId (const QAction *) const
	Get action identifier. More...

bool	contains (const int) const
	Check if an action with given id is registered in the action manager. More...

int	count () const
	Get total number of registered actions. More...

bool	isEmpty () const
	Check if there are no actions registered in the action manager. More...

QIntList	idList () const
	Get all registered actions identifiers. More...

bool	isUpdatesEnabled () const
	Check if update is enabled. More...

virtual void	setUpdatesEnabled (const bool)
	Enable/disable update operation. More...

virtual bool	isVisible (const int, const int) const
	Check if an action with actId identifier is visible to the parent action with place identifier. More...

virtual void	setVisible (const int, const int, const bool)
	Set action's visibility flag. More...

void	update ()
	Update actions. More...

virtual bool	isEnabled (const int) const
	Check is action with given id is enabled. More...

virtual void	setEnabled (const int, const bool)

Static Public Member Functions
static QAction *	separator (const bool=false)
	Create new separator action. More...

Protected Member Functions
virtual void	internalUpdate ()
	Internal update. More...

int	generateId () const
	Generate unique action identifier. More...

void	triggerUpdate ()
	Perform delayed update. More...

virtual void	updateContent ()
	Internal content update operation. More...

virtual void	actionChanged (int)
	Internal action changing response operation. More...

Private Types
typedef QPointer< QAction >	ActionPtr
	Action guarded pointer. More...

typedef QMap< int, ActionPtr >	ActionMap
	Actions map. More...

Private Slots
void	onActionChanged ()
	Called when one of the registered actions changed. More...

void	onUpdateContent ()
	Called when delayed update is performed (via timer event). More...

Private Attributes
bool	myUpdate
	update flag More...

ActionMap	myActions
	actions map More...

QTimer *	myUpdTimer
	update timer More...

Detailed Description

Manages a set of actions accessible by unique identifier.

Base class for menu, toolbar actions containers and popup menu creators.

Actions are registered in the manager with the registerAction() method and unregistered from it with the unRegisterAction() method.

Functions action() and actionId() allow getting action by its identifier and vice versa. Method contains() returns true if the action with the specified identifier is already registered.

To get total number of the registered actions can be retrieved by the method count(). Function isEmpty() returns true if manager does not contains any actions. The list of all actions identifiers can be retrieved with the idList() function.

The method separator() allows creating a separator action which can be used in the menus or toolbars to separate logical groups of actions.

To enable/disable any action by its identifier, use setEnabled() method.

Member Typedef Documentation

◆ ActionMap

typedef QMap<int, ActionPtr> QtxActionMgr::ActionMap

private

Actions map.

◆ ActionPtr

typedef QPointer<QAction> QtxActionMgr::ActionPtr

private

Action guarded pointer.

Constructor & Destructor Documentation

◆ QtxActionMgr()

QtxActionMgr::QtxActionMgr ( QObject * parent )

Constructor.

Parameters

parent parent object

◆ ~QtxActionMgr()

QtxActionMgr::~QtxActionMgr ( )

virtual

Destructor.

Member Function Documentation

◆ action()

QAction * QtxActionMgr::action ( const int id ) const

Get action by specified identifier.

Parameters

id action ID

Returns: action (or 0 if id is invalid)

See also: actionId()

References contains(), and myActions.

◆ actionChanged()

void QtxActionMgr::actionChanged ( int )

protectedvirtual

Internal action changing response operation.

Reimplemented in QtxActionMenuMgr.

◆ actionId()

int QtxActionMgr::actionId ( const QAction * a ) const

Get action identifier.

Parameters

a action

Returns: action ID (or -1 if action is not found)

See also: action()

References myActions.

◆ contains()

bool QtxActionMgr::contains ( const int id ) const

Check if an action with given id is registered in the action manager.

Parameters

id action ID

Returns: true if internal map contains action with such identifier

References myActions.

◆ count()

int QtxActionMgr::count ( ) const

Get total number of registered actions.

Returns: number of actions in the internal map

See also: isEmpty()

References myActions.

◆ generateId()

int QtxActionMgr::generateId ( ) const

protected

Generate unique action identifier.

Returns: new ID

◆ idList()

QIntList QtxActionMgr::idList ( ) const

Get all registered actions identifiers.

Returns: list of actions identifiers

References myActions.

◆ internalUpdate()

void QtxActionMgr::internalUpdate ( )

protectedvirtual

Internal update.

This method is called by update() function and can be redefined in subclasses to customize update operation. Base implementation does nothing.

Reimplemented in QtxPopupMgr, QtxActionToolMgr, and QtxActionMenuMgr.

◆ isEmpty()

bool QtxActionMgr::isEmpty ( ) const

Check if there are no actions registered in the action manager.

Returns: true if internal map is empty

See also: count()

References myActions.

◆ isEnabled()

bool QtxActionMgr::isEnabled ( const int id ) const

virtual

Check is action with given id is enabled.

Parameters

id action ID

Returns: true if action is enabled

References action().

◆ isUpdatesEnabled()

bool QtxActionMgr::isUpdatesEnabled ( ) const

Check if update is enabled.

Returns: true if update is enabled

See also: setUpdatesEnabled(), update()

References myUpdate.

◆ isVisible()

bool QtxActionMgr::isVisible	(	const int	,
		const int
	)		const

virtual

Check if an action with actId identifier is visible to the parent action with place identifier.

This method can be redefined in subclasses. Base implementatin always returns true.

Parameters

actId	action ID
place	some parent action ID

Returns: true if an action is visible to the parent

See also: setVisible()

Reimplemented in QtxActionToolMgr, QtxActionMenuMgr, and QtxPopupMgr.

◆ onActionChanged

void QtxActionMgr::onActionChanged ( )

privateslot

Called when one of the registered actions changed.

Calls virtual method actionChanged() which can be redefined in the subclasses to customize reaction on this.

References actionChanged(), and actionId().

◆ onUpdateContent

void QtxActionMgr::onUpdateContent ( )

privateslot

Called when delayed update is performed (via timer event).

Calls virtual method updateContent() which can be redefined in the subclasses to customize the content update operation.

References updateContent().

◆ registerAction()

int QtxActionMgr::registerAction	(	QAction *	a,
		const int	userId = `-1`
	)

virtual

Register an action in the internal map.

If userId is less than 0, the identifier for the action is generated automatically. If action with given userId is already registered, it will be re-registered.

Parameters

a	action to be registered
userId	action ID

Returns: action ID (the same as userId or generated one)

See also: unRegisterAction()

References actionId(), contains(), generateId(), myActions, onActionChanged(), and unRegisterAction().

◆ separator()

QAction * QtxActionMgr::separator ( const bool own = false )

static

Create new separator action.

If own is true, then the caller is responsible for the action destroying. If own is false, new separator action will be owned by the action manager which will destroy it on application exit.

Parameters

own	ownership flag

Returns: new separator action

References qtx_separator_actions, and qtxSeparatorActionCleanup().

◆ setEnabled()

void QtxActionMgr::setEnabled	(	const int	id,
		const bool	enable
	)

virtual

Enable/disable action with given id.

Parameters

id	action ID
enable	new state

References action().

◆ setUpdatesEnabled()

void QtxActionMgr::setUpdatesEnabled ( const bool upd )

virtual

Enable/disable update operation.

Parameters

upd new state

See also: isUpdatesEnabled(), update()

References myUpdate.

◆ setVisible()

void QtxActionMgr::setVisible	(	const int	,
		const int	,
		const bool
	)

virtual

Set action's visibility flag.

This method can be redefined in subclasses. Base implementatin does nothing.

Parameters

actId	action ID
place	some parent action ID
v	new visibility state

See also: isVisible()

Reimplemented in QtxActionToolMgr, and QtxActionMenuMgr.

◆ triggerUpdate()

void QtxActionMgr::triggerUpdate ( )

protected

Perform delayed update.

Does nothing if update is disabled.

See also: isUpdatesEnabled(), setUpdatesEnabled(), update()

References isUpdatesEnabled(), myUpdTimer, and onUpdateContent().

◆ unRegisterAction()

void QtxActionMgr::unRegisterAction ( const int id )

virtual

Unregister action from internal map.

Parameters

id action ID

See also: registerAction()

Reimplemented in QtxPopupMgr.

References contains(), myActions, and onActionChanged().

◆ update()

void QtxActionMgr::update ( )

Update actions.

Calls virtual function internalUpdate to update the contents. Does nothing if update is disabled.

See also: setUpdatesEnabled(), isUpdatesEnabled(), internalUpdate()

References internalUpdate(), isUpdatesEnabled(), and myUpdTimer.

◆ updateContent()

void QtxActionMgr::updateContent ( )

protectedvirtual

Internal content update operation.

Called automatically by onUpdateContent() when the delayed update is triggered. Base implementation does nothing.

See also: triggerUpdate(), onUpdateContent()

Reimplemented in QtxActionToolMgr, and QtxActionMenuMgr.

Member Data Documentation

◆ myActions

ActionMap QtxActionMgr::myActions

private

actions map

◆ myUpdate

bool QtxActionMgr::myUpdate

private

update flag

◆ myUpdTimer

QTimer* QtxActionMgr::myUpdTimer

private

update timer

The documentation for this class was generated from the following files:

src/Qtx/QtxActionMgr.h
src/Qtx/QtxActionMgr.cxx

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Slots

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ActionMap

◆ ActionPtr

Constructor & Destructor Documentation

◆ QtxActionMgr()

◆ ~QtxActionMgr()

Member Function Documentation

◆ action()

◆ actionChanged()

◆ actionId()

◆ contains()

◆ count()

◆ generateId()

◆ idList()

◆ internalUpdate()

◆ isEmpty()

◆ isEnabled()

◆ isUpdatesEnabled()

◆ isVisible()

◆ onActionChanged

◆ onUpdateContent

◆ registerAction()

◆ separator()

◆ setEnabled()

◆ setUpdatesEnabled()

◆ setVisible()

◆ triggerUpdate()

◆ unRegisterAction()

◆ update()

◆ updateContent()

Member Data Documentation

◆ myActions

◆ myUpdate

◆ myUpdTimer