NAME:

Widget: TblObj


SYNOPSIS:

use class::TblObj;


DIRECTORY/FILE:

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


DESCRIPTION:

This is a widget derived from class::EmbObj that gets embeded into the documents text widget in the DocForm object (=document window).

This class is for embeding tables into the document.

This class is in a very basic stage, it's just for demonstarting that it's quiet easy to add new embeded objects to e:doc.


STATUS:

Coding: 70% done

Documentation: up-to-date


ATTRIBUTES:

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

[... List of attributes is missin here ... ]

All attributes derived from the class EmbObj.

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.


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):


table

$ref_table = $object->table(); #Gets a reference to the XGrid widget that displays the table

$object->table($ref_table); #sets a reference to the XGrid widget that displays the table


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:


_before_save

$object->_before_save();

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

It's used here to build up the flat {'_data'} subbranch from the more complicated datastructures.


_after_load

$object->_after_load();

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

It's used here to read information the flat {'_data'} subbranch into the more complicated datastructures.


KNOWN BUGS:


STILL MISSING: