#include <cxDoublePropertyBase.h>

Inheritance diagram for cx::DoublePropertyBase:

Public Types
enum	GuiRepresentation { grSPINBOX, grSLIDER, grDIAL }

Public Member Functions
	DoublePropertyBase ()

virtual	~DoublePropertyBase ()

virtual QString	getDisplayName () const =0
	name of data entity. Used for display to user. More...

virtual QVariant	getValueAsVariant () const

virtual void	setValueFromVariant (QVariant val)

virtual QString	getUid () const

virtual bool	setValue (double value)=0
	set the data value. More...

virtual double	getValue () const =0
	get the data value. More...

virtual void	setGuiRepresentation (GuiRepresentation type)

virtual GuiRepresentation	getGuiRepresentation ()

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 double	convertInternal2Display (double internal)
	range of value More...

virtual double	convertDisplay2Internal (double display)
	conversion from internal value to display value More...

virtual int	getValueDecimals () const
	number of relevant decimals in value More...

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...

Protected Attributes
GuiRepresentation	mGuiRepresentation

Protected Attributes inherited from cx::Property
bool	mEnabled

bool	mAdvanced

QString	mGroup

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

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

Static Public Member Functions inherited from cx::Property
static PropertyPtr	findProperty (std::vector< PropertyPtr > properties, QString id)

Detailed Description

Abstract interface for interaction with internal double-valued data

The class provides a bridge between general user interface code and specific data structures. An implementation connects to a single data value.

Minimal implementation:

    virtual QString getDisplayName() const;
    virtual bool setValue(double value);
    virtual double getValue() const;
    void changed();

By implementing these methods you can set and get values, and the data has a name. The changed() signal is used to make sure the user interface is updated even when data is changed by some other source.

For more control use the methods:

    virtual DoubleRange getValueRange() const;
    virtual int getValueDecimals() const;

If there is a difference between the internal data representation and how you want to present them, use:

    virtual double convertInternal2Display(double internal);
    virtual double convertDisplay2Internal(double display);

When testing, or during development, you can use the DoublePropertyNull as a dummy implementation.

Definition at line 91 of file cxDoublePropertyBase.h.

Member Enumeration Documentation

enum cx::DoublePropertyBase::GuiRepresentation

Enumerator
grSPINBOX
grSLIDER
grDIAL

Definition at line 99 of file cxDoublePropertyBase.h.

Constructor & Destructor Documentation

cx::DoublePropertyBase::DoublePropertyBase ( )

inline

Definition at line 95 of file cxDoublePropertyBase.h.

virtual cx::DoublePropertyBase::~DoublePropertyBase ( )

inlinevirtual

Definition at line 96 of file cxDoublePropertyBase.h.

Member Function Documentation

virtual double cx::DoublePropertyBase::convertDisplay2Internal ( double display )

inlinevirtual

conversion from internal value to display value

Reimplemented in cx::DoubleProperty, and cx::Vector3DComponentProperty.

Definition at line 140 of file cxDoublePropertyBase.h.

virtual double cx::DoublePropertyBase::convertInternal2Display ( double internal )

inlinevirtual

range of value

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

Reimplemented in cx::DoubleProperty, and cx::Vector3DComponentProperty.

Definition at line 136 of file cxDoublePropertyBase.h.

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

pure virtual

virtual GuiRepresentation cx::DoublePropertyBase::getGuiRepresentation ( )

inlinevirtual

Definition at line 124 of file cxDoublePropertyBase.h.

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

inlinevirtual

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

Reimplemented in cx::DoublePropertyZDim, cx::DoublePropertyYDim, cx::DoublePropertyXDim, cx::DoublePropertyToolOffset, cx::DoubleProperty, cx::DoublePropertySpacing, cx::DoublePropertyActiveToolOffset, cx::Vector3DComponentProperty, and cx::DoublePropertyTimeCalibration.

Definition at line 128 of file cxDoublePropertyBase.h.

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

inlinevirtual

Implements cx::Property.

Reimplemented in cx::DoubleProperty.

Definition at line 119 of file cxDoublePropertyBase.h.

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

pure virtual

get the data value.

Implemented in cx::DoublePropertyNull, cx::DoublePropertyActiveImageBase, cx::DoublePropertyShadingSpecularPower, cx::DoublePropertyShadingSpecular, cx::DoublePropertyToolOffset, cx::DoublePropertyShadingDiffuse, cx::DoubleProperty, cx::DoublePropertyShadingAmbient, cx::DoublePropertyActiveToolOffset, cx::DoublePropertyImageTFDataBase, cx::Vector3DComponentProperty, cx::DoublePropertyOutputValueParams, and cx::DoublePropertyTimeCalibration.

virtual QVariant cx::DoublePropertyBase::getValueAsVariant ( ) const

inlinevirtual

Implements cx::Property.

Definition at line 109 of file cxDoublePropertyBase.h.

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

inlinevirtual

number of relevant decimals in value

Reimplemented in cx::DoubleProperty, cx::DoublePropertySpacing, and cx::Vector3DComponentProperty.

Definition at line 144 of file cxDoublePropertyBase.h.

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

inlinevirtual

virtual void cx::DoublePropertyBase::setGuiRepresentation ( GuiRepresentation type )

inlinevirtual

Definition at line 123 of file cxDoublePropertyBase.h.

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

pure virtual

set the data value.

Implemented in cx::DoublePropertyNull, cx::DoublePropertyActiveImageBase, cx::DoublePropertyShadingSpecularPower, cx::DoublePropertyShadingSpecular, cx::DoublePropertyToolOffset, cx::DoublePropertyShadingDiffuse, cx::DoubleProperty, cx::DoublePropertyShadingAmbient, cx::DoublePropertyActiveToolOffset, cx::DoublePropertyImageTFDataBase, cx::DoublePropertyOutputValueParams, cx::Vector3DComponentProperty, and cx::DoublePropertyTimeCalibration.

virtual void cx::DoublePropertyBase::setValueFromVariant ( QVariant val )

inlinevirtual

Implements cx::Property.

Definition at line 113 of file cxDoublePropertyBase.h.

Member Data Documentation

GuiRepresentation cx::DoublePropertyBase::mGuiRepresentation

protected

Definition at line 150 of file cxDoublePropertyBase.h.

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

/media/jenkins/bamboo/buildagent/xml-data/build-dir/FX-RE-JOB1/CX/CX/source/resource/core/properties/cxDoublePropertyBase.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation