CustusX  2023.01.05-dev+develop.0da12
An IGT application
Public Member Functions | Static Public Member Functions | List of all members
cx::StringPropertySelectTool Class Reference

Adapter that selects and stores a tool. The tool is stored internally in the adapter. Use setValue/getValue plus changed() to access it. More...

#include <cxStringPropertySelectTool.h>

Inheritance diagram for cx::StringPropertySelectTool:
cx::StringPropertyBase cx::Property

Public Member Functions

 StringPropertySelectTool (TrackingServicePtr trackingService)
 
virtual ~StringPropertySelectTool ()
 
void setHelp (QString help)
 
void setValueName (QString name)
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual bool setValue (const QString &value)
 set the data value. More...
 
virtual QString getValue () const
 get the data value. More...
 
virtual QStringList getValueRange () const
 
virtual QString convertInternal2Display (QString internal)
 range of value. Use if data is constrained to a set. More...
 
virtual QString getHelp () const
 return a descriptive help string for the data, used for example as a tool tip. More...
 
ToolPtr getTool () const
 
bool isActiveToolSelected () const
 
void provideActiveTool (bool on)
 
void setActiveTool ()
 
- Public Member Functions inherited from cx::StringPropertyBase
 StringPropertyBase ()
 
virtual ~StringPropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual QString getUid () const
 
virtual bool isReadOnly () const
 
virtual bool getAllowOnlyValuesInRange () const
 
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 StringPropertySelectToolPtr New (TrackingServicePtr trackingService)
 
- 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...
 
- 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::StringPropertyBase
GuiRepresentation mGuiRepresentation
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Adapter that selects and stores a tool. The tool is stored internally in the adapter. Use setValue/getValue plus changed() to access it.

Definition at line 36 of file cxStringPropertySelectTool.h.

Constructor & Destructor Documentation

cx::StringPropertySelectTool::StringPropertySelectTool ( TrackingServicePtr  trackingService)

Definition at line 24 of file cxStringPropertySelectTool.cpp.

virtual cx::StringPropertySelectTool::~StringPropertySelectTool ( )
inlinevirtual

Definition at line 45 of file cxStringPropertySelectTool.h.

Member Function Documentation

QString cx::StringPropertySelectTool::convertInternal2Display ( QString  internal)
virtual

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

conversion from internal value to display value

Reimplemented from cx::StringPropertyBase.

Definition at line 117 of file cxStringPropertySelectTool.cpp.

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

name of data entity. Used for display to user.

Implements cx::StringPropertyBase.

Definition at line 45 of file cxStringPropertySelectTool.cpp.

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

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

Reimplemented from cx::StringPropertyBase.

Definition at line 86 of file cxStringPropertySelectTool.cpp.

ToolPtr cx::StringPropertySelectTool::getTool ( ) const

Definition at line 91 of file cxStringPropertySelectTool.cpp.

QString cx::StringPropertySelectTool::getValue ( ) const
virtual

get the data value.

Implements cx::StringPropertyBase.

Definition at line 77 of file cxStringPropertySelectTool.cpp.

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

Reimplemented from cx::StringPropertyBase.

Definition at line 103 of file cxStringPropertySelectTool.cpp.

bool cx::StringPropertySelectTool::isActiveToolSelected ( ) const

Definition at line 98 of file cxStringPropertySelectTool.cpp.

static StringPropertySelectToolPtr cx::StringPropertySelectTool::New ( TrackingServicePtr  trackingService)
inlinestatic

Definition at line 40 of file cxStringPropertySelectTool.h.

void cx::StringPropertySelectTool::provideActiveTool ( bool  on)

Definition at line 129 of file cxStringPropertySelectTool.cpp.

void cx::StringPropertySelectTool::setActiveTool ( )

Definition at line 134 of file cxStringPropertySelectTool.cpp.

void cx::StringPropertySelectTool::setHelp ( QString  help)

Definition at line 35 of file cxStringPropertySelectTool.cpp.

bool cx::StringPropertySelectTool::setValue ( const QString &  value)
virtual

set the data value.

Implements cx::StringPropertyBase.

Definition at line 50 of file cxStringPropertySelectTool.cpp.

void cx::StringPropertySelectTool::setValueName ( QString  name)

Definition at line 40 of file cxStringPropertySelectTool.cpp.

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