hdps::gui::OptionAction Class Reference

#include <OptionAction.h>

Inheritance diagram for hdps::gui::OptionAction:

Classes
class	ButtonsWidget
class	ComboBoxWidget
class	LineEditWidget

Public Types
enum	WidgetFlag {   ComboBox = 0x00001 , LineEdit = 0x00002 , HorizontalButtons = 0x00004 , VerticalButtons = 0x00008 ,   Clearable = 0x00010 , 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	modelChanged ()
void	customModelChanged (QAbstractItemModel *customModel)
void	currentIndexChanged (const std::int32_t &currentIndex)
void	currentTextChanged (const QString &currentText)
void	placeholderStringChanged (const QString &placeholderString)
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	OptionAction (QObject *parent, const QString &title="", const QStringList &options=QStringList(), const QString &currentOption="")
void	initialize (const QStringList &options=QStringList(), const QString &currentOption="")
void	initialize (QAbstractItemModel &customModel, const QString &currentOption="", const QString &defaultOption="")
QStringList	getOptions () const
std::uint32_t	getNumberOfOptions () const
bool	hasOption (const QString &option) const
bool	hasOptions () const
void	setOptions (const QStringList &options)
void	setCustomModel (QAbstractItemModel *itemModel)
bool	hasCustomModel () const
std::int32_t	getCurrentIndex () const
void	setCurrentIndex (const std::int32_t &currentIndex)
QString	getCurrentText () const
void	setCurrentText (const QString &currentText)
QString	getPlaceholderString () const
void	setPlaceHolderString (const QString &placeholderString)
bool	hasSelection () const
const QAbstractItemModel *	getModel () const
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
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
void	updateCurrentIndex ()
Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final
virtual void	connectToPublicActionByName (const QString &publicActionName) final

Protected Attributes
QStringListModel	_defaultModel
QAbstractItemModel *	_customModel
std::int32_t	_currentIndex
QString	_placeholderString

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

Option widget action class

Stores options and creates widgets to interact with these

Author

Thomas Kroes

Member Enumeration Documentation

WidgetFlag

enum hdps::gui::OptionAction::WidgetFlag

Describes the widget flags

Enumerator
ComboBox
LineEdit	The widget includes a combobox widget
HorizontalButtons	The widget includes a searchable line edit widget
VerticalButtons	The widget includes a push button for each option in a horizontal layout
Clearable	The widget includes a push button for each option in a vertical layout
Default	The widget includes a push button to clear the selection (current index is set to minus one)

Constructor & Destructor Documentation

OptionAction()

hdps::gui::OptionAction::OptionAction ( QObject *  parent, const QString &  title = "", const QStringList &  options = QStringList(), const QString &  currentOption = ""  )

explicit

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
options	Options
currentOption	Current option

Member Function Documentation

connectToPublicAction()

void hdps::gui::OptionAction::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.

currentIndexChanged

void hdps::gui::OptionAction::currentIndexChanged ( const std::int32_t &  currentIndex )

signal

Signals that the current index changed

Parameters

currentIndex

Current index

currentTextChanged

void hdps::gui::OptionAction::currentTextChanged ( const QString &  currentText )

signal

Signals that the current text changed

Parameters

currentText

Current text

customModelChanged

void hdps::gui::OptionAction::customModelChanged ( QAbstractItemModel *  customModel )

signal

Signals that the custom model changed

Parameters

customModel

Custom model

disconnectFromPublicAction()

void hdps::gui::OptionAction::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::OptionAction::fromVariantMap ( const QVariantMap &  variantMap )

overridevirtual

Load widget action from variant map

Parameters

Variant

map representation of the widget action

Reimplemented from hdps::util::Serializable.

getCurrentIndex()

std::int32_t hdps::gui::OptionAction::getCurrentIndex

(

)

const

Get the current option index

getCurrentText()

QString hdps::gui::OptionAction::getCurrentText

(

)

const

Get the current option index

getModel()

const QAbstractItemModel * hdps::gui::OptionAction::getModel

(

)

const

Get the used item model

getNumberOfOptions()

std::uint32_t hdps::gui::OptionAction::getNumberOfOptions

(

)

const

Get the number of options

getOptions()

QStringList hdps::gui::OptionAction::getOptions

(

)

const

Get the options

getPlaceholderString()

QString hdps::gui::OptionAction::getPlaceholderString

(

)

const

Get placeholder text (shown when no option selected)

getWidget()

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

overrideprotectedvirtual

Get widget representation of the option action

Parameters

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

Reimplemented from hdps::gui::WidgetAction.

hasCustomModel()

bool hdps::gui::OptionAction::hasCustomModel

(

)

const

Determines whether the option action has a custom item model

hasOption()

bool hdps::gui::OptionAction::hasOption

(

const QString &

option

)

const

Determines whether an option exists

hasOptions()

bool hdps::gui::OptionAction::hasOptions

(

)

const

Determines whether there are any options

hasSelection()

bool hdps::gui::OptionAction::hasSelection

(

)

const

Determines whether an option has been selected

initialize() [1/2]

void hdps::gui::OptionAction::initialize	(	const QStringList &	options = QStringList(),
		const QString &	currentOption = ""
	)

Initialize the option action

Parameters

options	Options
currentOption	Current option
defaultOption	Default option

initialize() [2/2]

void hdps::gui::OptionAction::initialize	(	QAbstractItemModel &	customModel,
		const QString &	currentOption = "",
		const QString &	defaultOption = ""
	)

Initialize the option action with a custom model

Parameters

customModel	Pointer to custom model
currentOption	Current option
defaultOption	Default option

modelChanged

void hdps::gui::OptionAction::modelChanged ( )

signal

Signals that the model changed

placeholderStringChanged

void hdps::gui::OptionAction::placeholderStringChanged ( const QString &  placeholderString )

signal

Signals that the placeholder string changed

Parameters

placeholderString

Placeholder string that changed

setCurrentIndex()

void hdps::gui::OptionAction::setCurrentIndex

(

const std::int32_t &

currentIndex

)

Set the current option index

Parameters

currentIndex

Current option index

setCurrentText()

void hdps::gui::OptionAction::setCurrentText

(

const QString &

currentText

)

Set the current option text

Parameters

currentText

Current option text

setCustomModel()

void hdps::gui::OptionAction::setCustomModel

(

QAbstractItemModel *

itemModel

)

Set a custom item model for more advanced display of options

Parameters

itemModel

Pointer to custom item model

setOptions()

void hdps::gui::OptionAction::setOptions

(

const QStringList &

options

)

Set the options

Parameters

options

Options

setPlaceHolderString()

void hdps::gui::OptionAction::setPlaceHolderString

(

const QString &

placeholderString

)

Set placeholder text (shown when no option selected)

Parameters

placeholderText

Placeholder text

toVariantMap()

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

overridevirtual

Save widget action to variant map

Returns

Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

updateCurrentIndex()

void hdps::gui::OptionAction::updateCurrentIndex ( )

protected

Friends And Related Symbol Documentation

AbstractActionsManager

friend class AbstractActionsManager

friend

Place holder string

Member Data Documentation

_currentIndex

std::int32_t hdps::gui::OptionAction::_currentIndex

protected

Custom item model for enriched (combobox) ui

_customModel

QAbstractItemModel* hdps::gui::OptionAction::_customModel

protected

Default simple string list model

_defaultModel

QStringListModel hdps::gui::OptionAction::_defaultModel

protected

_placeholderString

QString hdps::gui::OptionAction::_placeholderString

protected

Currently selected index

---

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

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