#include <DatasetPickerAction.h>

Inheritance diagram for hdps::gui::DatasetPickerAction:

Classes
class	DatasetsModel

Public Types
enum class	Mode { Manual , Automatic }

using	DatasetsFilterFunction = std::function< hdps::Datasets(const hdps::Datasets &)>

Public Types inherited from hdps::gui::OptionAction
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	datasetPicked (hdps::Dataset< hdps::DatasetImpl > pickedDataset)

void	datasetsChanged (hdps::Datasets datasets)

Signals inherited from hdps::gui::OptionAction
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	DatasetPickerAction (QObject *parent, const QString &title, Mode mode=Mode::Automatic)

Mode	getMode () const

void	setMode (Mode mode)

hdps::Datasets	getDatasets () const

void	setDatasets (hdps::Datasets datasets)

void	setDatasetsFilterFunction (const DatasetsFilterFunction &datasetsFilterFunction)

hdps::Dataset< hdps::DatasetImpl >	getCurrentDataset () const

template<typename DatasetType >
hdps::Dataset< DatasetType >	getCurrentDataset () const

void	setCurrentDataset (hdps::Dataset< hdps::DatasetImpl > currentDataset)

void	setCurrentDataset (const QString &guid)

QString	getCurrentDatasetGuid () const

bool	getShowIcon () const

void	setShowIcon (bool showIcon)

bool	getShowLocation () const

void	setShowFullPathName (bool showLocation)

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

Public Member Functions inherited from hdps::gui::OptionAction
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
void	connectToPublicAction (WidgetAction *publicAction, bool recursive) override

void	disconnectFromPublicAction (bool recursive) override

Protected Member Functions inherited from hdps::gui::OptionAction
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
Mode	_mode

DatasetsFilterFunction	_datasetsFilterFunction

DatasetsModel	_datasetsModel

hdps::EventListener	_eventListener

Protected Attributes inherited from hdps::gui::OptionAction
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

Dataset picker action class

Action class for picking a dataset from a list Automatically removes items when datasets are removed and renamed

Author: Thomas Kroes

Member Typedef Documentation

◆ DatasetsFilterFunction

using hdps::gui::DatasetPickerAction::DatasetsFilterFunction = std::function<hdps::Datasets(const hdps::Datasets&)>

Filter function signature, the input are all datasets in the core and it returns the filtered datasets

Member Enumeration Documentation

◆ Mode

enum class hdps::gui::DatasetPickerAction::Mode

strong

Pickable datasets

Enumerator
Manual
Automatic	...are set manually with `setDatasets()` ...are a continuous reflection of the datasets in the data model and can be possibly filtered with `setDatasetsFilterFunction()`

Constructor & Destructor Documentation

◆ DatasetPickerAction()

hdps::gui::DatasetPickerAction::DatasetPickerAction	(	QObject *	parent,
		const QString &	title,
		Mode	mode = `Mode::Automatic`
	)

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
mode	Picker mode

Member Function Documentation

◆ connectToPublicAction()

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

◆ datasetPicked

void hdps::gui::DatasetPickerAction::datasetPicked ( hdps::Dataset< hdps::DatasetImpl > pickedDataset )

signal

Signals that a dataset has been picked

Parameters

Smart pointer to picked dataset

◆ datasetsChanged

void hdps::gui::DatasetPickerAction::datasetsChanged ( hdps::Datasets datasets )

signal

Signals that selectable datasets changed

Parameters

Selectable datasets

◆ disconnectFromPublicAction()

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

overridevirtual

Load widget action from variant map

Parameters

Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getCurrentDataset() [1/2]

Dataset< DatasetImpl > hdps::gui::DatasetPickerAction::getCurrentDataset ( ) const

Get the current dataset

◆ getCurrentDataset() [2/2]

template<typename DatasetType >

hdps::Dataset< DatasetType > hdps::gui::DatasetPickerAction::getCurrentDataset ( ) const

inline

Get the current dataset

◆ getCurrentDatasetGuid()

QString hdps::gui::DatasetPickerAction::getCurrentDatasetGuid ( ) const

Get current dataset globally unique identifier

Returns: The globally unique identifier of the currently selected dataset (if any)

◆ getDatasets()

hdps::Datasets hdps::gui::DatasetPickerAction::getDatasets ( ) const

Get datasets

Returns: Datasets

◆ getMode()

DatasetPickerAction::Mode hdps::gui::DatasetPickerAction::getMode ( ) const

Get current mode

◆ getShowIcon()

bool hdps::gui::DatasetPickerAction::getShowIcon ( ) const

inline

Get whether to show the dataset icon

◆ getShowLocation()

bool hdps::gui::DatasetPickerAction::getShowLocation ( ) const

inline

Get whether to show the location

◆ setCurrentDataset() [1/2]

void hdps::gui::DatasetPickerAction::setCurrentDataset ( const QString & guid )

Set the current dataset by guid

Parameters

guid	Current dataset globally unique identifier

◆ setCurrentDataset() [2/2]

void hdps::gui::DatasetPickerAction::setCurrentDataset ( hdps::Dataset< hdps::DatasetImpl > currentDataset )

Set the current dataset

Parameters

currentDataset Smart pointer to current dataset

◆ setDatasets()

void hdps::gui::DatasetPickerAction::setDatasets ( hdps::Datasets datasets )

Set the datasets from which can be picked (mode is set to Mode::Manual)

Parameters

datasets Datasets from which can be picked

◆ setDatasetsFilterFunction()

void hdps::gui::DatasetPickerAction::setDatasetsFilterFunction ( const DatasetsFilterFunction & datasetsFilterFunction )

Set datasets filter function (mode is set to Mode::Automatic)

Parameters

datasetsFilterFunction Filter lambda (triggered when datasets are added and/or removed from the datasets model)

◆ setMode()

void hdps::gui::DatasetPickerAction::setMode ( Mode mode )

Set current mode

Parameters

mode Mode

◆ setShowFullPathName()

void hdps::gui::DatasetPickerAction::setShowFullPathName ( bool showLocation )

inline

Set whether to show the location

Parameters

showLocation Boolean determining whether to show the location

◆ setShowIcon()

void hdps::gui::DatasetPickerAction::setShowIcon ( bool showIcon )

inline

Set whether to show the icon

Parameters

showFullPathName Whether to show the icon

◆ toVariantMap()

QVariantMap hdps::gui::DatasetPickerAction::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

Listen to events from the core

Member Data Documentation

◆ _datasetsFilterFunction

DatasetsFilterFunction hdps::gui::DatasetPickerAction::_datasetsFilterFunction

protected

Picker mode (e.g. manual or automatic)

◆ _datasetsModel

DatasetsModel hdps::gui::DatasetPickerAction::_datasetsModel

protected

Datasets filter lambda

◆ _eventListener

hdps::EventListener hdps::gui::DatasetPickerAction::_eventListener

protected

Datasets list model

◆ _mode

Mode hdps::gui::DatasetPickerAction::_mode

protected

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

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

Classes

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DatasetsFilterFunction

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ DatasetPickerAction()

Member Function Documentation

◆ connectToPublicAction()

◆ datasetPicked

◆ datasetsChanged

◆ disconnectFromPublicAction()

◆ fromVariantMap()

◆ getCurrentDataset() [1/2]

◆ getCurrentDataset() [2/2]

◆ getCurrentDatasetGuid()

◆ getDatasets()

◆ getMode()

◆ getShowIcon()

◆ getShowLocation()

◆ setCurrentDataset() [1/2]

◆ setCurrentDataset() [2/2]

◆ setDatasets()

◆ setDatasetsFilterFunction()

◆ setMode()

◆ setShowFullPathName()

◆ setShowIcon()

◆ toVariantMap()

Friends And Related Symbol Documentation

◆ AbstractActionsManager

Member Data Documentation

◆ _datasetsFilterFunction

◆ _datasetsModel

◆ _eventListener

◆ _mode