CustusX  22.04-rc5
An IGT application
cx::BoolProperty Class Reference

#include <cxBoolProperty.h>

Inheritance diagram for cx::BoolProperty:
cx::BoolPropertyBase 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

virtual ~BoolProperty ()
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QString getUid () const
 
virtual bool setValue (bool value)
 set the data value. More...
 
virtual bool 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...
 
void setHelp (QString val)
 
- Public Member Functions inherited from cx::BoolPropertyBase
virtual ~BoolPropertyBase ()
 
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 BoolPropertyPtr initialize (const QString &uid, QString name, QString help, bool 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 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

Property for boolean values.

Definition at line 40 of file cxBoolProperty.h.

Constructor & Destructor Documentation

virtual cx::BoolProperty::~BoolProperty ( )
inlinevirtual

Definition at line 44 of file cxBoolProperty.h.

Member Function Documentation

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

name of data entity. Used for display to user.

Implements cx::BoolPropertyBase.

Definition at line 42 of file cxBoolProperty.cpp.

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

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

Reimplemented from cx::BoolPropertyBase.

Definition at line 53 of file cxBoolProperty.cpp.

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

Implements cx::Property.

Definition at line 48 of file cxBoolProperty.cpp.

bool cx::BoolProperty::getValue ( ) const
virtual

get the data value.

Implements cx::BoolPropertyBase.

Definition at line 64 of file cxBoolProperty.cpp.

BoolPropertyPtr cx::BoolProperty::initialize ( const QString &  uid,
QString  name,
QString  help,
bool  value,
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 cxBoolProperty.cpp.

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

Definition at line 58 of file cxBoolProperty.cpp.

bool cx::BoolProperty::setValue ( bool  value)
virtual

set the data value.

Implements cx::BoolPropertyBase.

Definition at line 69 of file cxBoolProperty.cpp.

void cx::BoolProperty::valueWasSet ( )
signal

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