#include <NumericalAction.h>

Inheritance diagram for hdps::gui::NumericalAction< NumericalType >:

Public Types
enum	WidgetFlag { SpinBox = 0x00001 , Slider = 0x00002 , LineEdit = 0x00004 , Default = SpinBox \| Slider }

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 }

Public Member Functions
	NumericalAction (QObject *parent, const QString &title, const NumericalType &minimum, NumericalType maximum, NumericalType value, std::uint32_t numberOfDecimals=INIT_NUMBER_OF_DECIMALS)

virtual NumericalType	getValue () const final

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

virtual NumericalType	getMinimum () const final

virtual void	setMinimum (NumericalType minimum) final

virtual NumericalType	getMaximum () const final

virtual void	setMaximum (NumericalType maximum) final

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

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

virtual void	setRange (NumericalType minimum, NumericalType 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 Attributes
NumericalType	_value

NumericalType	_minimum

NumericalType	_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 std::uint32_t	INIT_NUMBER_OF_DECIMALS = 1

Additional Inherited Members
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)

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

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)

virtual QWidget *	getWidget (QWidget *parent, const std::int32_t &widgetFlags)

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

template<typename NumericalType>
class hdps::gui::NumericalAction< NumericalType >

Numerical action class

Action class for manipulating a numerical value

Author: Thomas Kroes

Member Enumeration Documentation

◆ WidgetFlag

template<typename NumericalType >

enum hdps::gui::NumericalAction::WidgetFlag

Describes the widget settings

Enumerator
SpinBox
Slider	Widget includes a spin box
LineEdit	Widget includes a slider
Default	Widget includes a line edit

Constructor & Destructor Documentation

◆ NumericalAction()

template<typename NumericalType >

hdps::gui::NumericalAction< NumericalType >::NumericalAction	(	QObject *	parent,
		const QString &	title,
		const NumericalType &	minimum,
		NumericalType	maximum,
		NumericalType	value,
		std::uint32_t	numberOfDecimals = `INIT_NUMBER_OF_DECIMALS`
	)

inline

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

◆ getIntervalLength()

template<typename NumericalType >

virtual double hdps::gui::NumericalAction< NumericalType >::getIntervalLength ( ) const

inlinefinalvirtual

Returns the length of the interval defined by the minimum and maximum value

◆ getMaximum()

template<typename NumericalType >

virtual NumericalType hdps::gui::NumericalAction< NumericalType >::getMaximum ( ) const

inlinefinalvirtual

Gets the maximum value

◆ getMinimum()

template<typename NumericalType >

virtual NumericalType hdps::gui::NumericalAction< NumericalType >::getMinimum ( ) const

inlinefinalvirtual

Gets the minimum value

◆ getNormalized()

template<typename NumericalType >

virtual double hdps::gui::NumericalAction< NumericalType >::getNormalized ( ) const

inlinefinalvirtual

Returns the normalized value

◆ getNumberOfDecimals()

template<typename NumericalType >

virtual std::uint32_t hdps::gui::NumericalAction< NumericalType >::getNumberOfDecimals ( ) const

inlinefinalvirtual

Gets the number of decimals

◆ getPrefix()

template<typename NumericalType >

virtual QString hdps::gui::NumericalAction< NumericalType >::getPrefix ( ) const

inlinefinalvirtual

Gets the prefix

◆ getRange()

template<typename NumericalType >

virtual util::NumericalRange< NumericalType > hdps::gui::NumericalAction< NumericalType >::getRange ( ) const

inlinefinalvirtual

Gets the value range

Returns: Range

◆ getSuffix()

template<typename NumericalType >

virtual QString hdps::gui::NumericalAction< NumericalType >::getSuffix ( ) const

inlinefinalvirtual

Gets the suffix

◆ getUpdateDuringDrag()

template<typename NumericalType >

virtual bool hdps::gui::NumericalAction< NumericalType >::getUpdateDuringDrag ( ) const

inlinefinalvirtual

Gets whether the value should update during interaction

◆ getValue()

template<typename NumericalType >

virtual NumericalType hdps::gui::NumericalAction< NumericalType >::getValue ( ) const

inlinefinalvirtual

Gets the current value

◆ isAtMaximum()

template<typename NumericalType >

virtual bool hdps::gui::NumericalAction< NumericalType >::isAtMaximum ( ) const

inlinefinalvirtual

Returns whether the current value is at its maximum

◆ isAtMinimum()

template<typename NumericalType >

virtual bool hdps::gui::NumericalAction< NumericalType >::isAtMinimum ( ) const

inlinefinalvirtual

Returns whether the current value is at its minimum

◆ setMaximum()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setMaximum ( NumericalType maximum )

inlinefinalvirtual

Sets the maximum value

Parameters

maximum Maximum value

◆ setMinimum()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setMinimum ( NumericalType minimum )

inlinefinalvirtual

Sets the minimum value

Parameters

minimum Minimum value

◆ setNumberOfDecimals()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setNumberOfDecimals ( std::uint32_t numberOfDecimals )

inlinefinalvirtual

Sets the number of decimals

Parameters

numberOfDecimals number of decimals

◆ setPrefix()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setPrefix ( const QString & prefix )

inlinefinalvirtual

Sets the prefix

Parameters

prefix Prefix

◆ setRange() [1/2]

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setRange	(	NumericalType	minimum,
		NumericalType	maximum
	)

inlinefinalvirtual

Sets the value range

Parameters

minimum	Minimum value
maximum	Maximum value

◆ setRange() [2/2]

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setRange ( util::NumericalRange< NumericalType > range )

inlinefinalvirtual

Sets the value range

Parameters

range Range

◆ setSuffix()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setSuffix ( const QString & suffix )

inlinefinalvirtual

Sets the suffix

Parameters

suffix Suffix

◆ setUpdateDuringDrag()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setUpdateDuringDrag ( bool updateDuringDrag )

inlinefinalvirtual

Sets whether the value should update during interaction

Parameters

updateDuringDrag Whether the value should update during interaction

◆ setValue()

template<typename NumericalType >

virtual void hdps::gui::NumericalAction< NumericalType >::setValue	(	NumericalType	value,
		bool	silent = `false`
	)

inlinevirtual

Sets the current value

Parameters

value	Current value
silent	Prevent notification of value change

Member Data Documentation

◆ _maximum

template<typename NumericalType >

NumericalType hdps::gui::NumericalAction< NumericalType >::_maximum

protected

Minimum value

◆ _maximumChanged

template<typename NumericalType >

MaximumChangedCB hdps::gui::NumericalAction< NumericalType >::_maximumChanged

protected

Callback which is called when the minimum changed

◆ _minimum

template<typename NumericalType >

NumericalType hdps::gui::NumericalAction< NumericalType >::_minimum

protected

Current value

◆ _minimumChanged

template<typename NumericalType >

MinimumChangedCB hdps::gui::NumericalAction< NumericalType >::_minimumChanged

protected

Callback which is called when the value changed

◆ _numberOfDecimals

template<typename NumericalType >

std::uint32_t hdps::gui::NumericalAction< NumericalType >::_numberOfDecimals

protected

Suffix string

◆ _numberOfDecimalsChanged

template<typename NumericalType >

NumberOfDecimalsChangedCB hdps::gui::NumericalAction< NumericalType >::_numberOfDecimalsChanged

protected

Callback which is called when the suffix changed

◆ _prefix

template<typename NumericalType >

QString hdps::gui::NumericalAction< NumericalType >::_prefix

protected

Maximum value

◆ _prefixChanged

template<typename NumericalType >

PrefixChangedCB hdps::gui::NumericalAction< NumericalType >::_prefixChanged

protected

Callback which is called when the maximum changed

◆ _suffix

template<typename NumericalType >

QString hdps::gui::NumericalAction< NumericalType >::_suffix

protected

Prefix string

◆ _suffixChanged

template<typename NumericalType >

SuffixChangedCB hdps::gui::NumericalAction< NumericalType >::_suffixChanged

protected

Callback which is called when the prefix changed

◆ _updateDuringDrag

template<typename NumericalType >

bool hdps::gui::NumericalAction< NumericalType >::_updateDuringDrag

protected

Number of decimals

◆ _value

template<typename NumericalType >

NumericalType hdps::gui::NumericalAction< NumericalType >::_value

protected

◆ _valueChanged

template<typename NumericalType >

ValueChangedCB hdps::gui::NumericalAction< NumericalType >::_valueChanged

protected

Whether the value should update during interaction

◆ INIT_NUMBER_OF_DECIMALS

template<typename T >

constexpr std::uint32_t hdps::gui::NumericalAction< T >::INIT_NUMBER_OF_DECIMALS = 1

staticconstexprprotected

Callback which is called when the number of decimals changed

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

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

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ WidgetFlag

Constructor & Destructor Documentation

◆ NumericalAction()

Member Function Documentation

◆ getIntervalLength()

◆ getMaximum()

◆ getMinimum()

◆ getNormalized()

◆ getNumberOfDecimals()

◆ getPrefix()

◆ getRange()

◆ getSuffix()

◆ getUpdateDuringDrag()

◆ getValue()

◆ isAtMaximum()

◆ isAtMinimum()

◆ setMaximum()

◆ setMinimum()

◆ setNumberOfDecimals()

◆ setPrefix()

◆ setRange() [1/2]

◆ setRange() [2/2]

◆ setSuffix()

◆ setUpdateDuringDrag()

◆ setValue()

Member Data Documentation

◆ _maximum

◆ _maximumChanged

◆ _minimum

◆ _minimumChanged

◆ _numberOfDecimals

◆ _numberOfDecimalsChanged

◆ _prefix

◆ _prefixChanged

◆ _suffix

◆ _suffixChanged

◆ _updateDuringDrag

◆ _value

◆ _valueChanged

◆ INIT_NUMBER_OF_DECIMALS