Gelplines
← Chapter 5. Dialog Templates →

Name

gelplines — Create and manipulate gelplines windows

Synopsis

          package require gelplines
        
          gelplines pathName ?options ?

Runtime Library Options

-creator

The RTL based option creator is used to instantiate the template gelplines with a Tk Window. The used creator window must have a -class property.

Acceptable Tk Windows are: toplevel for floating windows, and frame for embedded windows.

Standard Options

-borderWidth, -relief, -background, -foreground, -highlightBackground, -highlightColor, -highlightThickness, -height, -width

See the options manual entry for details on the standard options.

Window-specific Options

Command-Line Name: -updatefcn, Database Name: updatefcn, Database Class; -

Tcl script, given as a format string. There are three string substitutions applied to this format string, before it is evaluated.

Example 5.2. »-updatefcn« Format String

formatstring %1$s %2$s %3$s
# 1:= selected window
# 2:= orientation (x,y)
# 3:= list of help lines coordinates

Command-Line Name: -collectfcn, Database Name: collectfcn, Database Class; -

Format string with two string substitutions. This call back script is used to gather the actual coordinates of help lines within the selected window.

Command-Line Name: -traversecommand, Database Name: traverseCommand, Database Class; -

Tcl command, gathers the entire hierarchy of the selected project. This command is called whenever the help line editor is displayed.

Command-Line Name: -interp, Database Name: interp, Database Class; -

A valid Tcl-Interpreter. This interpreter must be created through interp create.

The current Tcl-Interpreter is used whenever the property is left empty.

Command-Line Name: -window, Database Name: window, Database Class; -

A valid Tk Window. This »window« can be a a plain or composite window, too.

This value of this property »-window« will change interactively, whenever another window, from the combobox list, is selected. »-window« is the target window for the help lines editor.

Description

Figure 5.2. gelplines


The »gelplines« command creates a gelpline window.

This is the Jeszra help line editor. Help lines can be defined for both directions horizontal and vertical. The help lines editor does also allow the storage of a help line layout. The functionality is located underneath the drawer.

In the top area a rtl_combobox is used to display the current hierarchy of the project. Thus the help line editor can switch between different windows of the same project.

Window Command

A Window created through the gelplines command exposes various functions. Using these functions has the following general form: 

          pathName option ?arg arg ...?

PathName is the same as the window path name. Option and the args determine the exact behavior of the command. The following commands are possible for this window:

pathName cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the gelplines command.

pathName configure ?option? ?value option value ...?

Query or modify the configuration options of the window. If no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list). If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more option-value pairs are specified, then the command modifies the given window option(s) to have the given value(s); in this case the command returns an empty string. Option may have any of the values accepted by the gelplines command.

pathName openFile

Read a prior saved help lines definition from the computer disk.

pathName traverse

Walks through a window hierarchy defined by by the »-traversefcn« property. The result of this traversion is stored inside the select combobox.

pathName init

Secondary window construction, this procedure »stripes« the help line window and makes it a transient dialog.

Rewritten : 05/23/2008, Roger

pathName collect

Gather the help lines from the selected window. The »-collectfcn« is used for collecting the help line data.

pathName saveFile

Store the present help lines definition on the computer disk. This definition can later be reused with »openFile«.

pathName eval arg

Evaluates the command »arg« inside the defined Tcl-Interpreter »-interp«, if »-interp« is undefined, then »arg« is executed inside the same interpreter, wherein the »gelpline« window was created.

pathName window

The »combobox« selection.

pathName getFile action

Internal used from »openFile« and »saveFile«. This procedure does display the file browser according to the »action« either as »tk_getSaveFile« or as »tk_getOpenFile«.

pathName hide

Remove the help lines present inside window »-window«. The »-updatefcn« is used for hiding the help lines.

pathName update

Uses »-updatefcn« to refresh the helplines in window »-window«.

pathName refresh ?notifier?

Sync the content of the orientation listboxes from the help lines present inside the selected window.

Dependencies

  • rtl_all

  • rtl_sizer

  • gistbox

  • gstripes

  • gutilities

  • Hugelist

← ↖ →
Gdbkparagraph ↑ Gbout
SourceForge Logo

Copyright © 2009–2010 Arndt Roger Schneider