#include <OptionsAction.h>

Inheritance diagram for hdps::gui::OptionsAction:

Classes
class	ComboBoxWidget

class	FileAction

class	SelectionAction

Public Types
enum	WidgetFlag { ComboBox = 0x00001 , Selection = 0x00004 , File = 0x00008 , Default = ComboBox }

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
void	optionsChanged (const QStringList &options)

void	selectedOptionsChanged (const QStringList &selectedOptions)

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)

Public Member Functions
Q_INVOKABLE	OptionsAction (QObject *parent, const QString &title="", const QStringList &options=QStringList(), const QStringList &selectedOptions=QStringList())

void	initialize (const QStringList &options=QStringList(), const QStringList &selectedOptions=QStringList())

QStringList	getOptions () const

const QStandardItemModel &	getOptionsModel () const

std::uint32_t	getNumberOfOptions () const

bool	hasOption (const QString &option) const

bool	hasOptions () const

void	setOptions (const QStringList &options, bool clearSelection=false)

QStringList	getSelectedOptions () const

QList< int >	getSelectedOptionIndices () const

bool	isOptionSelected (const QString &option) const

bool	hasSelectedOptions () const

void	selectOption (const QString &option, const bool &replaceSelection=false)

void	setSelectedOptions (const QStringList &selectedOptions)

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

SelectionAction &	getSelectionAction ()

FileAction &	getFileAction ()

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
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

Protected Attributes
QStandardItemModel	_optionsModel

SelectionAction	_selectionAction

FileAction	_fileAction

Friends
class	AbstractActionsManager

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

Options widget action class

Action for selecting multiple options at once

Author: Thomas Kroes

Member Enumeration Documentation

◆ WidgetFlag

enum hdps::gui::OptionsAction::WidgetFlag

Describes the widget flags

Enumerator
ComboBox
Selection	The widget includes a combobox widget
File	The widget includes a selection control
Default	The widget includes a file control

Constructor & Destructor Documentation

◆ OptionsAction()

hdps::gui::OptionsAction::OptionsAction	(	QObject *	parent,
		const QString &	title = `""`,
		const QStringList &	options = `QStringList()`,
		const QStringList &	selectedOptions = `QStringList()`
	)

explicit

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
options	Options to select from
selectedOptions	Initial selected options

Member Function Documentation

◆ connectToPublicAction()

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

overrideprotectedvirtual

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 from hdps::gui::WidgetAction.

◆ disconnectFromPublicAction()

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

overrideprotectedvirtual

Disconnect this action from its public action

Parameters

recursive Whether to also disconnect descendant child actions

Reimplemented from hdps::gui::WidgetAction.

◆ fromVariantMap()

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

overridevirtual

Load widget action from variant map

Parameters

Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getFileAction()

FileAction & hdps::gui::OptionsAction::getFileAction ( )

inline

◆ getNumberOfOptions()

std::uint32_t hdps::gui::OptionsAction::getNumberOfOptions ( ) const

Get the number of options

Returns: Number of options

◆ getOptions()

QStringList hdps::gui::OptionsAction::getOptions ( ) const

Get available options

Returns: Available options

◆ getOptionsModel()

const QStandardItemModel & hdps::gui::OptionsAction::getOptionsModel ( ) const

Get options model

Returns: Options model

◆ getSelectedOptionIndices()

QList< int > hdps::gui::OptionsAction::getSelectedOptionIndices ( ) const

Get selected option indices

Returns: Selected options indices

◆ getSelectedOptions()

QStringList hdps::gui::OptionsAction::getSelectedOptions ( ) const

Get selected options

Returns: Selected options

◆ getSelectionAction()

SelectionAction & hdps::gui::OptionsAction::getSelectionAction ( )

inline

◆ getWidget()

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

overrideprotectedvirtual

Get widget representation of the options action

Parameters

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

Reimplemented from hdps::gui::WidgetAction.

◆ hasOption()

bool hdps::gui::OptionsAction::hasOption ( const QString & option ) const

Get whether a specific option exists

Parameters

option Name of the option to check for

Returns: Boolean indicating whether a specific option exists

◆ hasOptions()

bool hdps::gui::OptionsAction::hasOptions ( ) const

Get whether there are any options

Returns: Boolean indicating whether there are any options

◆ hasSelectedOptions()

bool hdps::gui::OptionsAction::hasSelectedOptions ( ) const

Get whether one or more options are selected

Returns: Boolean indicating whether one or more options are selected

◆ initialize()

void hdps::gui::OptionsAction::initialize	(	const QStringList &	options = `QStringList()`,
		const QStringList &	selectedOptions = `QStringList()`
	)

Initialize the option action

Parameters

options	Options to select from
selectedOptions	Initial selected options

◆ isOptionSelected()

bool hdps::gui::OptionsAction::isOptionSelected ( const QString & option ) const

Get whether a specific option is selected

Parameters

option Name of the option to check for

Returns: Boolean indicating whether the option is selected or not

◆ optionsChanged

void hdps::gui::OptionsAction::optionsChanged ( const QStringList & options )

signal

Signals that the options changed

Parameters

options Options

◆ selectedOptionsChanged

void hdps::gui::OptionsAction::selectedOptionsChanged ( const QStringList & selectedOptions )

signal

Signals that the selected options changed

Parameters

selectedOptions Selected options

◆ selectOption()

void hdps::gui::OptionsAction::selectOption	(	const QString &	option,
		const bool &	replaceSelection = `false`
	)

Select option

Parameters

option	Option to select
replaceSelection	Whether to clear the current option selection

◆ setOptions()

void hdps::gui::OptionsAction::setOptions	(	const QStringList &	options,
		bool	clearSelection = `false`
	)

Set the available options

Parameters

options	Available Options
clearSelection	Whether to clear the current selection

◆ setSelectedOptions()

void hdps::gui::OptionsAction::setSelectedOptions ( const QStringList & selectedOptions )

Set the selected options

Parameters

selectedOptions Selected options

◆ toVariantMap()

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

overridevirtual

Save widget action to variant map

Returns: Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

Friends And Related Symbol Documentation

◆ AbstractActionsManager

friend class AbstractActionsManager

friend

File action

Member Data Documentation

◆ _fileAction

FileAction hdps::gui::OptionsAction::_fileAction

protected

Selection action

◆ _optionsModel

QStandardItemModel hdps::gui::OptionsAction::_optionsModel

protected

◆ _selectionAction

SelectionAction hdps::gui::OptionsAction::_selectionAction

protected

Options model

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

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

Classes

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ WidgetFlag

Constructor & Destructor Documentation

◆ OptionsAction()

Member Function Documentation

◆ connectToPublicAction()

◆ disconnectFromPublicAction()

◆ fromVariantMap()

◆ getFileAction()

◆ getNumberOfOptions()

◆ getOptions()

◆ getOptionsModel()

◆ getSelectedOptionIndices()

◆ getSelectedOptions()

◆ getSelectionAction()

◆ getWidget()

◆ hasOption()

◆ hasOptions()

◆ hasSelectedOptions()

◆ initialize()

◆ isOptionSelected()

◆ optionsChanged

◆ selectedOptionsChanged

◆ selectOption()

◆ setOptions()

◆ setSelectedOptions()

◆ toVariantMap()

Friends And Related Symbol Documentation

◆ AbstractActionsManager

Member Data Documentation

◆ _fileAction

◆ _optionsModel

◆ _selectionAction