#include <GroupsAction.h>

Inheritance diagram for hdps::gui::GroupsAction:

Classes
class	TreeWidget

class	Widget

Public Types
enum	WidgetFlag { Filtering = 0x00001 , Expansion = 0x00002 , Default = Filtering \| Expansion }

using	GroupActions = QVector< GroupAction * >

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	groupActionAdded (GroupAction *groupAction)

void	groupActionRemoved (GroupAction *groupAction)

void	groupActionExpanded (GroupAction *groupAction)

void	groupActionCollapsed (GroupAction *groupAction)

void	groupActionShown (GroupAction *groupAction)

void	groupActionHidden (GroupAction *groupAction)

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
QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags) override

Q_INVOKABLE	GroupsAction (QObject *parent, const QString &title)

	~GroupsAction ()

void	addGroupAction (GroupAction *groupAction, bool visible=true)

void	removeGroupAction (GroupAction *groupAction)

void	setGroupActions (const GroupActions &groupActions)

void	resetGroupActions ()

const GroupActions &	getGroupActions () const

bool	canExpandAll () const

void	expandAll ()

bool	canCollapseAll () const

void	collapseAll ()

QVector< bool >	getExpansions (bool visibleOnly=true) const

std::int32_t	getNumberOfExpandedGroupActions (bool visibleOnly=true) const

std::int32_t	getNumberOfVisibleGroupActions () const

void	setGroupActionVisibility (GroupAction *groupAction, bool visible)

void	showGroupAction (GroupAction *groupAction)

void	showAllGroupActions ()

void	hideGroupAction (GroupAction *groupAction)

void	hideAllGroupActions ()

bool	isGroupActionVisible (GroupAction *groupAction) const

bool	isGroupActionHidden (GroupAction *groupAction) const

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 Attributes
GroupActions	_groupActions

QMap< GroupAction *, bool >	_visibility

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

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

Groups action class

Contains a list of group actions and displays them in an accordion widget

Author: Thomas Kroes

Member Typedef Documentation

◆ GroupActions

using hdps::gui::GroupsAction::GroupActions = QVector<GroupAction*>

Member Enumeration Documentation

◆ WidgetFlag

enum hdps::gui::GroupsAction::WidgetFlag

Describes the widget configurations

Enumerator
Filtering
Expansion	Widget contains UI for filtering group actions
Default	Widget contains UI to expand/collapse all actions

Constructor & Destructor Documentation

◆ GroupsAction()

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

Constructor

Parameters

parent	Pointer to parent object
title	Title of the groups action

◆ ~GroupsAction()

hdps::gui::GroupsAction::~GroupsAction ( )

Member Function Documentation

◆ addGroupAction()

void hdps::gui::GroupsAction::addGroupAction	(	GroupAction *	groupAction,
		bool	visible = `true`
	)

Appends a group action

Parameters

groupAction	Group action to add
visible	Whether the group action is visible or not

◆ canCollapseAll()

bool hdps::gui::GroupsAction::canCollapseAll ( ) const

Get whether one (or more) groups can be expanded

Returns: Whether one (or more) groups can be expanded

◆ canExpandAll()

bool hdps::gui::GroupsAction::canExpandAll ( ) const

Get whether one (or more) groups can be expanded

Returns: Whether one (or more) groups can be expanded

◆ collapseAll()

void hdps::gui::GroupsAction::collapseAll ( )

Collapse all group actions

◆ expandAll()

void hdps::gui::GroupsAction::expandAll ( )

Expand all group actions

◆ getExpansions()

QVector< bool > hdps::gui::GroupsAction::getExpansions ( bool visibleOnly = true ) const

Get groups expansion states

Parameters

visibleOnly Visible group actions only

Returns: Vector of booleans, indicating whether a group is expanded or collapsed

◆ getGroupActions()

const GroupsAction::GroupActions & hdps::gui::GroupsAction::getGroupActions ( ) const

Get group actions

◆ getNumberOfExpandedGroupActions()

std::int32_t hdps::gui::GroupsAction::getNumberOfExpandedGroupActions ( bool visibleOnly = true ) const

Get number of expanded group actions

Parameters

visibleOnly Visible group actions only

Returns: Number of expanded group actions

◆ getNumberOfVisibleGroupActions()

std::int32_t hdps::gui::GroupsAction::getNumberOfVisibleGroupActions ( ) const

Get number of visible group actions

Returns: Number of visible group actions

◆ getWidget()

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

inlineoverridevirtual

Get widget representation of the groups action

Parameters

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

Reimplemented from hdps::gui::WidgetAction.

◆ groupActionAdded

void hdps::gui::GroupsAction::groupActionAdded ( GroupAction * groupAction )

signal

Signals that a group action was added

Parameters

groupAction Group action that was added

◆ groupActionCollapsed

void hdps::gui::GroupsAction::groupActionCollapsed ( GroupAction * groupAction )

signal

Signals that a group action got collapsed

Parameters

groupAction Group action that got collapsed

◆ groupActionExpanded

void hdps::gui::GroupsAction::groupActionExpanded ( GroupAction * groupAction )

signal

Signals that a group action got expanded

Parameters

groupAction Group action that got expanded

◆ groupActionHidden

void hdps::gui::GroupsAction::groupActionHidden ( GroupAction * groupAction )

signal

Signals that a group action got hidden

Parameters

groupAction Group action that got hidden

◆ groupActionRemoved

void hdps::gui::GroupsAction::groupActionRemoved ( GroupAction * groupAction )

signal

Signals that a group action was removed

Parameters

groupAction Group action that was removed

◆ groupActionShown

void hdps::gui::GroupsAction::groupActionShown ( GroupAction * groupAction )

signal

Signals that a group action got shown

Parameters

groupAction Group action that got shown

◆ hideAllGroupActions()

void hdps::gui::GroupsAction::hideAllGroupActions ( )

Hide all group actions

◆ hideGroupAction()

void hdps::gui::GroupsAction::hideGroupAction ( GroupAction * groupAction )

Hide group action

Parameters

groupAction Pointer to group action

◆ isGroupActionHidden()

bool hdps::gui::GroupsAction::isGroupActionHidden ( GroupAction * groupAction ) const

Get whether the group action is hidden

Returns: Whether the group action is hidden

◆ isGroupActionVisible()

bool hdps::gui::GroupsAction::isGroupActionVisible ( GroupAction * groupAction ) const

Get whether the group action is visible

Returns: Whether the group action is visible

◆ removeGroupAction()

void hdps::gui::GroupsAction::removeGroupAction ( GroupAction * groupAction )

Removes a group action

Parameters

groupAction Group action to remove

◆ resetGroupActions()

void hdps::gui::GroupsAction::resetGroupActions ( )

Reset group actions to default

◆ setGroupActions()

void hdps::gui::GroupsAction::setGroupActions ( const GroupActions & groupActions )

Set group actions (overwrites existing group actions)

Parameters

groupActions Vector of pointers to group actions

◆ setGroupActionVisibility()

void hdps::gui::GroupsAction::setGroupActionVisibility	(	GroupAction *	groupAction,
		bool	visible
	)

Hide group action

Parameters

groupAction	Pointer to group action
visible	Whether the group action is visible

◆ showAllGroupActions()

void hdps::gui::GroupsAction::showAllGroupActions ( )

Hide all group actions

◆ showGroupAction()

void hdps::gui::GroupsAction::showGroupAction ( GroupAction * groupAction )

Show group action

Parameters

groupAction Pointer to group action

Member Data Documentation

◆ _groupActions

GroupActions hdps::gui::GroupsAction::_groupActions

protected

◆ _visibility

QMap<GroupAction*, bool> hdps::gui::GroupsAction::_visibility

protected

Pointers to group actions

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

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

Classes

Public Types

Signals

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ GroupActions

Member Enumeration Documentation

◆ WidgetFlag

Constructor & Destructor Documentation

◆ GroupsAction()

◆ ~GroupsAction()

Member Function Documentation

◆ addGroupAction()

◆ canCollapseAll()

◆ canExpandAll()

◆ collapseAll()

◆ expandAll()

◆ getExpansions()

◆ getGroupActions()

◆ getNumberOfExpandedGroupActions()

◆ getNumberOfVisibleGroupActions()

◆ getWidget()

◆ groupActionAdded

◆ groupActionCollapsed

◆ groupActionExpanded

◆ groupActionHidden

◆ groupActionRemoved

◆ groupActionShown

◆ hideAllGroupActions()

◆ hideGroupAction()

◆ isGroupActionHidden()

◆ isGroupActionVisible()

◆ removeGroupAction()

◆ resetGroupActions()

◆ setGroupActions()

◆ setGroupActionVisibility()

◆ showAllGroupActions()

◆ showGroupAction()

Member Data Documentation

◆ _groupActions

◆ _visibility