Workspace 6.21.5
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QtDoublePropertyManager Class Reference

The QtDoublePropertyManager provides and manages double properties. More...

#include <Workspace/Widgets/PropertyBrowser/qtpropertymanager.h>

Inheritance diagram for QtDoublePropertyManager:
[legend]

Public Slots

void setDecimals (QtProperty *property, int prec)
 
void setMaximum (QtProperty *property, double maxVal)
 
void setMinimum (QtProperty *property, double minVal)
 
void setRange (QtProperty *property, double minVal, double maxVal)
 
void setSingleStep (QtProperty *property, double step)
 
void setValue (QtProperty *property, double val)
 

Signals

void decimalsChanged (QtProperty *property, int prec)
 
void rangeChanged (QtProperty *property, double minVal, double maxVal)
 
void singleStepChanged (QtProperty *property, double step)
 
void valueChanged (QtProperty *property, double val)
 
- Signals inherited from QtAbstractPropertyManager
void propertyChanged (QtProperty *property)
 
void propertyDestroyed (QtProperty *property)
 
void propertyInserted (QtProperty *property, QtProperty *parent, QtProperty *after)
 
void propertyRemoved (QtProperty *property, QtProperty *parent)
 

Public Member Functions

 QtDoublePropertyManager (QObject *parent=nullptr)
 
 ~QtDoublePropertyManager ()
 
int decimals (const QtProperty *property) const
 
double maximum (const QtProperty *property) const
 
double minimum (const QtProperty *property) const
 
double singleStep (const QtProperty *property) const
 
double value (const QtProperty *property) const
 
- Public Member Functions inherited from QtAbstractPropertyManager
 QtAbstractPropertyManager (QObject *parent=nullptr)
 
 ~QtAbstractPropertyManager ()
 
QtPropertyaddProperty (const QString &name=QString())
 
void clear () const
 
bool getModifiedOnValueChanged () const
 
QSet< QtProperty * > properties () const
 
void setModifiedOnValueChanged (bool modified)
 

Protected Member Functions

virtual void initializeProperty (QtProperty *property)
 
virtual void uninitializeProperty (QtProperty *property)
 
QString valueText (const QtProperty *property) const
 
- Protected Member Functions inherited from QtAbstractPropertyManager
virtual QtPropertycreateProperty ()
 
virtual QString displayText (const QtProperty *property) const
 
virtual EchoMode echoMode (const QtProperty *) const
 
virtual bool hasValue (const QtProperty *property) const
 
virtual void initializeProperty (QtProperty *property)=0
 
virtual void uninitializeProperty (QtProperty *property)
 
virtual QIcon valueIcon (const QtProperty *property) const
 
virtual QString valueText (const QtProperty *property) const
 

Detailed Description

A double property has a current value, and a range specifying the valid values. The range is defined by a minimum and a maximum value.

The property's value and range can be retrieved using the value(), minimum() and maximum() functions, and can be set using the setValue(), setMinimum() and setMaximum() slots. Alternatively, the range can be defined in one go using the setRange() slot.

In addition, QtDoublePropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes, and the rangeChanged() signal which is emitted whenever such a property changes its range of valid values.

See also
QtAbstractPropertyManager, QtDoubleSpinBoxFactory

Constructor & Destructor Documentation

◆ QtDoublePropertyManager()

QtDoublePropertyManager ( QObject *  parent = nullptr)

Creates a manager with the given parent.

◆ ~QtDoublePropertyManager()

Destroys this manager, and all the properties it has created.

Member Function Documentation

◆ decimals()

int decimals ( const QtProperty property) const

Returns the given property's precision, in decimals.

See also
setDecimals()

◆ decimalsChanged

void decimalsChanged ( QtProperty property,
int  prec 
)
signal

This signal is emitted whenever a property created by this manager changes its precision of value, passing a pointer to the property and the new prec value

See also
setDecimals()

◆ initializeProperty()

void initializeProperty ( QtProperty property)
protectedvirtual

This function is called whenever a new valid property pointer has been created, passing the pointer as parameter.

The purpose is to let the manager know that the property has been created so that it can provide additional attributes for the new property, e.g. QtIntPropertyManager adds {QtIntPropertyManager::value()}{value}, {QtIntPropertyManager::minimum()}{minimum} and {QtIntPropertyManager::maximum()}{maximum} attributes. Since each manager subclass adds type specific attributes, this function is pure virtual and must be reimplemented when deriving from the QtAbstractPropertyManager class.

See also
addProperty(), createProperty()

Implements QtAbstractPropertyManager.

◆ maximum()

double maximum ( const QtProperty property) const

Returns the given property's maximum value.

See also
minimum(), setRange()

◆ minimum()

double minimum ( const QtProperty property) const

Returns the given property's minimum value.

See also
maximum(), setRange()

◆ rangeChanged

void rangeChanged ( QtProperty property,
double  minimum,
double  maximum 
)
signal

This signal is emitted whenever a property created by this manager changes its range of valid values, passing a pointer to the property and the new minimum and maximum values

See also
setRange()

◆ setDecimals

void setDecimals ( QtProperty property,
int  prec 
)
slot

Sets the precision of the given property to prec.

The valid decimal range is 0-13. The default is 2.

See also
decimals()

◆ setMaximum

void setMaximum ( QtProperty property,
double  maxVal 
)
slot

Sets the maximum value for the given property to maxVal.

When setting the maximum value, the minimum and current values are adjusted if necessary (ensuring that the range remains valid and that the current value is within in the range).

See also
maximum(), setRange(), rangeChanged()

◆ setMinimum

void setMinimum ( QtProperty property,
double  minVal 
)
slot

Sets the minimum value for the given property to minVal.

When setting the minimum value, the maximum and current values are adjusted if necessary (ensuring that the range remains valid and that the current value is within in the range).

See also
minimum(), setRange(), rangeChanged()

◆ setRange

void setRange ( QtProperty property,
double  minimum,
double  maximum 
)
slot

Sets the range of valid values.

This is a convenience function defining the range of valid values in one go; setting the minimum and maximum values for the given property with a single function call.

When setting a new range, the current value is adjusted if necessary (ensuring that the value remains within range).

See also
setMinimum(), setMaximum(), rangeChanged()

◆ setSingleStep

void setSingleStep ( QtProperty property,
double  step 
)
slot

Sets the step value for the given property to step.

The step is typically used to increment or decrement a property value while pressing an arrow key.

See also
singleStep()

◆ setValue

void setValue ( QtProperty property,
double  value 
)
slot

Sets the value of the given property to value.

If the specified value is not valid according to the given property's range, the value is adjusted to the nearest valid value within the range.

See also
value(), setRange(), valueChanged()

◆ singleStep()

double singleStep ( const QtProperty property) const

Returns the given property's step value.

The step is typically used to increment or decrement a property value while pressing an arrow key.

See also
setSingleStep()

◆ singleStepChanged

void singleStepChanged ( QtProperty property,
double  step 
)
signal

This signal is emitted whenever a property created by this manager changes its single step property, passing a pointer to the property and the new step value

See also
setSingleStep()

◆ uninitializeProperty()

void uninitializeProperty ( QtProperty property)
protectedvirtual

This function is called just before the specified property is destroyed.

The purpose is to let the property manager know that the property is being destroyed so that it can remove the property's additional attributes.

See also
clear(), propertyDestroyed()

Reimplemented from QtAbstractPropertyManager.

◆ value()

double value ( const QtProperty property) const

Returns the given property's value.

If the given property is not managed by this manager, this function returns 0.

See also
setValue()

◆ valueChanged

void valueChanged ( QtProperty property,
double  value 
)
signal

This signal is emitted whenever a property created by this manager changes its value, passing a pointer to the property and the new value as parameters.

See also
setValue()

◆ valueText()

QString valueText ( const QtProperty property) const
protectedvirtual

Returns a string representing the current state of the given property.

The default implementation of this function returns an empty string.

See also
QtProperty::valueText()

Reimplemented from QtAbstractPropertyManager.