ml::EditObject Class Reference

allows to edit an ml::base-derived object via its XML description. More...

#include <mlEditObject.h>

Inheritance diagram for ml::EditObject:

List of all members.

Public Types
enum	AutoUpdateMode { AutoUpdateModeDoNothing = 0, AutoUpdateModeAutoClear, AutoUpdateModeAutoUpdate, AutoUpdateModeCount }
	auto update mode enum More...
Public Member Functions
	EditObject ()
	constructor:
	~EditObject ()
	destructor:
virtual void	deleteObject (void)
	deletes the current output object
virtual int	loadObject (void)
	loads the input object into editor
virtual int	updateObject (void)
	creates a new output object from the editor
Public Attributes
NotifyField *	_fldUpdateButton
	Update output object.
NotifyField *	_fldLoadButton
	Load input object to editor.
NotifyField *	_fldDeleteButton
	Delete output object.
EnumField *	_fldAutoUpdateMode
	Auto-update mode. Use anything other than Auto-Delete with care.
BoolField *	_fldAutoLoad
	Auto-load input object on notify.
BoolField *	_fldUpToDate
	Indicates whether the current output is consistent with the editor representation.
StringField *	_fldObjectString
	String representation of object, and thus current editor state.
BaseField *	_fldBaseOutput
	Output connection.
BaseField *	_fldBaseInput
	Input connection.
StringField *	_fldStatus
	oper status
Protected Member Functions
virtual void	activateAttachments ()
	resets fldUpToDate, calls handleNotification once after the module is loaded on the network and all field values are assigned.
virtual void	handleNotification (Field *field)
	Handle field notifications.
Protected Attributes
Base *	_outputObject
	object behind _fldBaseOutput
Base *	_inputObject
	object behind _fldBaseInput
char *	_objectString
	current editor string

---

Detailed Description

allows to edit an ml::base-derived object via its XML description.

class EditObject

Definition at line 22 of file mlEditObject.h.

---

Member Enumeration Documentation

enum ml::EditObject::AutoUpdateMode

auto update mode enum

Enumerator:

AutoUpdateModeDoNothing
AutoUpdateModeAutoClear
AutoUpdateModeAutoUpdate
AutoUpdateModeCount

Definition at line 27 of file mlEditObject.h.

---

Constructor & Destructor Documentation

ml::EditObject::EditObject

(

)

constructor:

ml::EditObject::~EditObject

(

)

destructor:

---

Member Function Documentation

virtual void ml::EditObject::activateAttachments

(

)

[protected, virtual]

resets fldUpToDate, calls handleNotification once after the module is loaded on the network and all field values are assigned.

Reimplemented from ml::FieldContainer.

virtual void ml::EditObject::deleteObject

(

void

)

[virtual]

deletes the current output object

virtual void ml::EditObject::handleNotification

(

Field *

field

)

[protected, virtual]

Handle field notifications.

Reimplemented from ml::Module.

virtual int ml::EditObject::loadObject

(

void

)

[virtual]

loads the input object into editor

virtual int ml::EditObject::updateObject

(

void

)

[virtual]

creates a new output object from the editor

---

Member Data Documentation

BoolField* ml::EditObject::_fldAutoLoad

Auto-load input object on notify.

Definition at line 55 of file mlEditObject.h.

EnumField* ml::EditObject::_fldAutoUpdateMode

Auto-update mode. Use anything other than Auto-Delete with care.

Definition at line 53 of file mlEditObject.h.

BaseField* ml::EditObject::_fldBaseInput

Input connection.

Definition at line 61 of file mlEditObject.h.

BaseField* ml::EditObject::_fldBaseOutput

Output connection.

Definition at line 60 of file mlEditObject.h.

NotifyField* ml::EditObject::_fldDeleteButton

Delete output object.

Definition at line 51 of file mlEditObject.h.

NotifyField* ml::EditObject::_fldLoadButton

Load input object to editor.

Definition at line 50 of file mlEditObject.h.

StringField* ml::EditObject::_fldObjectString

String representation of object, and thus current editor state.

Definition at line 58 of file mlEditObject.h.

StringField* ml::EditObject::_fldStatus

oper status

Definition at line 63 of file mlEditObject.h.

NotifyField* ml::EditObject::_fldUpdateButton

Update output object.

Definition at line 49 of file mlEditObject.h.

BoolField* ml::EditObject::_fldUpToDate

Indicates whether the current output is consistent with the editor representation.

Definition at line 56 of file mlEditObject.h.

Base* ml::EditObject::_inputObject [protected]

object behind _fldBaseInput

Definition at line 78 of file mlEditObject.h.

char* ml::EditObject::_objectString [protected]

current editor string

Definition at line 81 of file mlEditObject.h.

Base* ml::EditObject::_outputObject [protected]

object behind _fldBaseOutput

Definition at line 75 of file mlEditObject.h.

---

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

• MeVisLab/Standard/Sources/ML/MLParser/mlEditObject.h