NorMIT-nav  22.09
An IGT application
Signals | Public Member Functions | Static Public Member Functions | List of all members
cx::SpaceProperty Class Reference
Core » Property

#include <cxSpaceProperty.h>

Inheritance diagram for cx::SpaceProperty:
cx::SpacePropertyBase 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 setSpaceProvider (SpaceProviderPtr provider)
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QString getUid () const
 
virtual bool setValue (const Space &value)
 set the data value. More...
 
virtual Space 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 void setHelp (QString val)
 
virtual std::vector< Space > getValueRange () const
 
virtual void setValueRange (std::vector< Space > range)
 range of value. Use if data is constrained to a set. More...
 
virtual QString convertRefObjectInternal2Display (QString internal)
 conversion from internal value to display value More...
 
virtual void setRefObjectDisplayNames (std::map< QString, QString > names)
 
virtual bool isReadOnly () const
 
virtual bool getAllowOnlyValuesInRange () const
 
void setReadOnly (bool val)
 
- Public Member Functions inherited from cx::SpacePropertyBase
 SpacePropertyBase ()
 
virtual ~SpacePropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
- 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 SpacePropertyPtr initialize (const QString &uid, QString name, QString help, Space value=Space(), std::vector< Space > range=std::vector< Space >(), QDomNode root=QDomNode())
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

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...
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Definition at line 30 of file cxSpaceProperty.h.

Member Function Documentation

◆ convertRefObjectInternal2Display()

QString cx::SpaceProperty::convertRefObjectInternal2Display ( QString  internal)
virtual

conversion from internal value to display value

If a mapping from internal name to display name has been set, use it. Otherwise return the input.

Reimplemented from cx::SpacePropertyBase.

Definition at line 122 of file cxSpaceProperty.cpp.

◆ getAllowOnlyValuesInRange()

virtual bool cx::SpaceProperty::getAllowOnlyValuesInRange ( ) const
inlinevirtual

Reimplemented from cx::SpacePropertyBase.

Definition at line 55 of file cxSpaceProperty.h.

◆ getDisplayName()

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

name of data entity. Used for display to user.

Implements cx::SpacePropertyBase.

Definition at line 66 of file cxSpaceProperty.cpp.

◆ getHelp()

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

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

Definition at line 76 of file cxSpaceProperty.cpp.

◆ getUid()

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

Reimplemented from cx::SpacePropertyBase.

Definition at line 71 of file cxSpaceProperty.cpp.

◆ getValue()

Space cx::SpaceProperty::getValue ( ) const
virtual

get the data value.

Implements cx::SpacePropertyBase.

Definition at line 91 of file cxSpaceProperty.cpp.

◆ getValueRange()

std::vector< Space > cx::SpaceProperty::getValueRange ( ) const
virtual

Reimplemented from cx::SpacePropertyBase.

Definition at line 108 of file cxSpaceProperty.cpp.

◆ initialize()

SpacePropertyPtr cx::SpaceProperty::initialize ( const QString &  uid,
QString  name,
QString  help,
Space  value = Space(),
std::vector< Space >  range = std::vector<Space>(),
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 cxSpaceProperty.cpp.

◆ isReadOnly()

virtual bool cx::SpaceProperty::isReadOnly ( ) const
inlinevirtual

Reimplemented from cx::SpacePropertyBase.

Definition at line 54 of file cxSpaceProperty.h.

◆ setHelp()

void cx::SpaceProperty::setHelp ( QString  val)
virtual

Definition at line 81 of file cxSpaceProperty.cpp.

◆ setReadOnly()

void cx::SpaceProperty::setReadOnly ( bool  val)

Definition at line 60 of file cxSpaceProperty.cpp.

◆ setRefObjectDisplayNames()

void cx::SpaceProperty::setRefObjectDisplayNames ( std::map< QString, QString >  names)
virtual

Definition at line 129 of file cxSpaceProperty.cpp.

◆ setSpaceProvider()

void cx::SpaceProperty::setSpaceProvider ( SpaceProviderPtr  provider)

Definition at line 43 of file cxSpaceProperty.cpp.

◆ setValue()

bool cx::SpaceProperty::setValue ( const Space &  value)
virtual

set the data value.

Implements cx::SpacePropertyBase.

Definition at line 96 of file cxSpaceProperty.cpp.

◆ setValueRange()

void cx::SpaceProperty::setValueRange ( std::vector< Space >  range)
virtual

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

Definition at line 113 of file cxSpaceProperty.cpp.

◆ valueWasSet

void cx::SpaceProperty::valueWasSet ( )
signal
The documentation for this class was generated from the following files: