#include <PluginTriggerAction.h>

Inheritance diagram for hdps::gui::PluginTriggerAction:

Public Member Functions
Q_INVOKABLE	PluginTriggerAction (QObject parent, const plugin::PluginFactory pluginFactory, const QString &title, const QString &tooltip, const QIcon &icon)

Q_INVOKABLE	PluginTriggerAction (QObject parent, const plugin::PluginFactory pluginFactory, const QString &title, const QString &tooltip, const QIcon &icon, RequestPluginCallback requestPluginCallback)

Q_INVOKABLE	PluginTriggerAction (const PluginTriggerAction &pluginTriggerAction, const QString &title)

const plugin::PluginFactory *	getPluginFactory () const

QString	getMenuLocation () const

void	setMenuLocation (const QString &menuLocation)

QString	getSha () const

WidgetAction *	getConfigurationAction ()

void	setConfigurationAction (WidgetAction *configurationAction)

void	setText (const QString &text)

void	setRequestPluginCallback (RequestPluginCallback requestPluginCallback)

Public Member Functions inherited from hdps::gui::TriggerAction
Q_INVOKABLE	TriggerAction (QObject *parent, const QString &title)

Public Member Functions inherited from hdps::gui::WidgetAction
	WidgetAction (QObject *parent, const QString &title)

	~WidgetAction ()

virtual WidgetAction *	getParentAction () const final

virtual WidgetActions	getParentActions () const final

virtual WidgetActions	getChildren () const final

virtual bool	isRoot () const final

virtual bool	isLeaf () const final

virtual QWidget *	createWidget (QWidget *parent) override final

virtual QWidget *	createCollapsedWidget (QWidget *parent) const final

virtual QWidget *	createLabelWidget (QWidget *parent, const std::int32_t &widgetFlags=0x00001) const final

virtual QMenu *	getContextMenu (QWidget *parent=nullptr)

QWidget *	createWidget (QWidget *parent, const std::int32_t &widgetFlags)

virtual std::int32_t	getSortIndex () const final

virtual void	setSortIndex (const std::int32_t &sortIndex) final

virtual std::int32_t	getStretch () const final

virtual void	setStretch (const std::int32_t &stretch) final

virtual bool	getForceHidden () const final

virtual void	setForceHidden (bool forceHidden) final

virtual bool	isVisible () const final

virtual bool	getForceDisabled () const final

virtual void	setForceDisabled (bool forceDisabled) final

virtual bool	isEnabled () const final

void	setText (const QString &text)

virtual QString	getLocation () const

virtual std::int32_t	getDefaultWidgetFlags () const final

virtual void	setDefaultWidgetFlags (const std::int32_t &widgetFlags) final

virtual void	setDefaultWidgetFlag (const std::int32_t &widgetFlags, bool unset=false) final

virtual HighlightOption	getHighlighting () const final

virtual bool	isHighlighted () const final

virtual void	setHighlighting (const HighlightOption &highlighting) final

virtual void	setHighlighted (bool highlighted) final

virtual void	highlight () final

virtual void	unHighlight () final

virtual Scope	getScope () const final

virtual bool	isPrivate () const final

virtual bool	isPublic () const final

virtual bool	isPublished () const final

virtual bool	isConnected () const final

virtual bool	mayConnectToPublicAction (const WidgetAction *publicAction) const final

virtual bool	publish (const QString &name="", bool allowDuplicateName=false) final

virtual WidgetAction *	getPublicAction () final

virtual WidgetAction *	getPublicCopy () const final

virtual const WidgetActions	getConnectedActions () const final

virtual WidgetActions &	getConnectedActions () final

virtual bool	mayPublish (ConnectionContextFlag connectionContextFlags) const final

virtual bool	mayConnect (ConnectionContextFlag connectionContextFlags) const final

virtual bool	mayDisconnect (ConnectionContextFlag connectionContextFlags) const final

virtual std::int32_t	getConnectionPermissions () const final

virtual bool	isConnectionPermissionFlagSet (ConnectionPermissionFlag connectionPermissionsFlag) final

virtual void	setConnectionPermissionsFlag (ConnectionPermissionFlag connectionPermissionsFlag, bool unset=false, bool recursive=false) final

virtual void	setConnectionPermissions (std::int32_t connectionPermissions, bool recursive=false) final

virtual void	setConnectionPermissionsToNone (bool recursive=false) final

virtual void	setConnectionPermissionsToForceNone (bool recursive=false) final

virtual void	setConnectionPermissionsToAll (bool recursive=false) final

virtual void	cacheConnectionPermissions (bool recursive=false) final

virtual void	restoreConnectionPermissions (bool recursive=false) final

virtual void	startDrag () final

virtual bool	isResettable () const final

virtual void	reset () final

virtual void	setSettingsPrefix (const QString &settingsPrefix, const bool &load=true) final

virtual void	setSettingsPrefix (plugin::Plugin *plugin, const QString &settingsPrefix, const bool &load=true) final

virtual QString	getSettingsPrefix () const

virtual void	loadFromSettings () final

virtual void	saveToSettings () final

virtual QVector< WidgetAction * >	findChildren (const QString &searchString, bool recursive=true) const final

virtual QSize	getPopupSizeHint () const final

virtual void	setPopupSizeHint (const QSize &popupSizeHint) final

virtual std::int32_t	getConfiguration () const final

virtual bool	isConfigurationFlagSet (ConfigurationFlag configurationFlag) const final

virtual void	setConfigurationFlag (ConfigurationFlag configurationFlag, bool unset=false, bool recursive=false) final

virtual void	setConfiguration (std::int32_t configuration, bool recursive=false) final

virtual QString	getTypeString (bool humanFriendly=false) const final

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

virtual void	cacheState (const QString &name="cache") final

virtual void	restoreState (const QString &name="cache", bool remove=true) final

virtual void	setStudioMode (bool studioMode, bool recursive=true) final

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	fromParentVariantMap (const QVariantMap &parentVariantMap)

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	initialize ()

Protected Member Functions inherited from hdps::gui::TriggerAction
QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags) override

void	connectToPublicAction (WidgetAction *publicAction, bool recursive) override

void	disconnectFromPublicAction (bool recursive) override

Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final

virtual void	connectToPublicActionByName (const QString &publicActionName) final

Friends
class	plugin::PluginFactory

Additional Inherited Members
Public Types inherited from hdps::gui::TriggerAction
enum	WidgetFlag { Icon = 0x00001 , Text = 0x00002 , IconText = Icon \| Text }

Public Types inherited from hdps::gui::WidgetAction
enum class	Scope { Private , Public }

enum class	HighlightOption { None , Moderate , Strong }

enum class	ConfigurationFlag { VisibleInMenu = 0x00001 , InternalUseOnly = 0x00002 , NoLabelInGroup = 0x00004 , ForceCollapsedInGroup = 0x00008 , ForceExpandedInGroup = 0x00010 , User = 0x00100 , Default = 0 }

enum	ConnectionContextFlag { Api = 0x00008 , Gui = 0x00010 , ApiAndGui = Api \| Gui }
	‍** Describes the connection context options *‍/ More...

enum class	ConnectionPermissionFlag { None = 0x00000 , PublishViaApi = 0x00001 , PublishViaGui = 0x00002 , PublishViaApiAndGui = PublishViaApi \| PublishViaGui , ConnectViaApi = 0x00008 , ConnectViaGui = 0x00010 , ConnectViaApiAndGui = ConnectViaApi \| ConnectViaGui , DisconnectViaApi = 0x00040 , DisconnectViaGui = 0x00080 , DisconnectViaApiAndGui = DisconnectViaApi \| DisconnectViaGui , ForceNone = 0x00100 , All = PublishViaApiAndGui \| ConnectViaApiAndGui \| DisconnectViaApiAndGui , Default = All }

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

Signals inherited from hdps::gui::WidgetAction
void	idChanged (const QString &id)

void	sortIndexChanged (std::int32_t sortIndex)

void	stretchChanged (std::int32_t stretch)

void	forceHiddenChanged (bool forceHidden)

void	forceDisabledChanged (bool forceDisabled)

void	highlightingChanged (const HighlightOption &highlightOption)

void	isPublishedChanged (const bool &isPublished)

void	isConnectedChanged (const bool &isConnected)

void	actionConnected (WidgetAction *action)

void	actionDisconnected (WidgetAction *action)

void	connectionPermissionsChanged (std::int32_t connectionPermissions)

void	configurationFlagToggled (const ConfigurationFlag &configurationFlag, bool set)

void	configurationChanged (std::int32_t configuration)

void	scopeChanged (const Scope &scope)

void	textChanged (const QString &text)

void	locationChanged (const QString &location)

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

Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString >	scopeNames

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

Plugin trigger action class

Action class for triggering the creation of plugins.

By default, a plugin is automatically created when the trigger action is triggered. Custom plugin creation is possible by setting a creation handler function, see setCreatePluginFunction()

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ PluginTriggerAction() [1/3]

hdps::gui::PluginTriggerAction::PluginTriggerAction	(	QObject *	parent,
		const plugin::PluginFactory *	pluginFactory,
		const QString &	title,
		const QString &	tooltip,
		const QIcon &	icon
	)

Constructor

Parameters

parent	Pointer to parent object
pluginFactory	Pointer to plugin factory
title	Title of the plugin trigger action
icon	Icon
tooltip	Tooltip of the plugin trigger action

◆ PluginTriggerAction() [2/3]

hdps::gui::PluginTriggerAction::PluginTriggerAction	(	QObject *	parent,
		const plugin::PluginFactory *	pluginFactory,
		const QString &	title,
		const QString &	tooltip,
		const QIcon &	icon,
		RequestPluginCallback	requestPluginCallback
	)

Constructor

Parameters

parent	Pointer to parent object
pluginFactory	Pointer to plugin factory
title	Title of the plugin trigger action
tooltip	Tooltip of the plugin trigger action
icon	Icon
requestPluginCallback	Callback which is invoked when the trigger action is triggered

◆ PluginTriggerAction() [3/3]

hdps::gui::PluginTriggerAction::PluginTriggerAction	(	const PluginTriggerAction &	pluginTriggerAction,
		const QString &	title
	)

Copy constructor

Parameters

pluginTriggerAction Reference to other plugin trigger action

Member Function Documentation

◆ getConfigurationAction()

WidgetAction * hdps::gui::PluginTriggerAction::getConfigurationAction ( )

Get configuration action

Returns: Action for configuring the plugin creation (if available)

◆ getMenuLocation()

QString hdps::gui::PluginTriggerAction::getMenuLocation ( ) const

Get menu location of the plugin trigger action

Returns: Location of the plugin trigger action in a menu

◆ getPluginFactory()

const hdps::plugin::PluginFactory * hdps::gui::PluginTriggerAction::getPluginFactory ( ) const

Get the plugin factory

Returns: Pointer to the plugin factory

◆ getSha()

QString hdps::gui::PluginTriggerAction::getSha ( ) const

Get sha of plugin kind + trigger title

Returns: Sha

◆ initialize()

void hdps::gui::PluginTriggerAction::initialize ( )

protectedvirtual

Sets up the trigger action

◆ setConfigurationAction()

void hdps::gui::PluginTriggerAction::setConfigurationAction ( WidgetAction * configurationAction )

Set configuration action

Parameters

configurationAction Pointer to action for configuring the plugin creation

◆ setMenuLocation()

void hdps::gui::PluginTriggerAction::setMenuLocation ( const QString & menuLocation )

Set menu location of the plugin trigger action

Parameters

location Location of the plugin trigger action in a menu

◆ setRequestPluginCallback()

void hdps::gui::PluginTriggerAction::setRequestPluginCallback ( RequestPluginCallback requestPluginCallback )

Set the callback function which is invoked when the trigger action is triggered

Parameters

requestPluginCallback Request plugin callback function (invoked when the trigger action is triggered)

◆ setText()

void hdps::gui::PluginTriggerAction::setText ( const QString & text )

Override base class to also update location

Parameters

text	Action text

Friends And Related Symbol Documentation

◆ plugin::PluginFactory

friend class plugin::PluginFactory

friend

Request plugin callback function which should create the plugin (invoked when the trigger action is triggered)

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

D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/actions/PluginTriggerAction.h
D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/actions/PluginTriggerAction.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PluginTriggerAction() [1/3]

◆ PluginTriggerAction() [2/3]

◆ PluginTriggerAction() [3/3]

Member Function Documentation

◆ getConfigurationAction()

◆ getMenuLocation()

◆ getPluginFactory()

◆ getSha()

◆ initialize()

◆ setConfigurationAction()

◆ setMenuLocation()

◆ setRequestPluginCallback()

◆ setText()

Friends And Related Symbol Documentation

◆ plugin::PluginFactory