MLABMLBaseField Class Reference

A field containing a ML Base object pointer. More...

Inherits MLABField.

List of all members.

Public Slots
virtual void	setStringValue (const QString &)
virtual QString	stringValue ()
virtual QString	stringValueForProfiling ()
virtual void	touch ()
Scripting access.
QString	persistentString ()
void	setPersistentString (const QString &string)
QString	getMLBaseType ()
bool	isMLBaseDerivedFrom (const QString &parent)
QStringList	getMLBaseAncestors ()
QVariant	object ()
void	setObject (MLRefCountedBaseWrapper *value)
void	setObject (PyObject *object)
void	updateObject (MLRefCountedBaseWrapper *value)
void	updateObject (PyObject *object)
Type checking.
QStringList	allowedTypesByString ()
bool	matchesTypes (MLABMLBaseField *field)

---

Detailed Description

A field containing a ML Base object pointer.

---

Member Function Documentation

QStringList MLABMLBaseField::allowedTypesByString

(

)

[slot]

Returns a list of allowed types as strings.

QStringList MLABMLBaseField::getMLBaseAncestors

(

)

[slot]

Returns a list of ancestors of the current base object, starting with the parent of the object.

QString MLABMLBaseField::getMLBaseType

(

)

[slot]

Returns the type of the internal ML Base object, returns an empty string if there is no object set.

bool MLABMLBaseField::isMLBaseDerivedFrom

(

const QString &

parent

)

[slot]

Returns whether the current ML Base object is derived from the given parent.

bool MLABMLBaseField::matchesTypes

(

MLABMLBaseField *

field

)

[slot]

Returns whether the allowed types of this field matches (intersects) the types of the given field.

QVariant MLABMLBaseField::object

(

)

[slot]

Returns access to a scriptable base object (NOTE: this is only available if there is a CPPWrapperObject registered for the type of the contained ML Base object).

QString MLABMLBaseField::persistentString

(

)

[slot]

Returns the persistent string of the ML Base object.

void MLABMLBaseField::setObject

(

PyObject *

object

)

[slot]

Sets the pointer to the Python object.

void MLABMLBaseField::setObject

(

MLRefCountedBaseWrapper *

value

)

[slot]

Sets the pointer to the ML Base object (from a wrapped object).

void MLABMLBaseField::setPersistentString

(

const QString &

string

)

[slot]

Sets the persistent string of the ML Base object and touches it.

virtual void MLABMLBaseField::setStringValue

(

const QString &

)

[inline, virtual, slot]

Sets the value of the field as a string value.

Reimplemented from MLABField.

virtual QString MLABMLBaseField::stringValue

(

)

[inline, virtual, slot]

Returns the value of the field as a string value.

Reimplemented from MLABField.

virtual QString MLABMLBaseField::stringValueForProfiling

(

)

[virtual, slot]

Returns the string value used for profiling, default returns the string value.

NOTE: be careful on how you re-implement this method in subclasses, since we don't want the profiling to cause side effects, e.g. changing the state of an ML image.

Reimplemented from MLABField.

virtual void MLABMLBaseField::touch

(

)

[virtual, slot]

Forces a notify to all observers without changing the value of the field.

Reimplemented from MLABField.

void MLABMLBaseField::updateObject

(

PyObject *

object

)

[slot]

set the pointer to the Python object if different from current object

void MLABMLBaseField::updateObject

(

MLRefCountedBaseWrapper *

value

)

[slot]

Sets the pointer to the M LBase object (from a wrapped object) if different from current object.