#include <PresetsAction.h>

Inheritance diagram for hdps::gui::PresetsAction:

Classes
class	ChoosePresetNameDialog

class	FilterModel

class	ManagePresetsDialog

Public Types
enum class	Column { Name , DateTime }

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	presetAboutToBeLoaded (const QString &name)

void	presetLoaded (const QString &name)

void	presetSaved (const QString &name)

void	presetAboutToBeRemoved (const QString &name)

void	presetRemoved (const QString &name)

void	presetImported (const QString &filePath)

void	presetExported (const QString &filePath)

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	PresetsAction (QObject parent, WidgetAction sourceAction, const QString &settingsKey="", const QString &presetType="", const QIcon &icon=QIcon())

QString	getSettingsKey () const

QString	getPresetType () const

QIcon	getIcon () const

void	setIcon (const QIcon &icon)

QStandardItemModel &	getModel ()

const FilterModel &	getFilterModel () const

TriggerAction &	getEditAction ()

const QVariantMap &	getPresets () const

void	loadPresetsFromApplicationSettings ()

void	savePresetsToApplicationSettings ()

QMenu *	getMenu (QWidget *parent=nullptr)

void	loadPreset (const QString &name)

void	savePreset (const QString &name)

void	removePreset (const QString &name)

void	removePresets (const QStringList &names)

void	loadDefaultPreset ()

void	saveDefaultPreset ()

void	importPreset ()

void	exportPreset ()

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

Static Public Attributes
static QMap< Column, QPair< QString, QString > >	columnInfo

Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString >	scopeNames

Additional Inherited Members
Static Public Member Functions inherited from hdps::util::Serializable
static QString	createId ()

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)

virtual QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags)

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

Presets action class

Action class for interacting with widget action presets.

This action allows you to manage the presets for a particular widget action. More precisely it allows to:

Save the widget action state to application settings
Load the widget action state from application settings
Save widget action default preset to application settings
Load widget action default preset from application settings
Export widget action state to preset file
Import widget action state from preset file
Manage presets for the widget action (remove presets etc.)

Author: Thomas Kroes

Member Enumeration Documentation

◆ Column

enum class hdps::gui::PresetsAction::Column

strong

Model columns

Enumerator
Name
DateTime	Name of the preset Date and time when the preset was created

Constructor & Destructor Documentation

◆ PresetsAction()

hdps::gui::PresetsAction::PresetsAction	(	QObject *	parent,
		WidgetAction *	sourceAction,
		const QString &	settingsKey = `""`,
		const QString &	presetType = `""`,
		const QIcon &	icon = `QIcon()`
	)

Constructor

Parameters

parent	Pointer to parent object
sourceAction	Non-owning pointer to widget action of which to save presets
settingsKey	Settings key where the presets are stored
presetType	Type of preset
icon	Icon in menu

Member Function Documentation

◆ exportPreset()

void hdps::gui::PresetsAction::exportPreset ( )

Export preset to file

◆ getEditAction()

TriggerAction & hdps::gui::PresetsAction::getEditAction ( )

Get edit action

Returns: Action which triggers a dialog in which the recent file paths can be edited

◆ getFilterModel()

const PresetsAction::FilterModel & hdps::gui::PresetsAction::getFilterModel ( ) const

Get filter model

Returns: Reference to filter model

◆ getIcon()

QIcon hdps::gui::PresetsAction::getIcon ( ) const

Get icon

Returns: Icon for the preset type

◆ getMenu()

QMenu * hdps::gui::PresetsAction::getMenu ( QWidget * parent = nullptr )

Get recent file paths menu

Returns: Pointer to menu

◆ getModel()

QStandardItemModel & hdps::gui::PresetsAction::getModel ( )

Get model

Returns: Reference to model

◆ getPresets()

const QVariantMap & hdps::gui::PresetsAction::getPresets ( ) const

Get presets

Returns: Variant map containing the presets

◆ getPresetType()

QString hdps::gui::PresetsAction::getPresetType ( ) const

Get preset type

Returns: Preset file type

◆ getSettingsKey()

QString hdps::gui::PresetsAction::getSettingsKey ( ) const

Get settings key

Returns: Settings key where the recent file paths will be stored

◆ importPreset()

void hdps::gui::PresetsAction::importPreset ( )

Import preset from file

◆ loadDefaultPreset()

void hdps::gui::PresetsAction::loadDefaultPreset ( )

Load default preset from settings

◆ loadPreset()

void hdps::gui::PresetsAction::loadPreset ( const QString & name )

Load preset from settings with name

Parameters

name	Name of the preset

◆ loadPresetsFromApplicationSettings()

void hdps::gui::PresetsAction::loadPresetsFromApplicationSettings ( )

Load presets variant map from application settings

◆ presetAboutToBeLoaded

void hdps::gui::PresetsAction::presetAboutToBeLoaded ( const QString & name )

signal

Signals that preset with name is about to be loaded

Parameters

name	Name of the preset that is about to be loaded

◆ presetAboutToBeRemoved

void hdps::gui::PresetsAction::presetAboutToBeRemoved ( const QString & name )

signal

Signals that preset with name is about to be removed

Parameters

name	Name of the preset that is about to be removed

◆ presetExported

void hdps::gui::PresetsAction::presetExported ( const QString & filePath )

signal

Signals that preset with filePath is exported

Parameters

filePath File path of the preset that was exported

◆ presetImported

void hdps::gui::PresetsAction::presetImported ( const QString & filePath )

signal

Signals that preset with filePath is imported

Parameters

filePath File path of the preset that was imported

◆ presetLoaded

void hdps::gui::PresetsAction::presetLoaded ( const QString & name )

signal

Signals that preset with name is loaded

Parameters

name	Name of the preset that was loaded

◆ presetRemoved

void hdps::gui::PresetsAction::presetRemoved ( const QString & name )

signal

Signals that preset with name is removed

Parameters

name	Name of the preset that was removed

◆ presetSaved

void hdps::gui::PresetsAction::presetSaved ( const QString & name )

signal

Signals that preset with name is saved

Parameters

name	Name of the preset that was saved

◆ removePreset()

void hdps::gui::PresetsAction::removePreset ( const QString & name )

Remove preset with name and update application settings

Parameters

name	Name of the preset to remove

◆ removePresets()

void hdps::gui::PresetsAction::removePresets ( const QStringList & names )

Remove presets with names and update application settings

Parameters

names Names of the preset to remove

◆ saveDefaultPreset()

void hdps::gui::PresetsAction::saveDefaultPreset ( )

Save default preset to settings

◆ savePreset()

void hdps::gui::PresetsAction::savePreset ( const QString & name )

Save preset to settings with name and update application settings

Parameters

name	Name of the preset

◆ savePresetsToApplicationSettings()

void hdps::gui::PresetsAction::savePresetsToApplicationSettings ( )

Save presets variant map to application settings

◆ setIcon()

void hdps::gui::PresetsAction::setIcon ( const QIcon & icon )

Set icon to icon

Parameters

icon	Icon for the preset type

Member Data Documentation

◆ columnInfo

QMap< PresetsAction::Column, QPair< QString, QString > > hdps::gui::PresetsAction::columnInfo

static

Initial value:

= QMap<PresetsAction::Column, QPair<QString, QString>>({
    { PresetsAction::Column::Name, { "Name", "Preset name" }},
    { PresetsAction::Column::DateTime, { "Date and time", "Date and time when the preset was changed" }}
})

Column name and tooltip

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

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

Classes

Public Types

Signals

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Column

Constructor & Destructor Documentation

◆ PresetsAction()

Member Function Documentation

◆ exportPreset()

◆ getEditAction()

◆ getFilterModel()

◆ getIcon()

◆ getMenu()

◆ getModel()

◆ getPresets()

◆ getPresetType()

◆ getSettingsKey()

◆ importPreset()

◆ loadDefaultPreset()

◆ loadPreset()

◆ loadPresetsFromApplicationSettings()

◆ presetAboutToBeLoaded

◆ presetAboutToBeRemoved

◆ presetExported

◆ presetImported

◆ presetLoaded

◆ presetRemoved

◆ presetSaved

◆ removePreset()

◆ removePresets()

◆ saveDefaultPreset()

◆ savePreset()

◆ savePresetsToApplicationSettings()

◆ setIcon()

Member Data Documentation

◆ columnInfo