QtDoublePropertyManager Class Reference

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

#include <ArmarXGui/libraries/qtpropertybrowser/src/qtpropertymanager.h>

+ Inheritance diagram for QtDoublePropertyManager:

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 setReadOnly (QtProperty *property, bool readOnly)
 
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 readOnlyChanged (QtProperty *property, bool readOnly)
 
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

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

Protected Member Functions

void initializeProperty (QtProperty *property) override
 
void uninitializeProperty (QtProperty *property) override
 
QString valueText (const QtProperty *property) const override
 
- 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 QIcon valueIcon (const QtProperty *property) const
 

Detailed Description

The QtDoublePropertyManager provides and manages double properties.

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

Definition at line 136 of file qtpropertymanager.h.

Constructor & Destructor Documentation

◆ QtDoublePropertyManager()

QtDoublePropertyManager ( QObject *  parent = 0)

Creates a manager with the given parent.

Definition at line 1184 of file qtpropertymanager.cpp.

◆ ~QtDoublePropertyManager()

~QtDoublePropertyManager ( )
override

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

Definition at line 1194 of file qtpropertymanager.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ decimals()

int decimals ( const QtProperty property) const

Returns the given property's precision, in decimals.

See also
setDecimals()

Definition at line 1250 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()
+ Here is the caller graph for this function:

◆ initializeProperty()

void initializeProperty ( QtProperty property)
overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyManager.

Definition at line 1469 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ isReadOnly()

bool isReadOnly ( const QtProperty property) const

Returns read-only status of the property.

When property is read-only it's value can be selected and copied from editor but not modified.

See also
QtDoublePropertyManager::setReadOnly

Definition at line 1262 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ maximum()

double maximum ( const QtProperty property) const

Returns the given property's maximum value.

See also
minimum(), setRange()

Definition at line 1228 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ minimum()

double minimum ( const QtProperty property) const

Returns the given property's minimum value.

See also
maximum(), setRange()

Definition at line 1218 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()
+ Here is the caller graph for this function:

◆ readOnlyChanged

void readOnlyChanged ( QtProperty property,
bool  readOnly 
)
signal
+ Here is the caller graph for this function:

◆ 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()

Definition at line 1374 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()

Definition at line 1433 of file qtpropertymanager.cpp.

◆ 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()

Definition at line 1415 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()

Definition at line 1456 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ setReadOnly

void setReadOnly ( QtProperty property,
bool  readOnly 
)
slot

Sets read-only status of the property.

See also
QtDoublePropertyManager::setReadOnly

Definition at line 1342 of file qtpropertymanager.cpp.

◆ 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()

Definition at line 1309 of file qtpropertymanager.cpp.

◆ 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()

Definition at line 1293 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()

Definition at line 1240 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()
+ Here is the caller graph for this function:

◆ uninitializeProperty()

void uninitializeProperty ( QtProperty property)
overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 1477 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()

Definition at line 1208 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

◆ 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()
+ Here is the caller graph for this function:

◆ valueText()

QString valueText ( const QtProperty property) const
overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 1270 of file qtpropertymanager.cpp.

+ Here is the caller graph for this function:

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