hdps::gui::WidgetAction Class Reference

#include <WidgetAction.h>

Inheritance diagram for hdps::gui::WidgetAction:

Public Types
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
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)

Public Member Functions
	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

Static Public Attributes
static QMap< Scope, QString >	scopeNames

Protected Member Functions
virtual void	makePublic (bool recursive=true) final
virtual void	connectToPublicAction (WidgetAction *publicAction, bool recursive)
virtual void	connectToPublicActionByName (const QString &publicActionName) final
virtual void	disconnectFromPublicAction (bool recursive)
virtual QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags)

Friends
class	hdps::AbstractActionsManager

Additional Inherited Members
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

Widget action class

Base class for custom widget actions

Author

Thomas Kroes

Member Enumeration Documentation

ConfigurationFlag

enum class hdps::gui::WidgetAction::ConfigurationFlag

strong

Describes the configuration options

Enumerator
VisibleInMenu
InternalUseOnly	Whether the action may show itself in (context) menus
NoLabelInGroup	Action is only for internal use, it is not part of the graphical user interface
ForceCollapsedInGroup	Action will not have a label when it is displayed in a group
ForceExpandedInGroup	Action will be collapsed in a horizontal group (or toolbar), no matter the circumstances
User	Action will be expanded in a horizontal group (or toolbar), no matter the circumstances
Default	And beyond for custom configuration flags

ConnectionContextFlag

enum hdps::gui::WidgetAction::ConnectionContextFlag

‍** Describes the connection context options *‍/

Enumerator
Api
Gui	In the context of the API
ApiAndGui	In the context of the GUI

ConnectionPermissionFlag

enum class hdps::gui::WidgetAction::ConnectionPermissionFlag

strong

Describes the connection permission options

Enumerator
None
PublishViaApi	Widget may not published nor connect nor disconnect via API and GUI
PublishViaGui	Widget may be published via the API
PublishViaApiAndGui	Widget may be published via the GUI
ConnectViaApi	Widget may be published via the API and the GUI
ConnectViaGui	Widget may connect to a public action via the API
ConnectViaApiAndGui	Widget may connect to a public action via the GUI
DisconnectViaApi	Widget may connect to a public action via the API and the GUI
DisconnectViaGui	Widget may disconnect from a public action via the API
DisconnectViaApiAndGui	Widget may disconnect from a public action via the GUI
ForceNone	Widget may disconnect from a public action via the API and the GUI
All	Disables all connection options (API and GUI), regardless of other connection permission flags
Default

HighlightOption

enum class hdps::gui::WidgetAction::HighlightOption

strong

Describes the highlight options

Enumerator
None
Moderate	Action is not highlighted
Strong	Action is moderately highlighted Action is strongly highlighted

Scope

enum class hdps::gui::WidgetAction::Scope

strong

Describes the widget action scope of use

Enumerator
Private
Public	Action is in the private pool Action is in the public pool and eligible for connections

Constructor & Destructor Documentation

WidgetAction()

hdps::gui::WidgetAction::WidgetAction	(	QObject *	parent,
		const QString &	title
	)

Constructor

Parameters

parent	Pointer to parent object
title	Widget action title and serialization name

~WidgetAction()

hdps::gui::WidgetAction::~WidgetAction

(

)

Destructor

Member Function Documentation

actionConnected

void hdps::gui::WidgetAction::actionConnected ( WidgetAction *  action )

signal

Signals that an action connected

Parameters

action

Action that connected

actionDisconnected

void hdps::gui::WidgetAction::actionDisconnected ( WidgetAction *  action )

signal

Signals that an action disconnected

Parameters

action

Action that disconnected

cacheConnectionPermissions()

void hdps::gui::WidgetAction::cacheConnectionPermissions ( bool  recursive = false )

finalvirtual

Cache connection permissions

Parameters

recursive

Whether to recursively cache child connection permissions

cacheState()

void hdps::gui::WidgetAction::cacheState ( const QString &  name = "cache" )

finalvirtual

Cache the state of a widget action under name in the action itself (for global presets use the presets action)

Parameters

name	Name to use for the cached widget action state

configurationChanged

void hdps::gui::WidgetAction::configurationChanged ( std::int32_t  configuration )

signal

Signals that the configuration changed

Parameters

configuration

New configuration

configurationFlagToggled

void hdps::gui::WidgetAction::configurationFlagToggled ( const ConfigurationFlag &  configurationFlag, bool  set  )

signal

Signals that configurationFlag is set

Parameters

configurationFlag	Toggled configuration flag
set	Whether the flag was set or unset

connectionPermissionsChanged

void hdps::gui::WidgetAction::connectionPermissionsChanged ( std::int32_t  connectionPermissions )

signal

Signals that the connection permissions changed

Parameters

connectionPermissions

New connection permissions

connectToPublicAction()

void hdps::gui::WidgetAction::connectToPublicAction ( WidgetAction *  publicAction, bool  recursive  )

protectedvirtual

Connect this action to a public action

Parameters

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

Reimplemented in hdps::gui::ColorAction, hdps::gui::ColorMapAction, hdps::gui::ColorMapEditor1DAction, hdps::gui::ColorPickerAction, hdps::gui::DatasetPickerAction, hdps::gui::DecimalAction, hdps::gui::DecimalRangeAction, hdps::gui::DecimalRectangleAction, hdps::gui::IntegralAction, hdps::gui::IntegralRangeAction, hdps::gui::IntegralRectangleAction, hdps::gui::OptionAction, hdps::gui::OptionsAction, hdps::gui::PixelSelectionAction, hdps::gui::StretchAction, hdps::gui::StringAction, hdps::gui::StringsAction, hdps::gui::ToggleAction, hdps::gui::TriggerAction, hdps::gui::VariantAction, hdps::gui::WindowLevelAction, DimensionPickerAction, and DimensionsPickerAction.

connectToPublicActionByName()

void hdps::gui::WidgetAction::connectToPublicActionByName ( const QString &  publicActionName )

finalprotectedvirtual

Connect this action to a public action

Parameters

publicAction

Pointer to public action to connect to

createCollapsedWidget()

QWidget * hdps::gui::WidgetAction::createCollapsedWidget ( QWidget *  parent ) const

finalvirtual

Create collapsed widget

Parameters

parent

Parent widget

Returns

Pointer to collapsed widget

createLabelWidget()

QWidget * hdps::gui::WidgetAction::createLabelWidget ( QWidget *  parent, const std::int32_t &  widgetFlags = 0x00001  ) const

finalvirtual

Create label widget

Parameters

parent	Parent widget
widgetFlags	Label widget configuration flags

Returns

Pointer to widget

createWidget() [1/2]

QWidget * hdps::gui::WidgetAction::createWidget ( QWidget *  parent )

finaloverridevirtual

Create standard widget

Parameters

parent

Parent widget

Returns

Pointer to created widget

createWidget() [2/2]

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

Create widget for the action

Parameters

parent	Pointer to parent widget
widgetFlags	Widget flags

disconnectFromPublicAction()

void hdps::gui::WidgetAction::disconnectFromPublicAction ( bool  recursive )

protectedvirtual

Disconnect this action from its public action

Parameters

recursive

Whether to also disconnect descendant child actions

Reimplemented in hdps::gui::ColorAction, hdps::gui::ColorMapAction, hdps::gui::ColorMapEditor1DAction, hdps::gui::ColorPickerAction, hdps::gui::DatasetPickerAction, hdps::gui::DecimalAction, hdps::gui::DecimalRangeAction, hdps::gui::DecimalRectangleAction, hdps::gui::IntegralAction, hdps::gui::IntegralRangeAction, hdps::gui::IntegralRectangleAction, hdps::gui::OptionAction, hdps::gui::OptionsAction, hdps::gui::PixelSelectionAction, hdps::gui::StretchAction, hdps::gui::StringAction, hdps::gui::StringsAction, hdps::gui::ToggleAction, hdps::gui::TriggerAction, hdps::gui::VariantAction, hdps::gui::WindowLevelAction, DimensionPickerAction, and DimensionsPickerAction.

findChildren()

QVector< WidgetAction * > hdps::gui::WidgetAction::findChildren ( const QString &  searchString, bool  recursive = true  ) const

finalvirtual

Find child widget action of which the GUI name contains the search string

Parameters

searchString	The search string
recursive	Whether to search recursively

Returns

Found vector of pointers to widget action(s)

forceDisabledChanged

void hdps::gui::WidgetAction::forceDisabledChanged ( bool  forceDisabled )

signal

Signals that force disabled changed to forceDisabled

Parameters

forceDisabled

Boolean determining whether the widget action should be forcibly disabled (regardless of the enabled setting in the base QWidgetAction class)

forceHiddenChanged

void hdps::gui::WidgetAction::forceHiddenChanged ( bool  forceHidden )

signal

Signals that force hidden changed to forceHidden

Parameters

forceHidden

Boolean determining whether the widget action should be forcibly hidden (regardless of the visibility setting in the base QWidgetAction class)

fromVariantMap()

void hdps::gui::WidgetAction::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load widget action from variant map

Parameters

Variant

map representation of the widget action

Reimplemented from hdps::util::Serializable.

Reimplemented in hdps::gui::WindowLevelAction.

getChildren()

WidgetActions hdps::gui::WidgetAction::getChildren ( ) const

finalvirtual

Get child actions

Returns

Vector of pointers to child actions

getConfiguration()

std::int32_t hdps::gui::WidgetAction::getConfiguration ( ) const

finalvirtual

Get configuration

Returns

Configuration

getConnectedActions() [1/2]

const WidgetActions hdps::gui::WidgetAction::getConnectedActions ( ) const

finalvirtual

Get connected actions

Returns

Vector of pointers to connected actions

getConnectedActions() [2/2]

WidgetActions & hdps::gui::WidgetAction::getConnectedActions ( )

finalvirtual

Get connected actions

Returns

Vector of pointers to connected actions

getConnectionPermissions()

std::int32_t hdps::gui::WidgetAction::getConnectionPermissions ( ) const

finalvirtual

Get connection permission flags

Returns

Connection permission flags

getContextMenu()

QMenu * hdps::gui::WidgetAction::getContextMenu ( QWidget *  parent = nullptr )

virtual

Get the context menu for the action

Parameters

parent

Parent widget

Returns

Context menu

Reimplemented in hdps::DataHierarchyItem, and hdps::DatasetImpl.

getDefaultWidgetFlags()

std::int32_t hdps::gui::WidgetAction::getDefaultWidgetFlags ( ) const

finalvirtual

Gets the default widget flags

getForceDisabled()

bool hdps::gui::WidgetAction::getForceDisabled ( ) const

finalvirtual

Get force disabled

Returns

Boolean determining whether the widget action should be forcibly disabled (regardless of the enabled setting in the base QWidgetAction class)

getForceHidden()

bool hdps::gui::WidgetAction::getForceHidden ( ) const

finalvirtual

Get force hidden

Returns

Boolean determining whether the widget action should be forcibly hidden (regardless of the visibility setting in the base QWidgetAction class)

getHighlighting()

WidgetAction::HighlightOption hdps::gui::WidgetAction::getHighlighting ( ) const

finalvirtual

Get highlighting

Returns

Highlight option

getLocation()

QString hdps::gui::WidgetAction::getLocation ( ) const

virtual

Get location

Returns

Path relative to the top-level action

Reimplemented in hdps::DatasetImpl.

getParentAction()

WidgetAction * hdps::gui::WidgetAction::getParentAction ( ) const

finalvirtual

Get parent widget action

Returns

Pointer to parent widget action (if any)

getParentActions()

WidgetActions hdps::gui::WidgetAction::getParentActions ( ) const

finalvirtual

Get parent widget actions

Returns

Pointer to parent widget actions

getPopupSizeHint()

QSize hdps::gui::WidgetAction::getPopupSizeHint ( ) const

finalvirtual

Get size hint of popups (in case of collapsed actions)

Returns

Popup size hint

getPublicAction()

WidgetAction * hdps::gui::WidgetAction::getPublicAction ( )

finalvirtual

Get the public action to which the action is connected

Returns

Pointer to the public action (returns nullptr if not connected to a public action)

getPublicCopy()

WidgetAction * hdps::gui::WidgetAction::getPublicCopy ( ) const

finalvirtual

Get public copy of the action (other compatible actions can connect to it)

Returns

Pointer to public copy of the action

Reimplemented in hdps::gui::ProjectSplashScreenAction.

getScope()

WidgetAction::Scope hdps::gui::WidgetAction::getScope ( ) const

finalvirtual

Get widget action scope

Returns

Widget action scope enum

getSettingsPrefix()

QString hdps::gui::WidgetAction::getSettingsPrefix ( ) const

virtual

Get settings prefix

Returns

Settings prefix

Reimplemented in hdps::GlobalSettingsGroupAction.

getSortIndex()

std::int32_t hdps::gui::WidgetAction::getSortIndex ( ) const

finalvirtual

Get the sort index

getStretch()

std::int32_t hdps::gui::WidgetAction::getStretch ( ) const

finalvirtual

Get stretch

Returns

The stretch factor

getTypeString()

QString hdps::gui::WidgetAction::getTypeString ( bool  humanFriendly = false ) const

finalvirtual

Get type string

Parameters

humanFriendly

Whether to return a type string where the namespace is omitted

Returns

Widget action type in string format

getWidget()

QWidget * hdps::gui::WidgetAction::getWidget ( QWidget *  parent, const std::int32_t &  widgetFlags  )

protectedvirtual

Get widget representation of the action

Parameters

parent	Pointer to parent widget
widgetFlags	Widget flags for the configuration of the widget (type)

Reimplemented in hdps::gui::ColorAction, hdps::gui::ColorMapAction, hdps::gui::ColorMapAxisAction, hdps::gui::ColorMapDiscreteAction, hdps::gui::ColorMapEditor1DAction, hdps::gui::ColorMapEditor1DNodeAction, hdps::gui::ColorMapSettings1DAction, hdps::gui::ColorMapSettings2DAction, hdps::gui::ColorMapSettingsAction, hdps::gui::ColorMapViewAction, hdps::gui::ColorPickerAction, hdps::gui::DecimalAction, hdps::gui::DecimalRangeAction, hdps::gui::DirectoryPickerAction, hdps::gui::FilePickerAction, hdps::gui::GroupAction, hdps::gui::GroupsAction, hdps::gui::HorizontalToolbarAction, hdps::gui::ImageAction, hdps::gui::IntegralAction, hdps::gui::IntegralRangeAction, hdps::gui::OptionAction, hdps::gui::OptionsAction, hdps::gui::OptionsAction::SelectionAction, hdps::gui::OptionsAction::FileAction, hdps::gui::PluginTriggerPickerAction, hdps::gui::RectangleAction< RectangleType, NumericalRangeActionType >, hdps::gui::RectangleAction< QRect, IntegralRangeAction >, hdps::gui::RectangleAction< QRectF, DecimalRangeAction >, hdps::gui::ProjectSplashScreenAction, hdps::gui::StatusAction, hdps::gui::StringAction, hdps::gui::StringsAction, hdps::gui::ToggleAction, hdps::gui::TriggerAction, hdps::gui::TriggersAction, hdps::gui::VerticalToolbarAction, ClustersAction, ColorizeClustersAction, FilterClustersAction, PrefixClustersAction, SelectClustersAction, SubsetAction, CreateSetFromSelectionAction, DimensionPickerAction, DimensionsPickerAction, hdps::gui::DimensionsPickerFilterAction, hdps::gui::DimensionsPickerMiscellaneousAction, hdps::gui::DimensionsPickerSelectAction, EditProxyDatasetsAction, NumberOfSelectedPointsAction, ProxyDatasetsAction, and SelectedIndicesAction.

highlight()

void hdps::gui::WidgetAction::highlight ( )

finalvirtual

Convenience method to highlight the action

highlightingChanged

void hdps::gui::WidgetAction::highlightingChanged ( const HighlightOption &  highlightOption )

signal

Signals that the highlighting options changed to highlightOption

Parameters

highlightOption

Current highlight option

idChanged

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

signal

Signals that the globally unique identifier changed (only happens upon de-serialization of a widget action)

Parameters

id	Globally unique identifier that changed

isConfigurationFlagSet()

bool hdps::gui::WidgetAction::isConfigurationFlagSet ( ConfigurationFlag  configurationFlag ) const

finalvirtual

Check whether configurationFlag is set or not

Parameters

configurationFlag

Configuration flag

Returns

Boolean determining whether configurationFlag is set or not

isConnected()

bool hdps::gui::WidgetAction::isConnected ( ) const

finalvirtual

Get whether the action is connect to a public action

Returns

Boolean indicating whether the action is connect to a public action

isConnectedChanged

void hdps::gui::WidgetAction::isConnectedChanged ( const bool &  isConnected )

signal

Signals that the connected state changed

Parameters

isConnected

Whether the action is connected or not

isConnectionPermissionFlagSet()

bool hdps::gui::WidgetAction::isConnectionPermissionFlagSet ( ConnectionPermissionFlag  connectionPermissionsFlag )

finalvirtual

Check whether connectionPermissionsFlag is set or not

Parameters

connectionPermissionsFlag

Connection permissions flag

Returns

Boolean determining whether connectionPermissionsFlag is set or not

isEnabled()

bool hdps::gui::WidgetAction::isEnabled ( ) const

finalvirtual

Re-implement the isEnabled() getter from the base QWidgetAction class to support the force disabled functionality

Returns

Boolean determining whether the widget action is enabled or not

isHighlighted()

bool hdps::gui::WidgetAction::isHighlighted ( ) const

finalvirtual

Determine whether the action is in a highlighted state or not

Returns

Boolean determining whether the action is in a highlighted state or not

isLeaf()

bool hdps::gui::WidgetAction::isLeaf ( ) const

finalvirtual

Establish whether this action is positioned at the bottom of the hierarchy

Returns

Boolean determining whether this action is positioned at the bottom of the hierarchy

isPrivate()

bool hdps::gui::WidgetAction::isPrivate ( ) const

finalvirtual

Get whether this action is in the private actions pool

Returns

Boolean determining whether this action is in the private actions pool

isPublic()

bool hdps::gui::WidgetAction::isPublic ( ) const

finalvirtual

Get whether this action is in the public actions pool

Returns

Boolean determining whether this action is in the private public pool

isPublished()

bool hdps::gui::WidgetAction::isPublished ( ) const

finalvirtual

Get whether the action is published

Returns

Boolean indicating whether the action is published

isPublishedChanged

void hdps::gui::WidgetAction::isPublishedChanged ( const bool &  isPublished )

signal

Signals that the published state changed

Parameters

isPublished

Whether the action is published or not

isResettable()

bool hdps::gui::WidgetAction::isResettable ( ) const

finalvirtual

Determines whether the action can be reset to its default

Returns

Whether the action can be reset to its default

isRoot()

bool hdps::gui::WidgetAction::isRoot ( ) const

finalvirtual

Establish whether this action is positioned at the top of the hierarchy

Returns

Boolean determining whether this action is positioned at the top of the hierarchy

isVisible()

bool hdps::gui::WidgetAction::isVisible ( ) const

finalvirtual

Re-implement the isVisible() getter from the base QWidgetAction class to support the force hidden functionality

Returns

Boolean determining whether the widget action is visible or not

loadFromSettings()

void hdps::gui::WidgetAction::loadFromSettings ( )

finalvirtual

Load from settings (if the settings prefix is set)

locationChanged

void hdps::gui::WidgetAction::locationChanged ( const QString &  location )

signal

Signals that the location changed to location

Parameters

location

The path relative to the root in string format

makePublic()

void hdps::gui::WidgetAction::makePublic ( bool  recursive = true )

finalprotectedvirtual

Make widget action public (and possibly all of its descendant widget actions)

Parameters

recursive

Whether to also make all descendant widget actions public

mayConnect()

bool hdps::gui::WidgetAction::mayConnect ( ConnectionContextFlag  connectionContextFlags ) const

finalvirtual

Get whether this action may connect to a public action, depending on the connectionContextFlags

Parameters

connectionContextFlags

The context from which the connection will be made (API and/or GUI)

Returns

Boolean determining whether this action may connect to a public action, depending on the connectionContextFlags

mayConnectToPublicAction()

bool hdps::gui::WidgetAction::mayConnectToPublicAction ( const WidgetAction *  publicAction ) const

finalvirtual

Get whether the action may connect to publicAction

Parameters

publicAction

Pointer to public action

Returns

Boolean determining whether the action may connect to publicAction

mayDisconnect()

bool hdps::gui::WidgetAction::mayDisconnect ( ConnectionContextFlag  connectionContextFlags ) const

finalvirtual

Get whether this action may disconnect from a public action, depending on the connectionContextFlags

Parameters

connectionContextFlags

The context from which the disconnection will be initiated (API and/or GUI)

Returns

Boolean determining whether this action may disconnect from a public action, depending on the connectionContextFlags

mayPublish()

bool hdps::gui::WidgetAction::mayPublish ( ConnectionContextFlag  connectionContextFlags ) const

finalvirtual

Get whether a copy of this action may be published and shared, depending on the connectionContextFlags

Parameters

connectionContextFlags

The context from which the action will be published (API and/or GUI)

Returns

Boolean determining whether a copy of this action may published and shared, depending on the connectionContextFlags

publish()

bool hdps::gui::WidgetAction::publish ( const QString &  name = "", bool  allowDuplicateName = false  )

finalvirtual

Publish this action so that other actions can connect to it

Parameters

name	Name of the published widget action (if empty, a configuration dialog will popup)
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

reset()

void hdps::gui::WidgetAction::reset ( )

finalvirtual

Reset to default

restoreConnectionPermissions()

void hdps::gui::WidgetAction::restoreConnectionPermissions ( bool  recursive = false )

finalvirtual

Restore connection permissions

Parameters

recursive

Whether to recursively restore child connection permissions

restoreState()

void hdps::gui::WidgetAction::restoreState ( const QString &  name = "cache", bool  remove = true  )

finalvirtual

Restore the state of under name

Parameters

name	Name of the cached widget action state to restore
remove	Whether to remove the cache

saveToSettings()

void hdps::gui::WidgetAction::saveToSettings ( )

finalvirtual

Save to settings (if the settings prefix is set)

scopeChanged

void hdps::gui::WidgetAction::scopeChanged ( const Scope &  scope )

signal

Signals that the scope changed to scope

Parameters

scope

Scope of the widget action

setConfiguration()

void hdps::gui::WidgetAction::setConfiguration ( std::int32_t  configuration, bool  recursive = false  )

finalvirtual

Set configuration

Parameters

configuration	Configuration value
recursive	Whether to recursively set child child configuration flag

setConfigurationFlag()

void hdps::gui::WidgetAction::setConfigurationFlag ( ConfigurationFlag  configurationFlag, bool  unset = false, bool  recursive = false  )

finalvirtual

Set configuration flag

Parameters

configurationFlag	Configuration flag to set
unset	Whether to unset the configurationFlag flag
recursive	Whether to recursively set child child configuration flag

setConnectionPermissions()

void hdps::gui::WidgetAction::setConnectionPermissions ( std::int32_t  connectionPermissions, bool  recursive = false  )

finalvirtual

Set connection permissions

Parameters

connectionPermissions	Connection permissions value
recursive	Whether to recursively set child connection permissions

setConnectionPermissionsFlag()

void hdps::gui::WidgetAction::setConnectionPermissionsFlag ( ConnectionPermissionFlag  connectionPermissionsFlag, bool  unset = false, bool  recursive = false  )

finalvirtual

Set connection permissions flag

Parameters

connectionPermissionsFlag	Connection permissions flag to set
unset	Whether to unset the connection permissions flag
recursive	Whether to recursively set child connection permissions

setConnectionPermissionsToAll()

void hdps::gui::WidgetAction::setConnectionPermissionsToAll ( bool  recursive = false )

finalvirtual

Set connection permissions to all

Parameters

recursive

Whether to recursively set child connection permissions

setConnectionPermissionsToForceNone()

void hdps::gui::WidgetAction::setConnectionPermissionsToForceNone ( bool  recursive = false )

finalvirtual

Set connection permissions to force none (connections fully disabled, regardless of other connection permission flags)

Parameters

recursive

Whether to recursively set child connection permissions

setConnectionPermissionsToNone()

void hdps::gui::WidgetAction::setConnectionPermissionsToNone ( bool  recursive = false )

finalvirtual

Reset connection permissions to none

Parameters

recursive

Whether to recursively set child connection permissions

setDefaultWidgetFlag()

void hdps::gui::WidgetAction::setDefaultWidgetFlag ( const std::int32_t &  widgetFlags, bool  unset = false  )

finalvirtual

Set the widget flags

Parameters

widgetFlags	Widget flags
unset	Whether to unset the default widget flag

setDefaultWidgetFlags()

void hdps::gui::WidgetAction::setDefaultWidgetFlags ( const std::int32_t &  widgetFlags )

finalvirtual

Set the widget flags

Parameters

widgetFlags

Widget flags

setForceDisabled()

void hdps::gui::WidgetAction::setForceDisabled ( bool  forceDisabled )

finalvirtual

Set force disabled to forceDisabled

Parameters

forceDisabled

Boolean determining whether the widget action should be forcibly disabled (regardless of the enabled setting in the base QWidgetAction class)

setForceHidden()

void hdps::gui::WidgetAction::setForceHidden ( bool  forceHidden )

finalvirtual

Set force hidden to forceHidden

Parameters

forceHidden

Boolean determining whether the widget action should be forcibly hidden (regardless of the enabled visibility in the base QWidgetAction class)

setHighlighted()

void hdps::gui::WidgetAction::setHighlighted ( bool  highlighted )

finalvirtual

Set highlighted to highlighted

Parameters

highlighted

Boolean determining whether the action is in a normal highlighted state or not

setHighlighting()

void hdps::gui::WidgetAction::setHighlighting ( const HighlightOption &  highlighting )

finalvirtual

Set highlighting to highlighting

Parameters

highlighting

Highlighting state

setPopupSizeHint()

void hdps::gui::WidgetAction::setPopupSizeHint ( const QSize &  popupSizeHint )

finalvirtual

Set size hint of popups (in case of collapsed actions)

Parameters

popupSizeHint

Popup size hint

setSettingsPrefix() [1/2]

void hdps::gui::WidgetAction::setSettingsPrefix ( const QString &  settingsPrefix, const bool &  load = true  )

finalvirtual

Set settings prefix

Parameters

load	Whether to restore settings after setting the prefix
settingsPrefix	Settings prefix

setSettingsPrefix() [2/2]

void hdps::gui::WidgetAction::setSettingsPrefix ( plugin::Plugin *  plugin, const QString &  settingsPrefix, const bool &  load = true  )

finalvirtual

Set settings prefix in the context of a plugin (the combined settings prefix will be: Plugins/PluginKind/SettingsPrefix)

Parameters

load	Whether to restore settings after setting the prefix
plugin	Pointer to plugin context
settingsPrefix	Settings prefix

setSortIndex()

void hdps::gui::WidgetAction::setSortIndex ( const std::int32_t &  sortIndex )

finalvirtual

Set the sort index

Parameters

sortIndex

Sorting index

setStretch()

void hdps::gui::WidgetAction::setStretch ( const std::int32_t &  stretch )

finalvirtual

Set stretch to stretch

Parameters

stretch

Stretch factor

setStudioMode()

void hdps::gui::WidgetAction::setStudioMode ( bool  studioMode, bool  recursive = true  )

finalvirtual

Set studio mode to studioMode

Parameters

studioMode	Boolean determining whether studio mode is on or off
recursive	Boolean determining whether to also apply the studio mode to child actions recursively

setText()

void hdps::gui::WidgetAction::setText

(

const QString &

text

)

Re-implement the setText(...) setter from the base QWidgetAction class to support updating the location

Parameters

text	Text to set

sortIndexChanged

void hdps::gui::WidgetAction::sortIndexChanged ( std::int32_t  sortIndex )

signal

Signals that the sort index changed to sortIndex

Parameters

sortIndex

Sort index (relative position in group items)

startDrag()

void hdps::gui::WidgetAction::startDrag ( )

finalvirtual

Start drag process

stretchChanged

void hdps::gui::WidgetAction::stretchChanged ( std::int32_t  stretch )

signal

Signals that the stretch changed to stretch

Parameters

stretch

Stretch factor (in action groups)

textChanged

void hdps::gui::WidgetAction::textChanged ( const QString &  text )

signal

Signals that the text changed to text

Parameters

text	Action text

toVariantMap()

QVariantMap hdps::gui::WidgetAction::toVariantMap ( ) const

overridevirtual

Save widget action to variant map

Returns

Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

Reimplemented in hdps::gui::WindowLevelAction.

unHighlight()

void hdps::gui::WidgetAction::unHighlight ( )

finalvirtual

Convenience method to un-highlight the action

Friends And Related Symbol Documentation

hdps::AbstractActionsManager

friend class hdps::AbstractActionsManager

friend

The path relative to the root in string format

Member Data Documentation

scopeNames

QMap< WidgetAction::Scope, QString > hdps::gui::WidgetAction::scopeNames

static

Initial value:

{
    { WidgetAction::Scope::Private, "Private" },
    { WidgetAction::Scope::Public, "Public" }
}

Map scope enum to scope name

---

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

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