#include <AbstractActionsManager.h>

Inheritance diagram for hdps::AbstractActionsManager:

Signals
void	actionAdded (gui::WidgetAction *action)

void	actionAboutToBeRemoved (gui::WidgetAction *action)

void	actionRemoved (const QString &actionId)

void	publicActionAdded (gui::WidgetAction *publicAction)

void	publicActionAboutToBeRemoved (gui::WidgetAction *publicAction)

void	publicActionRemoved (const QString &publicActionId)

void	actionTypeAdded (const QString &actionType)

void	actionTypeRemoved (const QString &actionType)

void	actionTypesChanged (const QStringList &actionTypes)

void	actionTypesHumanFriendlyChanged (const QStringList &actionTypesHumanFriendly)

Signals inherited from hdps::AbstractManager
void	managerAboutToBeInitialized ()

void	managerInitialized ()

void	managerAboutToBeReset ()

void	managerReset ()

Public Member Functions
	AbstractActionsManager (QObject *parent=nullptr)

virtual const gui::WidgetActions &	getActions () const final

virtual const gui::WidgetActions &	getPublicActions () const final

virtual gui::WidgetAction *	getAction (const QString &id) final

template<typename ActionType >
void	addAction (ActionType *action)

template<typename ActionType >
void	removeAction (ActionType *action)

virtual bool	publishPrivateAction (gui::WidgetAction *privateAction, const QString &name="", bool recursive=true, bool allowDuplicateName=false)=0

virtual void	connectPrivateActionToPublicAction (gui::WidgetAction privateAction, gui::WidgetAction publicAction, bool recursive) final

virtual void	connectPrivateActions (gui::WidgetAction privateSourceAction, gui::WidgetAction privateTargetAction, const QString &publicActionName="") final

virtual void	disconnectPrivateActionFromPublicAction (gui::WidgetAction *privateAction, bool recursive) final

const QStringList	getActionTypes () const

const QStringList	getActionTypesHumanFriendly () const

Public Member Functions inherited from hdps::AbstractManager
	AbstractManager (QObject *parent=nullptr, const QString &name="")

virtual void	initialize ()

virtual void	beginReset () final

virtual void	reset ()=0

virtual void	endReset () final

virtual void	beginInitialization () final

virtual void	endInitialization () final

virtual bool	isInitialized () const final

virtual QIcon	getIcon () const

gui::LockingAction &	getLockingAction ()

virtual bool	mayLock () const

virtual bool	mayUnlock () const

Public Member Functions inherited from hdps::util::Serializable
	Serializable (const QString &serializationName="")

virtual QString	getId () const final

virtual void	setId (const QString &id) final

virtual QString	getSerializationName () const final

virtual void	setSerializationName (const QString &serializationName) final

virtual void	fromVariantMap (const QVariantMap &variantMap)

virtual void	fromParentVariantMap (const QVariantMap &parentVariantMap)

virtual QVariantMap	toVariantMap () const

virtual void	insertIntoVariantMap (QVariantMap &variantMap) const final

virtual void	fromJsonDocument (const QJsonDocument &jsonDocument) final

virtual QJsonDocument	toJsonDocument () const final

virtual void	fromJsonFile (const QString &filePath="") final

virtual void	toJsonFile (const QString &filePath="") final

virtual void	makeUnique () final

Protected Member Functions
virtual void	addPrivateActionToPublicAction (gui::WidgetAction privateAction, gui::WidgetAction publicAction) final

virtual void	removePrivateActionFromPublicAction (gui::WidgetAction privateAction, gui::WidgetAction publicAction) final

void	addActionType (const QString &actionType)

void	removeActionType (const QString &actionType)

virtual void	makeActionPublic (gui::WidgetAction *action) final

Protected Attributes
gui::WidgetActions	_actions

gui::WidgetActions	_publicActions

QMap< QString, ActionType >	_actionTypes

Friends
class	gui::WidgetAction

Additional Inherited Members
Public Types inherited from hdps::util::Serializable
enum class	State { Idle , Reading , Writing }

Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

Static Protected Member Functions inherited from hdps::util::Serializable
static void	fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)

static void	fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)

static QVariantMap	toVariantMap (const Serializable *serializable)

static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)

static void	insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)

Detailed Description

Abstract actions manager

Base abstract actions manager class for managing widget actions.

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ AbstractActionsManager()

hdps::AbstractActionsManager::AbstractActionsManager ( QObject * parent = nullptr )

inline

Construct actions manager with parent object

Parameters

parent Pointer to parent object

Member Function Documentation

◆ actionAboutToBeRemoved

void hdps::AbstractActionsManager::actionAboutToBeRemoved ( gui::WidgetAction * action )

signal

Signals that action is about to be removed from the manager

Parameters

action Pointer to action that is about to be removed from the manager

◆ actionAdded

void hdps::AbstractActionsManager::actionAdded ( gui::WidgetAction * action )

signal

Signals that action is added to the manager

Parameters

action Pointer to action that is added to the manager

◆ actionRemoved

void hdps::AbstractActionsManager::actionRemoved ( const QString & actionId )

signal

Signals that action with actionId was removed from the manager

Parameters

actionId Globally unique identifier of the action that was removed from the manager

◆ actionTypeAdded

void hdps::AbstractActionsManager::actionTypeAdded ( const QString & actionType )

signal

Signals that a new actionType has been added to the manager

Parameters

actionType Action type

◆ actionTypeRemoved

void hdps::AbstractActionsManager::actionTypeRemoved ( const QString & actionType )

signal

Signals that the last instance of actionType has been removed from the manager

Parameters

actionType Action type

◆ actionTypesChanged

void hdps::AbstractActionsManager::actionTypesChanged ( const QStringList & actionTypes )

signal

Signals that the actionTypes changed

Parameters

actionTypes Action types

◆ actionTypesHumanFriendlyChanged

void hdps::AbstractActionsManager::actionTypesHumanFriendlyChanged ( const QStringList & actionTypesHumanFriendly )

signal

Signals that the human-friendly actionTypes changed

Parameters

actionTypesHumanFriendly Human-friendly action types

◆ addAction()

template<typename ActionType >

void hdps::AbstractActionsManager::addAction ( ActionType * action )

inline

Add action of action type to the manager

Parameters

action Pointer to action

◆ addActionType()

void hdps::AbstractActionsManager::addActionType ( const QString & actionType )

inlineprotected

Add actionType string

Parameters

actionType Action type string to add

◆ addPrivateActionToPublicAction()

virtual void hdps::AbstractActionsManager::addPrivateActionToPublicAction	(	gui::WidgetAction *	privateAction,
		gui::WidgetAction *	publicAction
	)

inlinefinalprotectedvirtual

Add privateAction to the list of connected actions in the publicAction and notify listeners

Parameters

privateAction	Pointer to private action
publicAction	Pointer to public action

◆ connectPrivateActions()

virtual void hdps::AbstractActionsManager::connectPrivateActions	(	gui::WidgetAction *	privateSourceAction,
		gui::WidgetAction *	privateTargetAction,
		const QString &	publicActionName = `""`
	)

inlinefinalvirtual

Connect privateSourceAction to privateTargetAction

Parameters

privateSourceAction	Pointer to private source action
privateTargetAction	Pointer to private target action (private source action will be connected to published private target action)
publicActionName	Name of the public action (ask for name if empty)

◆ connectPrivateActionToPublicAction()

virtual void hdps::AbstractActionsManager::connectPrivateActionToPublicAction	(	gui::WidgetAction *	privateAction,
		gui::WidgetAction *	publicAction,
		bool	recursive
	)

inlinefinalvirtual

Connect privateAction to publicAction

Parameters

privateAction	Pointer to private action
publicAction	Pointer to public action
recursive	Whether to also connect descendant child actions

◆ disconnectPrivateActionFromPublicAction()

virtual void hdps::AbstractActionsManager::disconnectPrivateActionFromPublicAction	(	gui::WidgetAction *	privateAction,
		bool	recursive
	)

inlinefinalvirtual

Disconnect privateAction from public action

Parameters

privateAction	Pointer to private action
recursive	Whether to also disconnect descendant child actions

◆ getAction()

virtual gui::WidgetAction * hdps::AbstractActionsManager::getAction ( const QString & id )

inlinefinalvirtual

Get action with id

Returns: Pointer to widget action (may return nullptr)

◆ getActions()

virtual const gui::WidgetActions & hdps::AbstractActionsManager::getActions ( ) const

inlinefinalvirtual

Get all actions in the manager

Returns: List of all actions in the manager

◆ getActionTypes()

const QStringList hdps::AbstractActionsManager::getActionTypes ( ) const

inline

Get set of action types

Returns: List of action types

◆ getActionTypesHumanFriendly()

const QStringList hdps::AbstractActionsManager::getActionTypesHumanFriendly ( ) const

inline

Get set of human-friendly action types (without prefixes)

Returns: List of human-friendly action types

◆ getPublicActions()

virtual const gui::WidgetActions & hdps::AbstractActionsManager::getPublicActions ( ) const

inlinefinalvirtual

Get all public actions in the manager

Returns: List of all public actions in the manager

◆ makeActionPublic()

virtual void hdps::AbstractActionsManager::makeActionPublic ( gui::WidgetAction * action )

inlinefinalprotectedvirtual

Make widget action public

Parameters

action Pointer to action

◆ publicActionAboutToBeRemoved

void hdps::AbstractActionsManager::publicActionAboutToBeRemoved ( gui::WidgetAction * publicAction )

signal

Signals that publicAction is about to be removed from the manager

Parameters

action Pointer to public action that is about to be removed from the manager

◆ publicActionAdded

void hdps::AbstractActionsManager::publicActionAdded ( gui::WidgetAction * publicAction )

signal

Signals that publicAction is added to the manager

Parameters

action Pointer to public action that is added to the manager

◆ publicActionRemoved

void hdps::AbstractActionsManager::publicActionRemoved ( const QString & publicActionId )

signal

Signals that public action with publicActionId was removed from the manager

Parameters

publicActionId Globally unique identifier of the public action that was removed from the manager

◆ publishPrivateAction()

virtual bool hdps::AbstractActionsManager::publishPrivateAction	(	gui::WidgetAction *	privateAction,
		const QString &	name = `""`,
		bool	recursive = `true`,
		bool	allowDuplicateName = `false`
	)

pure virtual

Publish privateAction so that other private actions can connect to it

Parameters

privateAction	Pointer to private action to publish
name	Name of the published widget action (if empty, a name choosing dialog will popup)
recursive	Whether to also publish the child actions recursively
allowDuplicateName	Boolean determining whether publishing will take place when a public with the same name already exists in the public actions database

Returns: Boolean determining whether the action is successfully published or not

Implemented in hdps::ActionsManager.

◆ removeAction()

template<typename ActionType >

void hdps::AbstractActionsManager::removeAction ( ActionType * action )

inline

Remove action of action type from the manager

Parameters

action Pointer to action

◆ removeActionType()

void hdps::AbstractActionsManager::removeActionType ( const QString & actionType )

inlineprotected

Remove actionType string

Parameters

actionType Action type string to remove

◆ removePrivateActionFromPublicAction()

virtual void hdps::AbstractActionsManager::removePrivateActionFromPublicAction	(	gui::WidgetAction *	privateAction,
		gui::WidgetAction *	publicAction
	)

inlinefinalprotectedvirtual

Remove privateAction from the list of connected actions in the publicAction and notify listeners

Parameters

privateAction	Pointer to private action
publicAction	Pointer to public action

Friends And Related Symbol Documentation

◆ gui::WidgetAction

friend class gui::WidgetAction

friend

Maps action type to counter and human-friendly action type string

Member Data Documentation

◆ _actions

gui::WidgetActions hdps::AbstractActionsManager::_actions

protected

◆ _actionTypes

QMap<QString, ActionType> hdps::AbstractActionsManager::_actionTypes

protected

List of public actions that are instantiated in the plugin system

◆ _publicActions

gui::WidgetActions hdps::AbstractActionsManager::_publicActions

protected

List of actions that are instantiated in the plugin system

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

D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/AbstractActionsManager.h

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractActionsManager()

Member Function Documentation

◆ actionAboutToBeRemoved

◆ actionAdded

◆ actionRemoved

◆ actionTypeAdded

◆ actionTypeRemoved

◆ actionTypesChanged

◆ actionTypesHumanFriendlyChanged

◆ addAction()

◆ addActionType()

◆ addPrivateActionToPublicAction()

◆ connectPrivateActions()

◆ connectPrivateActionToPublicAction()

◆ disconnectPrivateActionFromPublicAction()

◆ getAction()

◆ getActions()

◆ getActionTypes()

◆ getActionTypesHumanFriendly()

◆ getPublicActions()

◆ makeActionPublic()

◆ publicActionAboutToBeRemoved

◆ publicActionAdded

◆ publicActionRemoved

◆ publishPrivateAction()

◆ removeAction()

◆ removeActionType()

◆ removePrivateActionFromPublicAction()

Friends And Related Symbol Documentation

◆ gui::WidgetAction

Member Data Documentation

◆ _actions

◆ _actionTypes

◆ _publicActions