CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::StringListProperty Class Reference

Represents one collection of strings. More...

#include <cxStringListProperty.h>

Inheritance diagram for cx::StringListProperty:
cx::Property

Public Member Functions

virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QString getUid () const
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual bool setValue (const QStringList &value)
 set the data value. More...
 
virtual QStringList 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 QStringList getValueRange () const
 
virtual void setValueRange (QStringList range)
 range that values can be selected from More...
 
virtual QString convertInternal2Display (QString internal)
 conversion from internal value to display value More...
 
virtual void setDisplayNames (std::map< QString, QString > names)
 
virtual std::map< QString, QString > getDisplayNames () const
 
virtual void setDisplayName (QString 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 StringListPropertyPtr initialize (const QString &uid, QString name, QString help, QStringList value, QStringList range, 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...
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Represents one collection of strings.

The collection can be selected from a range. The data can be stored within a xml document.

Definition at line 35 of file cxStringListProperty.h.

Member Function Documentation

QString cx::StringListProperty::convertInternal2Display ( 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.

Definition at line 112 of file cxStringListProperty.cpp.

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

name of data entity. Used for display to user.

Implements cx::Property.

Definition at line 43 of file cxStringListProperty.cpp.

virtual std::map<QString, QString> cx::StringListProperty::getDisplayNames ( ) const
inlinevirtual

Definition at line 56 of file cxStringListProperty.h.

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

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

Definition at line 53 of file cxStringListProperty.cpp.

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

Implements cx::Property.

Definition at line 48 of file cxStringListProperty.cpp.

QStringList cx::StringListProperty::getValue ( ) const
virtual

get the data value.

Definition at line 78 of file cxStringListProperty.cpp.

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

Implements cx::Property.

Definition at line 67 of file cxStringListProperty.cpp.

QStringList cx::StringListProperty::getValueRange ( ) const
virtual

Definition at line 98 of file cxStringListProperty.cpp.

StringListPropertyPtr cx::StringListProperty::initialize ( const QString &  uid,
QString  name,
QString  help,
QStringList  value,
QStringList  range,
QDomNode  root = QDomNode() 
)
static

Definition at line 25 of file cxStringListProperty.cpp.

void cx::StringListProperty::setDisplayName ( QString  val)
virtual

Definition at line 37 of file cxStringListProperty.cpp.

void cx::StringListProperty::setDisplayNames ( std::map< QString, QString >  names)
virtual

Definition at line 119 of file cxStringListProperty.cpp.

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

Definition at line 58 of file cxStringListProperty.cpp.

bool cx::StringListProperty::setValue ( const QStringList &  value)
virtual

set the data value.

Definition at line 83 of file cxStringListProperty.cpp.

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

Implements cx::Property.

Definition at line 72 of file cxStringListProperty.cpp.

void cx::StringListProperty::setValueRange ( QStringList  range)
virtual

range that values can be selected from

Definition at line 103 of file cxStringListProperty.cpp.


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