MeVisLab Scripting Reference
MLABBoolField Class Reference

#include <mlabBoolField.h>

Inherits MLABField.

Public Slots

Scripting access.

Sets the Boolean value.

void updateValue (bool value)
 
bool boolValue () const
 
void setBoolValue (bool value)
 
void updateBoolValue (bool value)
 
void toggle ()
 
- Public Slots inherited from MLABField
bool isInventorField ()
 
bool isMLField ()
 
QString getType () const
 
QString getName () const
 
virtual QString stringValue ()
 
virtual QString persistentStringValue ()
 
virtual void setPersistentStringValue (const QString &value)
 
QString truncatedStringValue (int maxChars=80)
 
virtual QString stringValueForProfiling ()
 
virtual void touch ()
 
MLABFieldOwnerowner ()
 
MLABFieldconnectedField ()
 
MLABFieldinputField ()
 
bool isConnected ()
 
bool isConnectedToFieldInSameNetwork ()
 
int outputCount ()
 
MLABFieldoutputField (int index)
 
QList< MLABField * > outputFields ()
 
bool connectFrom (MLABField *field)
 
void disconnect ()
 
void disconnectOutputs ()
 
void disconnectAll ()
 
bool connectFromUndoable (MLABField *field)
 
virtual bool isConnectionPossible (MLABField *field)
 
bool isConnectionInSameNetworkPossible (MLABField *field)
 
bool isInSameNetwork (MLABField *field)
 
virtual QString toolTipInfo ()
 
void setPriority (int aPriority)
 
int priority ()
 
void setProxy (bool flag)
 
bool isProxy ()
 
void setComment (const QString &comment)
 
QString comment ()
 
void setTitle (const QString &title)
 
QString title ()
 
QString fullName () const
 
bool isHidden ()
 
void setHidden (bool flag)
 
bool isIgnored ()
 
void setIgnored (bool flag)
 
bool isFilePath ()
 
void setIsFilePath (bool flag)
 
bool isInterfaceField ()
 
bool isParameterField ()
 
bool isInput ()
 
bool isOutput ()
 
bool isInOut ()
 
QString infoString ()
 
bool isPersistent () const
 
bool isEditable () const
 
bool triggersLoading () const
 
void setTriggersLoading (bool flag)
 

Signals

void valueChanged ()
 

Public Member Functions

void setStringValue (const QString &value) override
 

Properties

bool value
 

Detailed Description

A field containing a Boolean value.

The "value" property of this field is a Boolean value.

# getting value:
flag = ctx.field("somefield").value
# setting value:
ctx.field("somefield").value = True

Member Function Documentation

◆ boolValue

bool MLABBoolField::boolValue ( ) const
inlineslot

Returns the Boolean value.

◆ setBoolValue

void MLABBoolField::setBoolValue ( bool value)
inlineslot

Sets the Boolean value.

◆ setStringValue()

void MLABBoolField::setStringValue ( const QString & )
overridevirtual

Sets the value of the field as a string value.

Reimplemented from MLABField.

◆ toggle

void MLABBoolField::toggle ( )
slot

Toggles the bool state of the field between True/False.

◆ updateBoolValue

void MLABBoolField::updateBoolValue ( bool value)
inlineslot

Sets the Boolean value if different from the current value.

◆ updateValue

void MLABBoolField::updateValue ( bool value)
slot

Sets the Boolean value if different from current value.

◆ valueChanged

void MLABBoolField::valueChanged ( )
signal

Signal that is emitted when the field's value changes.

Property Documentation

◆ value

bool MLABBoolField::value
readwrite

Boolean value of the field.