#include <DecimalAction.h>

Inheritance diagram for hdps::gui::DecimalAction:

Classes
class	LineEditWidget

class	SliderWidget

class	SpinBoxWidget

Signals
void	valueChanged (float value)

void	minimumChanged (float minimum)

void	maximumChanged (float maximum)

void	prefixChanged (const QString &prefix)

void	suffixChanged (const QString &suffix)

void	numberOfDecimalsChanged (std::uint32_t numberOfDecimals)

void	singleStepChanged (float singleStep)

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	DecimalAction (QObject *parent, const QString &title, float minimum=INIT_MIN, float maximum=INIT_MAX, float value=INIT_VALUE, std::uint32_t numberOfDecimals=INIT_NUMBER_OF_DECIMALS)

void	initialize (float minimum, float maximum, float value, std::uint32_t numberOfDecimals=INIT_NUMBER_OF_DECIMALS)

float	getSingleStep () const

void	setSingleStep (float singleStep)

void	fromVariantMap (const QVariantMap &variantMap) override

QVariantMap	toVariantMap () const override

Public Member Functions inherited from hdps::gui::NumericalAction< float >
	NumericalAction (QObject *parent, const QString &title, const float &minimum, float maximum, float value, std::uint32_t numberOfDecimals=INIT_NUMBER_OF_DECIMALS)

virtual float	getValue () const final

virtual void	setValue (float value, bool silent=false)

virtual float	getMinimum () const final

virtual void	setMinimum (float minimum) final

virtual float	getMaximum () const final

virtual void	setMaximum (float maximum) final

virtual util::NumericalRange< float >	getRange () const final

virtual void	setRange (util::NumericalRange< float > range) final

virtual void	setRange (float minimum, float maximum) final

virtual QString	getPrefix () const final

virtual void	setPrefix (const QString &prefix) final

virtual QString	getSuffix () const final

virtual void	setSuffix (const QString &suffix) final

virtual std::uint32_t	getNumberOfDecimals () const final

virtual void	setNumberOfDecimals (std::uint32_t numberOfDecimals) final

virtual bool	getUpdateDuringDrag () const final

virtual void	setUpdateDuringDrag (bool updateDuringDrag) final

virtual bool	isAtMinimum () const final

virtual bool	isAtMaximum () const final

virtual double	getIntervalLength () const final

virtual double	getNormalized () const final

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
float	_singleStep

Protected Attributes inherited from hdps::gui::NumericalAction< float >
float	_value

float	_minimum

float	_maximum

QString	_prefix

QString	_suffix

std::uint32_t	_numberOfDecimals

bool	_updateDuringDrag

ValueChangedCB	_valueChanged

MinimumChangedCB	_minimumChanged

MaximumChangedCB	_maximumChanged

PrefixChangedCB	_prefixChanged

SuffixChangedCB	_suffixChanged

NumberOfDecimalsChangedCB	_numberOfDecimalsChanged

Static Protected Attributes
static constexpr float	INIT_MIN = 0.0f

static constexpr float	INIT_MAX = 100.0f

static constexpr float	INIT_VALUE = 0.0

static constexpr int	INIT_DECIMALS = 1

Static Protected Attributes inherited from hdps::gui::NumericalAction< float >
static constexpr std::uint32_t	INIT_NUMBER_OF_DECIMALS

Friends
class	AbstractActionsManager

Additional Inherited Members
Public Types inherited from hdps::gui::NumericalAction< float >
enum	WidgetFlag

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 }

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

Decimal action class

Stores a float value and creates widgets to interact with it

Author: Thomas Kroes

Constructor & Destructor Documentation

◆ DecimalAction()

hdps::gui::DecimalAction::DecimalAction	(	QObject *	parent,
		const QString &	title,
		float	minimum = `INIT_MIN`,
		float	maximum = `INIT_MAX`,
		float	value = `INIT_VALUE`,
		std::uint32_t	numberOfDecimals = `INIT_NUMBER_OF_DECIMALS`
	)

explicit

Constructor

Parameters

parent	Pointer to parent object
title	Title of the action
minimum	Minimum value
maximum	Maximum value
value	Value
numberOfDecimals	Number of decimals

Member Function Documentation

◆ connectToPublicAction()

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

overridevirtual

Load widget action from variant map

Parameters

Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getSingleStep()

float hdps::gui::DecimalAction::getSingleStep ( ) const

Gets the single step

◆ getWidget()

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

overrideprotectedvirtual

Get widget representation of the decimal action

Parameters

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

Reimplemented from hdps::gui::WidgetAction.

◆ initialize()

void hdps::gui::DecimalAction::initialize	(	float	minimum,
		float	maximum,
		float	value,
		std::uint32_t	numberOfDecimals = `INIT_NUMBER_OF_DECIMALS`
	)

Initialize the decimal action

Parameters

minimum	Minimum value
maximum	Maximum value
value	Value

◆ maximumChanged

void hdps::gui::DecimalAction::maximumChanged ( float maximum )

signal

Signals that the maximum value changed

Parameters

maximum New maximum

◆ minimumChanged

void hdps::gui::DecimalAction::minimumChanged ( float minimum )

signal

Signals that the minimum value changed

Parameters

minimum New minimum

◆ numberOfDecimalsChanged

void hdps::gui::DecimalAction::numberOfDecimalsChanged ( std::uint32_t numberOfDecimals )

signal

Signals that the number of decimals changed to numberOfDecimals

Parameters

numberOfDecimals Number of decimals

◆ prefixChanged

void hdps::gui::DecimalAction::prefixChanged ( const QString & prefix )

signal

Signals that the prefix changed

Parameters

prefix New prefix

◆ setSingleStep()

void hdps::gui::DecimalAction::setSingleStep ( float singleStep )

Sets the single step

Parameters

singleStep Single step

◆ singleStepChanged

void hdps::gui::DecimalAction::singleStepChanged ( float singleStep )

signal

Signals that the single step changed

Parameters

singleStep Single step

◆ suffixChanged

void hdps::gui::DecimalAction::suffixChanged ( const QString & suffix )

signal

Signals that the suffix changed

Parameters

suffix New suffix

◆ toVariantMap()

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

overridevirtual

Save widget action to variant map

Returns: Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ valueChanged

void hdps::gui::DecimalAction::valueChanged ( float value )

signal

Signals that the current value changed

Parameters

value Current value that changed

Friends And Related Symbol Documentation

◆ AbstractActionsManager

friend class AbstractActionsManager

friend

Initialization number of decimals

Member Data Documentation

◆ _singleStep

float hdps::gui::DecimalAction::_singleStep

protected

◆ INIT_DECIMALS

constexpr int hdps::gui::DecimalAction::INIT_DECIMALS = 1

staticconstexprprotected

Initialization value

◆ INIT_MAX

constexpr float hdps::gui::DecimalAction::INIT_MAX = 100.0f

staticconstexprprotected

Initialization minimum value

◆ INIT_MIN

constexpr float hdps::gui::DecimalAction::INIT_MIN = 0.0f

staticconstexprprotected

Single step size for spin box

◆ INIT_VALUE

constexpr float hdps::gui::DecimalAction::INIT_VALUE = 0.0

staticconstexprprotected

Initialization maximum value

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

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

Classes

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DecimalAction()

Member Function Documentation

◆ connectToPublicAction()

◆ disconnectFromPublicAction()

◆ fromVariantMap()

◆ getSingleStep()

◆ getWidget()

◆ initialize()

◆ maximumChanged

◆ minimumChanged

◆ numberOfDecimalsChanged

◆ prefixChanged

◆ setSingleStep()

◆ singleStepChanged

◆ suffixChanged

◆ toVariantMap()

◆ valueChanged

Friends And Related Symbol Documentation

◆ AbstractActionsManager

Member Data Documentation

◆ _singleStep

◆ INIT_DECIMALS

◆ INIT_MAX

◆ INIT_MIN

◆ INIT_VALUE