Gdbkparagraph

Gdbkparagraph
←	Chapter 5. Dialog Templates	→

Name

gdbkparagraph — Create and manipulate gdbkparagraph windows

Synopsis

          package require gdbkparagraph

          gdbkparagraph pathName ?options ?

Runtime Library Options

-creator

The RTL based option creator is used to instantiate the template gdbkparagraph 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

-font, -cursor, -background, -height, -width, -highlightBackground, -highlightColor, -highlightThickness, -borderWidth, -relief: See the options manual entry for details on the standard options.

Window-specific Options

Command-Line Name: -textbackground, Database Name: textBackground, Database Class: -: The »-background« color for the paragraph text window. Use »-textbackground« together with »-textforeground«.
Command-Line Name: -textforeground, Database Name: -textForeground, Database Class: -: Defines the »foreground« color for the internal text field.
Command-Line Name: -paraforeground, Database Name: paraForeground, Database Class: -: The <para> and </para> XML-tags are displayed in an alternative foreground color. To set them apart from the inserted text.
Command-Line Name: -paravariable, Database Name: paraVariable, Database Class; -: A »variable«. The »paravariable« holds the edited paragraph.
Command-Line Name: -variable, Database Name: variable, Database Class: -: This »variable« receives the filename, under which the DocBook »variablelist« entry is stored on the computer disc.

Description

The »gdbkparagraph« command creates a »gdbkparagrpah« window.

Creates an »rtl_question« embedded Dialog. The dialog asks for a description used as a DocBook paragraph. This dialog is used in Jeszra to comment a new template interface property.

It also used to ask for the description of a new template.

This comments are later used to generate a DocBook Refentry, documenting the generated template.

Window Command

A Window created through the gdbkparagraph 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 gdbkparagraph 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 gdbkparagraph command.

Dependencies

rtl
rtl_gridwin
gstripes

←	↖	→
Gsearch	↑	Gelplines