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

#include <cxStringProperty.h>

Inheritance diagram for cx::StringProperty:

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
virtual QString	getDisplayName () const
	name of data entity. Used for display to user. More...

virtual QString	getUid () const

virtual bool	setValue (const QString &value)
	set the data value. More...

virtual QString	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 of value. Use if data is constrained to a set. 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 bool	isReadOnly () const

virtual bool	getAllowOnlyValuesInRange () const

void	setReadOnly (bool val)

virtual void	setDisplayName (QString val)

Public Member Functions inherited from cx::StringPropertyBase
	StringPropertyBase ()

virtual	~StringPropertyBase ()

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 StringPropertyPtr	initialize (const QString &uid, QString name, QString help, QString value, QStringList range, QDomNode root=QDomNode())

static StringPropertyPtr	initialize (const QString &uid, QString name, QString help, QString value, 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::StringPropertyBase
enum	GuiRepresentation { grSTRING, grFILENAME }

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::StringPropertyBase
GuiRepresentation	mGuiRepresentation

Protected Attributes inherited from cx::Property
bool	mEnabled

bool	mAdvanced

QString	mGroup

Detailed Description

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

The option node has this layout:

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

Definition at line 38 of file cxStringProperty.h.

Member Function Documentation

◆ convertInternal2Display()

QString cx::StringProperty::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 118 of file cxStringProperty.cpp.

◆ getAllowOnlyValuesInRange()

virtual bool cx::StringProperty::getAllowOnlyValuesInRange ( ) const

inlinevirtual

Reimplemented from cx::StringPropertyBase.

Definition at line 63 of file cxStringProperty.h.

◆ getDisplayName()

QString cx::StringProperty::getDisplayName ( ) const

virtual

name of data entity. Used for display to user.

Implements cx::StringPropertyBase.

Definition at line 62 of file cxStringProperty.cpp.

◆ getDisplayNames()

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

inlinevirtual

Definition at line 60 of file cxStringProperty.h.

◆ getHelp()

QString cx::StringProperty::getHelp ( ) const

virtual

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

Definition at line 72 of file cxStringProperty.cpp.

◆ getUid()

QString cx::StringProperty::getUid ( ) const

virtual

Reimplemented from cx::StringPropertyBase.

Definition at line 67 of file cxStringProperty.cpp.

◆ getValue()

QString cx::StringProperty::getValue ( ) const

virtual

get the data value.

Implements cx::StringPropertyBase.

Definition at line 87 of file cxStringProperty.cpp.

◆ getValueRange()

QStringList cx::StringProperty::getValueRange ( ) const

virtual

Reimplemented from cx::StringPropertyBase.

Definition at line 104 of file cxStringProperty.cpp.

◆ initialize() [1/2]

StringPropertyPtr cx::StringProperty::initialize	(	const QString &	uid,
		QString	name,
		QString	help,
		QString	value,
		QDomNode	root = `QDomNode()`
	)

static

Definition at line 37 of file cxStringProperty.cpp.

◆ initialize() [2/2]

StringPropertyPtr cx::StringProperty::initialize	(	const QString &	uid,
		QString	name,
		QString	help,
		QString	value,
		QStringList	range,
		QDomNode	root = `QDomNode()`
	)

static

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

Definition at line 29 of file cxStringProperty.cpp.

◆ isReadOnly()

virtual bool cx::StringProperty::isReadOnly ( ) const

inlinevirtual

Reimplemented from cx::StringPropertyBase.

Definition at line 62 of file cxStringProperty.h.

◆ setDisplayName()

void cx::StringProperty::setDisplayName ( QString val )

virtual

Definition at line 55 of file cxStringProperty.cpp.

◆ setDisplayNames()

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

virtual

Definition at line 125 of file cxStringProperty.cpp.

◆ setHelp()

void cx::StringProperty::setHelp ( QString val )

virtual

Definition at line 77 of file cxStringProperty.cpp.

◆ setReadOnly()

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

Definition at line 49 of file cxStringProperty.cpp.

◆ setValue()

bool cx::StringProperty::setValue ( const QString & value )

virtual

set the data value.

Implements cx::StringPropertyBase.

Definition at line 92 of file cxStringProperty.cpp.

◆ setValueRange()

void cx::StringProperty::setValueRange ( QStringList range )

virtual

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

Definition at line 109 of file cxStringProperty.cpp.

◆ valueWasSet

void cx::StringProperty::valueWasSet ( )

signal

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

/mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-RE-BU2/CX/CX/source/resource/core/properties/cxStringProperty.h
/mnt/bamboo/bamboo/buildagent/xml-data/build-dir/NN-RE-BU2/CX/CX/source/resource/core/properties/cxStringProperty.cpp

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ convertInternal2Display()

◆ getAllowOnlyValuesInRange()

◆ getDisplayName()

◆ getDisplayNames()

◆ getHelp()

◆ getUid()

◆ getValue()

◆ getValueRange()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isReadOnly()

◆ setDisplayName()

◆ setDisplayNames()

◆ setHelp()

◆ setReadOnly()

◆ setValue()

◆ setValueRange()

◆ valueWasSet