#include <StatusAction.h>

Inheritance diagram for hdps::gui::StatusAction:

Classes
class	LineEditWidget

Public Types
enum	WidgetFlag { LineEdit = 0x00001 , Default = LineEdit }

enum	Status { Undefined = -1 , Info , Warning , Error }

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	statusChanged (const Status &status)

void	messageChanged (const QString &message)

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	StatusAction (QObject *parent, const QString &title="", const Status &status=Status::Undefined, const QString &message="")

void	initialize (const Status &status=Status::Info, const QString &message="")

Status	getStatus () const

void	setStatus (const Status &status)

QString	getMessage () const

void	setMessage (const QString &message, bool vanish=false)

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)

Protected Attributes
Status	_status

QString	_message

Static Protected Attributes
static constexpr std::int32_t	MESSAGE_DISAPPEAR_INTERVAL = 1500

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

Status action class

Action class for reporting status

Author: Thomas Kroes

Member Enumeration Documentation

◆ Status

enum hdps::gui::StatusAction::Status

Status enumeration

Enumerator
Undefined
Info	There is no status information
Warning	Normal info
Error	Warning An error occurred

◆ WidgetFlag

enum hdps::gui::StatusAction::WidgetFlag

Describes the widget flags

Enumerator
LineEdit
Default	Status is logged in a line edit

Constructor & Destructor Documentation

◆ StatusAction()

hdps::gui::StatusAction::StatusAction	(	QObject *	parent,
		const QString &	title = `""`,
		const Status &	status = `Status::Undefined`,
		const QString &	message = `""`
	)

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
status	Status type
message	Status message

Member Function Documentation

◆ getMessage()

QString hdps::gui::StatusAction::getMessage ( ) const

Get status message

Returns: Status message

◆ getStatus()

StatusAction::Status hdps::gui::StatusAction::getStatus ( ) const

Get status type

Returns: Status type

◆ getWidget()

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

inlineoverrideprotectedvirtual

Get widget representation of the status action

Parameters

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

Reimplemented from hdps::gui::WidgetAction.

◆ initialize()

void hdps::gui::StatusAction::initialize	(	const Status &	status = `Status::Info`,
		const QString &	message = `""`
	)

Initialize the status action

Parameters

status	Status type
message	Status message

◆ messageChanged

void hdps::gui::StatusAction::messageChanged ( const QString & message )

signal

Signals that the message changed

Parameters

message Message that changed

◆ setMessage()

void hdps::gui::StatusAction::setMessage	(	const QString &	message,
		bool	vanish = `false`
	)

Set status message

Parameters

message	Status message
vanish	Whether to reset the message after the disappear message delay

◆ setStatus()

void hdps::gui::StatusAction::setStatus ( const Status & status )

Set status type

Parameters

status Status type

◆ statusChanged

void hdps::gui::StatusAction::statusChanged ( const Status & status )

signal

Signals that the status changed

Parameters

status Status

Member Data Documentation

◆ _message

QString hdps::gui::StatusAction::_message

protected

Current status enum

◆ _status

Status hdps::gui::StatusAction::_status

protected

◆ MESSAGE_DISAPPEAR_INTERVAL

constexpr std::int32_t hdps::gui::StatusAction::MESSAGE_DISAPPEAR_INTERVAL = 1500

staticconstexprprotected

Status message

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

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

Classes

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Status

◆ WidgetFlag

Constructor & Destructor Documentation

◆ StatusAction()

Member Function Documentation

◆ getMessage()

◆ getStatus()

◆ getWidget()

◆ initialize()

◆ messageChanged

◆ setMessage()

◆ setStatus()

◆ statusChanged

Member Data Documentation

◆ _message

◆ _status

◆ MESSAGE_DISAPPEAR_INTERVAL