CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Attributes | Properties | List of all members
ctkBooleanMapper Class Reference

#include <Libs/Core/ctkBooleanMapper.h>

Inheritance diagram for ctkBooleanMapper:
Inheritance graph
[legend]
Collaboration diagram for ctkBooleanMapper:
Collaboration graph
[legend]

Public Slots

void setComplement (bool complement)
 
void setValue (bool value)
 
void setValueAsInt (int value)
 
void setValueAsString (const QString &value)
 
void toggle ()
 

Signals

void complementChanged (bool complement)
 
void valueAsIntChanged (int value)
 
void valueAsStringChanged (const QString &value)
 
void valueChanged (bool value)
 

Public Member Functions

bool complement () const
 
 ctkBooleanMapper (QObject *targetObject, const QByteArray &propertyName, const QByteArray &signal)
 
QVariant falseValue () const
 
QByteArray propertyName () const
 
void setFalseValue (const QVariant &value)
 
void setTrueValue (const QVariant &value)
 
QObject * targetObject () const
 The mapped object (the mapper parent) More...
 
QVariant trueValue () const
 
bool value () const
 
int valueAsInt () const
 
QString valueAsString () const
 
virtual ~ctkBooleanMapper ()
 

Protected Slots

void emitValueAsChanged ()
 
void emitValueChanged ()
 

Protected Attributes

QScopedPointer< ctkBooleanMapperPrivate > d_ptr
 

Properties

bool complement
 
QVariant falseValue
 0 by default More...
 
QByteArray propertyName
 This property contains the name of the object mapped property. More...
 
QVariant trueValue
 1 by default More...
 
bool value
 
int valueAsInt
 
QString valueAsString
 

Detailed Description

Example: QCheckBox* checkBox = new QCheckBox; ctkBooleanMapper* inverter = new ctkBooleanMapper("checked", SIGNAL("toggled(bool)"), checkBox); inverter->setComplementValue(true); // -> checkBox->checked() == false inverter->setValue(false); // -> checkBox->checked() == false

Python example: boolMapper = ctk.ctkBooleanMapper(checkBox, "checked", "toggled(bool)") boolMapper.trueValue = qt.QMessageBox.Yes boolMapper.falseValue = qt.QMessageBox.InvalidRole parent.registerProperty( "settingsPropertyName", boolMapper, "valueAsInt", qt.SIGNAL("valueAsIntChanged(int)"))

Definition at line 51 of file ctkBooleanMapper.h.

Constructor & Destructor Documentation

◆ ctkBooleanMapper()

ctkBooleanMapper::ctkBooleanMapper ( QObject *  targetObject,
const QByteArray &  propertyName,
const QByteArray &  signal 
)

Map the property property of the object. The mapper becomes a child of object and will be destructed when object is destructed. property and object must be valid and non empty. If signal is 0, valueChanged(bool) and complementChanged(bool) won't be fired.

◆ ~ctkBooleanMapper()

virtual ctkBooleanMapper::~ctkBooleanMapper ( )
virtual

Member Function Documentation

◆ complement()

bool ctkBooleanMapper::complement ( ) const

◆ complementChanged

void ctkBooleanMapper::complementChanged ( bool  complement)
signal

◆ emitValueAsChanged

void ctkBooleanMapper::emitValueAsChanged ( )
protectedslot

◆ emitValueChanged

void ctkBooleanMapper::emitValueChanged ( )
protectedslot

◆ falseValue()

QVariant ctkBooleanMapper::falseValue ( ) const

◆ propertyName()

QByteArray ctkBooleanMapper::propertyName ( ) const

◆ setComplement

void ctkBooleanMapper::setComplement ( bool  complement)
slot

◆ setFalseValue()

void ctkBooleanMapper::setFalseValue ( const QVariant &  value)

◆ setTrueValue()

void ctkBooleanMapper::setTrueValue ( const QVariant &  value)

◆ setValue

void ctkBooleanMapper::setValue ( bool  value)
slot

◆ setValueAsInt

void ctkBooleanMapper::setValueAsInt ( int  value)
slot

◆ setValueAsString

void ctkBooleanMapper::setValueAsString ( const QString &  value)
slot

◆ targetObject()

QObject* ctkBooleanMapper::targetObject ( ) const

The mapped object (the mapper parent)

◆ toggle

void ctkBooleanMapper::toggle ( )
slot

◆ trueValue()

QVariant ctkBooleanMapper::trueValue ( ) const

◆ value()

bool ctkBooleanMapper::value ( ) const

◆ valueAsInt()

int ctkBooleanMapper::valueAsInt ( ) const

◆ valueAsIntChanged

void ctkBooleanMapper::valueAsIntChanged ( int  value)
signal

◆ valueAsString()

QString ctkBooleanMapper::valueAsString ( ) const

◆ valueAsStringChanged

void ctkBooleanMapper::valueAsStringChanged ( const QString &  value)
signal

◆ valueChanged

void ctkBooleanMapper::valueChanged ( bool  value)
signal

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkBooleanMapperPrivate> ctkBooleanMapper::d_ptr
protected

Definition at line 117 of file ctkBooleanMapper.h.

Property Documentation

◆ complement

bool ctkBooleanMapper::complement
readwrite

This property is the complement of the mapped property. false if value is true and true if value is false

Definition at line 1 of file ctkBooleanMapper.h.

◆ falseValue

QVariant ctkBooleanMapper::falseValue
readwrite

0 by default

Definition at line 1 of file ctkBooleanMapper.h.

◆ propertyName

QByteArray ctkBooleanMapper::propertyName
read

This property contains the name of the object mapped property.

Definition at line 1 of file ctkBooleanMapper.h.

◆ trueValue

QVariant ctkBooleanMapper::trueValue
readwrite

1 by default

Definition at line 1 of file ctkBooleanMapper.h.

◆ value

bool ctkBooleanMapper::value
readwrite

This property holds the mapped property. It is the value of the mapped object property

Definition at line 1 of file ctkBooleanMapper.h.

◆ valueAsInt

int ctkBooleanMapper::valueAsInt
readwrite

Definition at line 1 of file ctkBooleanMapper.h.

◆ valueAsString

QString ctkBooleanMapper::valueAsString
readwrite

Definition at line 1 of file ctkBooleanMapper.h.


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