Fraxinus  2023.01.05-dev+develop.0da12
An IGT application
cx::DoubleProperty Class Reference

#include <cxDoubleProperty.h>

Inheritance diagram for cx::DoubleProperty:
cx::DoublePropertyBase cx::Property

Signals

void valueWasSet ()
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 

Public Member Functions

void setInternal2Display (double factor)
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QString getUid () const
 
virtual bool setValue (double value)
 set the data value. More...
 
virtual double getValue () const
 get the data value. More...
 
virtual QString getHelp () const
 return a descriptive help string for the data, used for example as a tool tip. More...
 
virtual DoubleRange getValueRange () const
 
virtual void setValueRange (DoubleRange range)
 range of value. Use if data is constrained to a set. More...
 
virtual int getValueDecimals () const
 number of relevant decimals in value More...
 
virtual double convertInternal2Display (double internal)
 conversion from internal value to display value (for example between 0..1 and percent) More...
 
virtual double convertDisplay2Internal (double display)
 conversion from internal value to display value More...
 
- Public Member Functions inherited from cx::DoublePropertyBase
 DoublePropertyBase ()
 
virtual ~DoublePropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual void setGuiRepresentation (GuiRepresentation type)
 
virtual GuiRepresentation getGuiRepresentation ()
 
- Public Member Functions inherited from cx::Property
 Property ()
 
virtual ~Property ()
 
virtual bool getEnabled () const
 Get the enabled/disabled state of the Property. More...
 
virtual bool getAdvanced () const
 Get the advanced flag of the adapter. More...
 
virtual QString getGroup () const
 Flag the adapter as part of a group. More...
 

Static Public Member Functions

static DoublePropertyPtr initialize (const QString &uid, QString name, QString help, double value, DoubleRange range, int decimals, QDomNode root=QDomNode())
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

Additional Inherited Members

- Public Types inherited from cx::DoublePropertyBase
enum  GuiRepresentation { grSPINBOX, grSLIDER, grDIAL }
 
- Public Slots inherited from cx::Property
virtual bool setEnabled (bool enabled)
 Set the enabled/disabled state of the Property. More...
 
virtual bool setAdvanced (bool advanced)
 Set the advanced flag of the adapter. More...
 
virtual bool setGroup (QString name)
 Flag the adapter as part of a group. More...
 
- Protected Attributes inherited from cx::DoublePropertyBase
GuiRepresentation mGuiRepresentation
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Implementation of DoublePropertyBase.

Represents one option of the double type. The data are stored within a xml document.

The option node has this layout:

 <option id="Processor" value="3.14"/>

Definition at line 48 of file cxDoubleProperty.h.

Member Function Documentation

virtual double cx::DoubleProperty::convertDisplay2Internal ( double  display)
inlinevirtual

conversion from internal value to display value

Reimplemented from cx::DoublePropertyBase.

Definition at line 73 of file cxDoubleProperty.h.

virtual double cx::DoubleProperty::convertInternal2Display ( double  internal)
inlinevirtual

conversion from internal value to display value (for example between 0..1 and percent)

Reimplemented from cx::DoublePropertyBase.

Definition at line 69 of file cxDoubleProperty.h.

QString cx::DoubleProperty::getDisplayName ( ) const
virtual

name of data entity. Used for display to user.

Implements cx::DoublePropertyBase.

Definition at line 49 of file cxDoubleProperty.cpp.

QString cx::DoubleProperty::getHelp ( ) const
virtual

return a descriptive help string for the data, used for example as a tool tip.

Reimplemented from cx::DoublePropertyBase.

Definition at line 59 of file cxDoubleProperty.cpp.

QString cx::DoubleProperty::getUid ( ) const
virtual

Reimplemented from cx::DoublePropertyBase.

Definition at line 54 of file cxDoubleProperty.cpp.

double cx::DoubleProperty::getValue ( ) const
virtual

get the data value.

Implements cx::DoublePropertyBase.

Definition at line 64 of file cxDoubleProperty.cpp.

int cx::DoubleProperty::getValueDecimals ( ) const
virtual

number of relevant decimals in value

Reimplemented from cx::DoublePropertyBase.

Definition at line 92 of file cxDoubleProperty.cpp.

DoubleRange cx::DoubleProperty::getValueRange ( ) const
virtual

Reimplemented from cx::DoublePropertyBase.

Definition at line 81 of file cxDoubleProperty.cpp.

DoublePropertyPtr cx::DoubleProperty::initialize ( const QString &  uid,
QString  name,
QString  help,
double  value,
DoubleRange  range,
int  decimals,
QDomNode  root = QDomNode() 
)
static

Make sure one given option exists witin root. If not present, fill inn the input defaults.

Definition at line 30 of file cxDoubleProperty.cpp.

void cx::DoubleProperty::setInternal2Display ( double  factor)

Definition at line 44 of file cxDoubleProperty.cpp.

bool cx::DoubleProperty::setValue ( double  value)
virtual

set the data value.

Implements cx::DoublePropertyBase.

Definition at line 69 of file cxDoubleProperty.cpp.

void cx::DoubleProperty::setValueRange ( DoubleRange  range)
virtual

range of value. Use if data is constrained to a set.

Definition at line 86 of file cxDoubleProperty.cpp.

void cx::DoubleProperty::valueWasSet ( )
signal

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