NAME:

Widget: XXX #PLACE HERE YOUR REAL CLASSNAME


SYNOPSIS:

use class::XXX; #PLACE HERE YOUR REAL CLASSNAME


DIRECTORY/FILE:

The file XXX.pm is located in the subdirectory './class'


DESCRIPTION:

#HERE YOU SHOULD WRITE A BRIEF DESCRIPTION OF YOUR OBJECT


STATUS:

Coding: 0% done

Documentation: up-to-date


ATTRIBUTES:

Do not set/read them directly, use the Get/Set methods instead.

All properties derived from the class EmbObj.

# PLACE ADDITIONAL ATTRIBUTES HERE

NOTE: The following attributes are used for the Tk widgets building the GUI and are accessed directly (no get/set methods):

All GUI attributes derived from the class EmbObj.

#PLACE ADDITIONAL GUI STUFF HERE


METHODS:


Constructors:


build_ui

Here your widget could build up all its own widgets and gets initialised


Destructors:


do_detstroy

$object->do_detsroy();

This ``destructor'' method is binded to the ``<DESTROY>'' event and should be performed whenever the element is destroyed. It should not be called directly.


Public data methods (=Get/Set methods):


Other public methods:


export_to_backend

my @export_text = $object->export_to_backend();

This function exports the content of the object to the current backend.

The function is called in the document-exporting process, whenever an embeded object is found.

It returns the text for exporting the object.


Private methods:


_on_btn_prop_click

$object->_on_btn_prop_click();

Overwritten function of EmbObj. This should perform the opening of the properties dialog.


_before_save

$object->_before_save();

This function is called before the $self->{'_data'}-subbranch gets saved.

Use this for flatten complicated data structures into {'_data'}.


_after_save

$object->_after_save();

This function is called after the $self->{'_data'}-subbranch got saved.


_before_load

$object->_before_load();

This function is called before the $self->{'_data'}-subbranch is loaded from file.


_after_load

$object->_after_load();

This function is called after the $self->{'_data'}-subbranch is loaded from file.

Use this function to build up complicated data structures from the flat {'_data'}-subbranch


_before_expand

$object->_before_expand();

This function is called before the object gets expanded.


_after_expand

$object->_after_expand();

This function is called after the object gets expanded.


_before_collapse

$object->_before_collapse();

This function is called before the object gets collapsed.


_after_collapse

$object->_after_collapse();

This function is called after the object gets collapsed.


_after_backend_changed

$object->_after_backend_changed();

This function is called after the current backend changed


KNOWN BUGS:


STILL MISSING: