NAME:

Package: Ui


SYNOPSIS:

use lib::Parts;


DIRECTORY/FILE:

The file Ui.pm is located in the subdirectory './lib'


DESCRIPTION:

This package contains all function that are needed for reused user-interface functionality that is used in several ui-classes.


STATUS:

Coding: 100%

Documentation: up-do-date


FUNCTIONS:


build_speedbar

Ui::build_speedbar($form_class, $ref_form);

Builds the speedbar and sets the commands to the right macros defined in 'edoc.cfg'

This is done in a seperate function, because its better to have an overview like this.

Parameters:

(+) $form_class: The classname of the ui-class that represents the form. For now this could be 'DocForm' or 'PrjForm'

(+) $ref_form: Reference to the object which user interface has to be created


build_smenu

Ui::build_menu($form_class, $ref_form, $menu_name, $ref_menu_cfg, $ref_entrylist);

Builds a menu with the data from some configuration files:

The TOOLS menu is stored in the 'edoc.cfg'-file (can be in $form_class = 'PrjForm' and 'DocForm')

the BACKEND menu is stored in the '*.out' files (Only available in $form_class = 'DocForm').

Parameters:

(+) $form_class: The classname of the form

(+) $ref_form: Reference to the object which user interface has to be created

(+) $menu_name: The name of the menu in the main menu

(+) $ref_menu_cfg : A reference to a hash that contains the data for the menu

(+) $ref_entrylist : A referenece to an array that holds the names of the submenuitems sorted the way they were written in the configuration filé


KNOWN BUGS:


STILL MISSING: