#include <LockingAction.h>

Inheritance diagram for hdps::gui::LockingAction:

Signals
void	lockedChanged (bool locked)

Signals inherited from hdps::gui::GroupAction
void	actionsChanged (const WidgetActions &actions)

void	expanded ()

void	collapsed ()

void	readOnlyChanged (const bool &readOnly)

void	showLabelsChanged (const bool &showLabels)

void	labelSizingTypeChanged (const LabelSizingType &labelSizingType)

void	labelWidthPercentageChanged (const std::uint32_t &labelWidthPercentage)

void	labelWidthFixedChanged (const std::uint32_t &labelWidthFixed)

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	LockingAction (QObject *parent, const QString &what="", bool locked=false)

void	initialize (bool locked=false)

QString	getWhat () const

void	setWhat (QString what)

bool	isLocked () const

void	setLocked (bool locked)

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

gui::ToggleAction &	getLockedAction ()

gui::TriggerAction &	getLockAction ()

gui::TriggerAction &	getUnlockAction ()

Public Member Functions inherited from hdps::gui::GroupAction
Q_INVOKABLE	GroupAction (QObject *parent, const QString &title, const bool &expanded=false, const Qt::AlignmentFlag &alignment=Qt::AlignmentFlag::AlignLeft)

virtual Qt::AlignmentFlag	getAlignment () const final

void	setExpanded (const bool &expanded)

void	expand ()

void	collapse ()

void	toggle ()

bool	isExpanded () const

bool	isCollapsed () const

bool	isReadOnly () const

void	setReadOnly (const bool &readOnly)

bool	getShowLabels () const

void	setShowLabels (bool showLabels)

StretchAction *	addStretch (std::int32_t stretch=1)

virtual void	addAction (WidgetAction *action, std::int32_t widgetFlags=-1) final

virtual void	removeAction (WidgetAction *action) final

virtual void	clear () final

virtual WidgetActions	getActions () final

virtual ConstWidgetActions	getConstActions () final

WidgetFlagsMap	getWidgetFlagsMap ()

LabelSizingType	getLabelSizingType () const

void	setLabelSizingType (const LabelSizingType &labelSizingType)

std::uint32_t	getLabelWidthPercentage () const

void	setLabelWidthPercentage (std::uint32_t labelWidthPercentage)

std::uint32_t	getLabelWidthFixed () const

void	setLabelWidthFixed (std::uint32_t labelWidthFixed)

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

Additional Inherited Members
Public Types inherited from hdps::gui::GroupAction
enum	WidgetFlag { Horizontal = 0x00001 , Vertical = 0x00002 , NoMargins = 0x00010 , WithMargins = 0x00020 , Default = Horizontal }

enum class	LabelSizingType { Auto , Percentage , Fixed }

using	WidgetFlagsMap = QMap< const WidgetAction *, std::int32_t >

using	WidgetFlagsList = QList< std::int32_t >

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 }

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

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

Protected Member Functions inherited from hdps::gui::WidgetAction
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)

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

Locked action class

Action class for locking status (internal use only).

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ LockingAction()

hdps::gui::LockingAction::LockingAction	(	QObject *	parent,
		const QString &	what = `""`,
		bool	locked = `false`
	)

Constructor

Parameters

parent	Pointer to parent object
what	What is to be locked
locked	Locked

Member Function Documentation

◆ fromVariantMap()

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

overridevirtual

Load locked action from variant map

Parameters

Variant map representation of the locked action

Reimplemented from hdps::gui::GroupAction.

◆ getLockAction()

gui::TriggerAction & hdps::gui::LockingAction::getLockAction ( )

inline

◆ getLockedAction()

gui::ToggleAction & hdps::gui::LockingAction::getLockedAction ( )

inline

◆ getUnlockAction()

gui::TriggerAction & hdps::gui::LockingAction::getUnlockAction ( )

inline

◆ getWhat()

QString hdps::gui::LockingAction::getWhat ( ) const

Get what

Returns: What is locked

◆ initialize()

void hdps::gui::LockingAction::initialize ( bool locked = false )

Initialize the toggle action

Parameters

locked Locked

◆ isLocked()

bool hdps::gui::LockingAction::isLocked ( ) const

Get locked status

Returns: Boolean determining the locked status

◆ lockedChanged

void hdps::gui::LockingAction::lockedChanged ( bool locked )

signal

Signals that the locked status changed

Parameters

locked Locked status

◆ setLocked()

void hdps::gui::LockingAction::setLocked ( bool locked )

Set locked status to locked

Parameters

locked Boolean determining the locked status

◆ setWhat()

void hdps::gui::LockingAction::setWhat ( QString what )

Set what to whatB

Parameters

what	What is locked

◆ toVariantMap()

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

overridevirtual

Save locked action to variant map

Returns: Variant map representation of the locked action

Reimplemented from hdps::gui::GroupAction.

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

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

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LockingAction()

Member Function Documentation

◆ fromVariantMap()

◆ getLockAction()

◆ getLockedAction()

◆ getUnlockAction()

◆ getWhat()

◆ initialize()

◆ isLocked()

◆ lockedChanged

◆ setLocked()

◆ setWhat()

◆ toVariantMap()