CustusX  22.04-rc5
An IGT application
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
cx::Property Class Referenceabstract
CustusX System » Resource Layer » Core » Property

Superclass for all data adapters. More...

#include <cxProperty.h>

Inheritance diagram for cx::Property:
cx::BoolPropertyBase cx::ColorPropertyBase cx::DoublePairPropertyBase cx::DoublePropertyBase cx::FilePathPropertyBase cx::PropertyNull cx::SpacePropertyBase cx::StringListProperty cx::StringPropertyBase cx::Vector3DPropertyBase

Public Slots

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

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

Public Member Functions

 Property ()
 
virtual ~Property ()
 
virtual QString getDisplayName () const =0
 name of data entity. Used for display to user. More...
 
virtual QString getUid () const =0
 
virtual QVariant getValueAsVariant () const =0
 
virtual void setValueFromVariant (QVariant val)=0
 
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 PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

Protected Attributes

bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Superclass for all data adapters.

The Property are an abstraction mechanism that separates data values from the user interface. Properties for strings, doubles, booleans and so on publish their value in a generic manner, thus enabling us to write generic widgets for displaying and changing them.

Author
Christian Askeland, SINTEF
Janne Beate Bakeng, SINTEF
Date
Jun 27, 2010

Definition at line 43 of file cxProperty.h.

Constructor & Destructor Documentation

cx::Property::Property ( )

Definition at line 18 of file cxProperty.cpp.

virtual cx::Property::~Property ( )
inlinevirtual

Definition at line 49 of file cxProperty.h.

Member Function Documentation

void cx::Property::changed ( )
signal

emit when the underlying data value is changed: The user interface will be updated.

PropertyPtr cx::Property::findProperty ( std::vector< PropertyPtr >  properties,
QString  id 
)
static

Definition at line 23 of file cxProperty.cpp.

bool cx::Property::getAdvanced ( ) const
virtual

Get the advanced flag of the adapter.

Reimplemented in cx::PropertyNull.

Definition at line 41 of file cxProperty.cpp.

virtual QString cx::Property::getDisplayName ( ) const
pure virtual

name of data entity. Used for display to user.

Implemented in cx::StringPropertyGlyphLUT, cx::StringPropertyGlyphColorArray, cx::StringPropertyGlyphOrientationArray, cx::StringPropertyImageType, cx::StringPropertyDataModality, cx::StringPropertyDataUidEditable, cx::StringPropertyDataNameEditable, cx::StringPropertyParentFrame, cx::DoublePropertyNull, cx::DoubleProperty2DLevel, cx::DoubleProperty2DWindow, cx::DoublePropertyImageTFDataAlpha, cx::DoublePropertyZDim, cx::DoublePropertyImageTFDataLLR, cx::DoublePropertyShadingSpecularPower, cx::DoubleSpanSliderAdapterNull, cx::Vector3DPropertyNull, cx::DoublePropertyYDim, cx::DoublePropertyBase, cx::DoublePropertyImageTFDataLevel, cx::DoublePropertyShadingSpecular, cx::StringPropertyBase, cx::DoublePropertyXDim, cx::DoublePropertyToolOffset, cx::DoublePropertyImageTFDataWindow, cx::StringPropertyActiveProbeConfiguration, cx::DoublePropertyShadingDiffuse, cx::StringPropertySelectRecordSession, cx::FilePathPropertyBase, cx::StringPropertySelectCoordinateSystem, cx::DoublePropertySpacing, cx::DoubleProperty, cx::BoolProperty, cx::DoublePropertyShadingAmbient, cx::DoublePairProperty, cx::Vector3DProperty, cx::StringPropertySelectTool, cx::StringProperty, cx::ColorProperty, cx::DoublePropertyActiveToolOffset, cx::Vector3DPropertyBase, cx::StringPropertyFusedInputOutputSelectData, cx::SpaceProperty, cx::StringListProperty, cx::DoublePairPropertyBase, cx::StringPropertyActiveTool, cx::Vector3DComponentProperty, cx::StringPropertyClipPlane, cx::ColorPropertyBase, cx::SelectDataStringPropertyBase, cx::SpacePropertyBase, cx::BoolPropertyBase, cx::DoublePropertyTimeCalibration, cx::StringPropertyActiveVideoSource, and cx::PropertyNull.

bool cx::Property::getEnabled ( ) const
virtual

Get the enabled/disabled state of the Property.

Reimplemented in cx::PropertyNull.

Definition at line 36 of file cxProperty.cpp.

QString cx::Property::getGroup ( ) const
virtual

Flag the adapter as part of a group.

Reimplemented in cx::PropertyNull.

Definition at line 46 of file cxProperty.cpp.

virtual QString cx::Property::getUid ( ) const
pure virtual

Implemented in cx::DoublePropertyBase, cx::StringPropertyBase, cx::FilePathPropertyBase, cx::DoubleProperty, cx::BoolProperty, cx::DoublePairProperty, cx::Vector3DProperty, cx::StringProperty, cx::SpacePropertyBase, cx::ColorProperty, cx::SpaceProperty, cx::StringListProperty, cx::FilePathProperty, and cx::PropertyNull.

virtual QVariant cx::Property::getValueAsVariant ( ) const
pure virtual

Implemented in cx::DoublePropertyBase, cx::StringPropertyBase, cx::FilePathPropertyBase, cx::DoublePairPropertyBase, cx::Vector3DPropertyBase, cx::StringListProperty, cx::ColorPropertyBase, cx::FilePathProperty, cx::SpacePropertyBase, cx::BoolPropertyBase, and cx::PropertyNull.

bool cx::Property::setAdvanced ( bool  advanced)
virtualslot

Set the advanced flag of the adapter.

Reimplemented in cx::PropertyNull.

Definition at line 63 of file cxProperty.cpp.

bool cx::Property::setEnabled ( bool  enabled)
virtualslot

Set the enabled/disabled state of the Property.

Reimplemented in cx::PropertyNull.

Definition at line 51 of file cxProperty.cpp.

bool cx::Property::setGroup ( QString  name)
virtualslot

Flag the adapter as part of a group.

Reimplemented in cx::PropertyNull.

Definition at line 74 of file cxProperty.cpp.

virtual void cx::Property::setValueFromVariant ( QVariant  val)
pure virtual

Implemented in cx::DoublePropertyBase, cx::StringPropertyBase, cx::FilePathPropertyBase, cx::DoublePairPropertyBase, cx::Vector3DPropertyBase, cx::ColorPropertyBase, cx::StringListProperty, cx::SpacePropertyBase, cx::BoolPropertyBase, cx::FilePathProperty, and cx::PropertyNull.

Member Data Documentation

bool cx::Property::mAdvanced
protected

Definition at line 74 of file cxProperty.h.

bool cx::Property::mEnabled
protected

Definition at line 73 of file cxProperty.h.

QString cx::Property::mGroup
protected

Definition at line 75 of file cxProperty.h.

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