#include <StringAction.h>

Inheritance diagram for hdps::gui::StringAction:

Classes
class	LabelWidget

class	LineEditWidget

class	TextEditWidget

Public Types
enum	WidgetFlag { Label = 0x00001 , LineEdit = 0x00002 , TextEdit = 0x00004 , Default = LineEdit }

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	stringChanged (const QString &string)

void	placeholderStringChanged (const QString &placeholderString)

void	completerChanged (QCompleter *completer)

void	textElideModeChanged (const Qt::TextElideMode &textElideMode)

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	StringAction (QObject *parent, const QString &title, const QString &string="")

QString	getString () const

void	setString (const QString &string)

QString	getPlaceholderString () const

void	setPlaceHolderString (const QString &placeholderString)

QAction &	getLeadingAction ()

QAction &	getTrailingAction ()

QCompleter *	getCompleter ()

void	setCompleter (QCompleter *completer)

bool	getSearchMode () const

void	setSearchMode (bool searchMode)

bool	isClearable () const

void	setClearable (bool clearable)

Qt::TextElideMode	getTextElideMode () const

void	setTextElideMode (const Qt::TextElideMode &textElideMode)

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

void	connectToPublicAction (WidgetAction *publicAction, bool recursive) override

void	disconnectFromPublicAction (bool recursive) override

Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void	makePublic (bool recursive=true) final

virtual void	connectToPublicActionByName (const QString &publicActionName) final

Protected Attributes
QString	_string

QString	_placeholderString

QAction	_leadingAction

QAction	_trailingAction

QCompleter *	_completer

bool	_searchMode

bool	_clearable

Qt::TextElideMode	_textElideMode

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

String widget action class

Stores a string creates widgets to interact with it

Author: Thomas Kroes

Member Enumeration Documentation

◆ WidgetFlag

enum hdps::gui::StringAction::WidgetFlag

Describes the widget configurations

Enumerator
Label
LineEdit	Widget includes a label
TextEdit	Widget includes a line edit
Default	Widget includes a text edit

Constructor & Destructor Documentation

◆ StringAction()

hdps::gui::StringAction::StringAction	(	QObject *	parent,
		const QString &	title,
		const QString &	string = `""`
	)

explicit

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
string	String
defaultString	Default string

Member Function Documentation

◆ completerChanged

void hdps::gui::StringAction::completerChanged ( QCompleter * completer )

signal

Signals that the completer changed to completer

Parameters

completer Pointer to completer

◆ connectToPublicAction()

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

◆ disconnectFromPublicAction()

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

overridevirtual

Load widget action from variant

Parameters

Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getCompleter()

QCompleter * hdps::gui::StringAction::getCompleter ( )

Get completer

Returns: Pointer to completer

◆ getLeadingAction()

QAction & hdps::gui::StringAction::getLeadingAction ( )

Get action at leading position

Returns: Reference to action at leading position

◆ getPlaceholderString()

QString hdps::gui::StringAction::getPlaceholderString ( ) const

Get placeholder text

◆ getSearchMode()

bool hdps::gui::StringAction::getSearchMode ( ) const

Get search mode (if on, there will be a leading action with a search icon and a trailing action to clear the string)

Returns: Search mode

◆ getString()

QString hdps::gui::StringAction::getString ( ) const

Gets the current string

◆ getTextElideMode()

Qt::TextElideMode hdps::gui::StringAction::getTextElideMode ( ) const

Get text elide mode

Returns: Text elide mode

◆ getTrailingAction()

QAction & hdps::gui::StringAction::getTrailingAction ( )

Get action at trailing position

Returns: Reference to action at trailing position

◆ getWidget()

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

overrideprotectedvirtual

Get widget representation of the string action

Parameters

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

Reimplemented from hdps::gui::WidgetAction.

◆ isClearable()

bool hdps::gui::StringAction::isClearable ( ) const

Get whether the string can be cleared by clicking the trailing action

Returns: Boolean indicating whether the string can be cleared

◆ placeholderStringChanged

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

signal

Signals that the placeholder string changed to placeholderString

Parameters

placeholderString Placeholder string that changed

◆ setClearable()

void hdps::gui::StringAction::setClearable ( bool clearable )

Set whether the string can be cleared by clicking the trailing action

Parameters

clearable Boolean indicating whether the string can be cleared

◆ setCompleter()

void hdps::gui::StringAction::setCompleter ( QCompleter * completer )

Set completer

Parameters

completer Pointer to completer

◆ setPlaceHolderString()

void hdps::gui::StringAction::setPlaceHolderString ( const QString & placeholderString )

Set placeholder text

Parameters

placeholderText Placeholder text

◆ setSearchMode()

void hdps::gui::StringAction::setSearchMode ( bool searchMode )

Set search mode (if on, there will be a leading action with a search icon and a trailing action to clear the string)

Parameters

searchMode Whether search mode is on/off

◆ setString()

void hdps::gui::StringAction::setString ( const QString & string )

Sets the current string

Parameters

string Current string

◆ setTextElideMode()

void hdps::gui::StringAction::setTextElideMode ( const Qt::TextElideMode & textElideMode )

Set text elide mode

Parameters

textElideMode Text elide mode

◆ stringChanged

void hdps::gui::StringAction::stringChanged ( const QString & string )

signal

Signals that the current string changed to string

Parameters

string Current string that changed

◆ textElideModeChanged

void hdps::gui::StringAction::textElideModeChanged ( const Qt::TextElideMode & textElideMode )

signal

Signals that the text elide mode changed to textElideMode

Parameters

textElideMode Text elide mode

◆ toVariantMap()

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

overridevirtual

Save widget action to variant

Returns: Variant representation of the widget action

Reimplemented from hdps::util::Serializable.

Friends And Related Symbol Documentation

◆ AbstractActionsManager

friend class AbstractActionsManager

friend

Text elide mode

Member Data Documentation

◆ _clearable

bool hdps::gui::StringAction::_clearable

protected

Whether the string action is in search mode

◆ _completer

QCompleter* hdps::gui::StringAction::_completer

protected

Action at the trailing position

◆ _leadingAction

QAction hdps::gui::StringAction::_leadingAction

protected

Place holder string

◆ _placeholderString

QString hdps::gui::StringAction::_placeholderString

protected

Current string

◆ _searchMode

bool hdps::gui::StringAction::_searchMode

protected

Pointer to completer

◆ _string

QString hdps::gui::StringAction::_string

protected

◆ _textElideMode

Qt::TextElideMode hdps::gui::StringAction::_textElideMode

protected

Whether the string can be cleared by clicking the trailing action

◆ _trailingAction

QAction hdps::gui::StringAction::_trailingAction

protected

Action at the leading position

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

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

Classes

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ WidgetFlag

Constructor & Destructor Documentation

◆ StringAction()

Member Function Documentation

◆ completerChanged

◆ connectToPublicAction()

◆ disconnectFromPublicAction()

◆ fromVariantMap()

◆ getCompleter()

◆ getLeadingAction()

◆ getPlaceholderString()

◆ getSearchMode()

◆ getString()

◆ getTextElideMode()

◆ getTrailingAction()

◆ getWidget()

◆ isClearable()

◆ placeholderStringChanged

◆ setClearable()

◆ setCompleter()

◆ setPlaceHolderString()

◆ setSearchMode()

◆ setString()

◆ setTextElideMode()

◆ stringChanged

◆ textElideModeChanged

◆ toVariantMap()

Friends And Related Symbol Documentation

◆ AbstractActionsManager

Member Data Documentation

◆ _clearable

◆ _completer

◆ _leadingAction

◆ _placeholderString

◆ _searchMode

◆ _string

◆ _textElideMode

◆ _trailingAction