hdps::gui::FilePickerAction Class Reference

#include <FilePickerAction.h>

Inheritance diagram for hdps::gui::FilePickerAction:

Public Types
enum	WidgetFlag { LineEdit = 0x00001 , PushButton = 0x00002 , Default = LineEdit | PushButton }
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	filePathChanged (const QString &filePath)
void	placeholderStringChanged (const QString &placeholderString)
void	fileTypeChanged (const QString &fileType)
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	FilePickerAction (QObject *parent, const QString &title, const QString &filePath=QString())
QString	getFilePath () const
void	setFilePath (const QString &filePath)
QStringList	getNameFilters () const
void	setNameFilters (const QStringList &nameFilters)
QString	getDefaultSuffix () const
void	setDefaultSuffix (const QString &defaultSuffix)
QString	getFileType () const
void	setFileType (const QString &fileType)
QString	getPlaceholderString () const
void	setPlaceHolderString (const QString &placeholderString)
QString	getDirectoryName () const
bool	isValid () const
void	fromVariantMap (const QVariantMap &variantMap) override
QVariantMap	toVariantMap () const override
StringAction &	getFilePathAction ()
TriggerAction &	getPickAction ()
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
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)

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

File picker action class

Action class for picking a file

Author

Thomas Kroes

Member Enumeration Documentation

WidgetFlag

enum hdps::gui::FilePickerAction::WidgetFlag

Describes the widget configurations

Enumerator
LineEdit
PushButton	Widget includes a line edit
Default	There is a button to pick a directory

Constructor & Destructor Documentation

FilePickerAction()

hdps::gui::FilePickerAction::FilePickerAction	(	QObject *	parent,
		const QString &	title,
		const QString &	filePath = QString()
	)

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
filePath	File path

Member Function Documentation

filePathChanged

void hdps::gui::FilePickerAction::filePathChanged ( const QString &  filePath )

signal

Signals that the file path changed to filePath

Parameters

filePath

New file path

fileTypeChanged

void hdps::gui::FilePickerAction::fileTypeChanged ( const QString &  fileType )

signal

Signals that the file type has changed to fileType

Parameters

fileType

File type

fromVariantMap()

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

overridevirtual

Load file picker action from variant

Parameters

Variant

representation of the file picker action

Reimplemented from hdps::util::Serializable.

getDefaultSuffix()

QString hdps::gui::FilePickerAction::getDefaultSuffix

(

)

const

Get the default suffix

Returns

Default suffix

getDirectoryName()

QString hdps::gui::FilePickerAction::getDirectoryName

(

)

const

Get directory name

Returns

Directory name

getFilePath()

QString hdps::gui::FilePickerAction::getFilePath

(

)

const

Get the current file path

Returns

Current file path

getFilePathAction()

StringAction & hdps::gui::FilePickerAction::getFilePathAction ( )

inline

getFileType()

QString hdps::gui::FilePickerAction::getFileType

(

)

const

Get the file type

Returns

File type

getNameFilters()

QStringList hdps::gui::FilePickerAction::getNameFilters

(

)

const

Get the name filters

Returns

Name filters

getPickAction()

TriggerAction & hdps::gui::FilePickerAction::getPickAction ( )

inline

getPlaceholderString()

QString hdps::gui::FilePickerAction::getPlaceholderString

(

)

const

Get placeholder text

Returns

Placeholder string

getWidget()

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

overrideprotectedvirtual

Get widget representation of the file picker action

Parameters

parent	Pointer to parent widget
widgetFlags	Widget flags for the configuration of the widget

Reimplemented from hdps::gui::WidgetAction.

isValid()

bool hdps::gui::FilePickerAction::isValid

(

)

const

Get whether the directory is valid or not

Returns

Boolean indication whether the directory is valid or not

placeholderStringChanged

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

signal

Signals that the placeholder string changed

Parameters

placeholderString

Placeholder string that changed

setDefaultSuffix()

void hdps::gui::FilePickerAction::setDefaultSuffix

(

const QString &

defaultSuffix

)

Set the default suffix to defaultSuffix

Parameters

defaultSuffix

Default suffix

setFilePath()

void hdps::gui::FilePickerAction::setFilePath

(

const QString &

filePath

)

Set the file path

Parameters

filePath

Current file path

setFileType()

void hdps::gui::FilePickerAction::setFileType

(

const QString &

fileType

)

Set file type to fileType

Parameters

fileType

File type

setNameFilters()

void hdps::gui::FilePickerAction::setNameFilters

(

const QStringList &

nameFilters

)

Set the name filters to nameFilters

Parameters

filePath

Name filters

setPlaceHolderString()

void hdps::gui::FilePickerAction::setPlaceHolderString

(

const QString &

placeholderString

)

Set placeholder text

Parameters

placeholderText

Placeholder text

toVariantMap()

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

overridevirtual

Save file picker action to variant

Returns

Variant representation of the file picker action

Reimplemented from hdps::util::Serializable.

---

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

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