Grefadvance
← Chapter 7. Jeszra Specific Templates →

Name

grefadvance — Create and manipulate grefadvance windows

Synopsis

              object = Grefadvance(parent, ?options?)

Runtime Library Options

-creator

The RTL based option creator is used to instantiate the template grefadvance 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, -background, -relief, -height, -width, -highlightBackground, -highlightColor, -highlightThickness, -foreground

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

Window-specific Options

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

window pathName pointing to a Galette window, containing »scripts«.

A menu is created, referring to the items inside the »scriptool«. One, out of this items, can be selected and used as a custom start command for the application.

Command-Line Name: -startupvariable, Database Name: startupVariable, Database Class; -

Tcl Variable, this variable receives a boolean value, indicating that a »Script Item« shall be used from the »-scripttool«.

Command-Line Name: -editvariable, Database Name: editVariable, Database Class; -

Tcl Variable, boolean value, indicates to use a custom »tclTest.tcl« file. This file is stored inside the Tcl variable »-tcltestvariable«.

Command-Line Name: -startupvariable, Database Name: startupVariable, Database Class; -

Tcl Variable, this variable receives a boolean value, indicating that a »Script Item« shall be used from the »-scripttool«.

Command-Line Name: -tcltestvariable, Database Name: tclTestVariable, Database Class; -

Tcl Variable, contains a filename, this file is used to initialize the test mode.

On default –without any value– »tclTest.tcl« is used for this purpose. The file tclTest.tcl is located inside the Jeszra main directory.

Command-Line Name: -scriptvariable, Database Name: scriptVariable, Database Class; -

Tcl Variable, this variable stores the ID if a script, to be evaluated whenever a new project is created.

Command-Line Name: -testvariable, Database Name: testVariable, Database Class; -

Tcl Variable, contains a filename, this file is used to initialize the test mode.

On default –without any value– »tclTest.tcl« is used for this purpose. The file tclTest.tcl is located inside the Jeszra main directory.

Command-Line Name: -tcltest, Database Name: tclTest, Database Class; -

File, points to the custom »tclTest.tcl« file. This property maintains the »-tclTestVariable«.

Command-Line Name: -tcledit, Database Name: tclEdit, Database Class; -

File, points to the custom »tclEdit.tcl« file. This property maintains the »-tclEditVariable«.

Command-Line Name: -docbookvariable, Database Name: docbookVariable, Database Class; -

Tcl Variable, boolean value, forces to query for a DocBook description for every template interface property. A »gdbkparagraph« dialog will be shown the instant a new, non-standard property is defined in the interface.

Command-Line Name: -docbookdoctypevariable, Database Name: docbookDocTypeVariable, Database Class: -

Undocumented

Command-Line Name: -docbooktemplatevariable, Database Name: docbookTemplateVariable, Database Class: -

Undocumented

Command-Line Name: -docbookexternaleditor, Database Name: docbookExternalEditor, Database Class: -

Undocumented

Description

Figure 7.3. grefadvance


Creates a »grefadvance« window.

»grefadvance« is a preferences page. It controls three advanced customization sections.

Jeszra contains two DocBook related dialogs. The first dialog queries for a DocBook description for every new property. This dialog is displayed whenever an as of yet unknown property is being added to a template interface. The second dialog asks for a general description. This paragraph is such a description. The second dialog –for the template description– is currently disabled in Jeszra. It is still unclear when this dialog should appear. Jeszra attempts to extract the template description from the module preamble, when there is no distinct DocBook document to describe it.

In the page’s bottom section, the two initialization scripts for Tcl based projects can be exchanged by custom initializations. The lower one, is dedicated to the test environment; while the above one controls the project editing and code generation.

The last element, in the top area, allows the automatic evaluation of a script, whenever a new project is created. A typical example script would include the creation of an initial toplevel window, and picking up a specific grid-layout for it.

The presented scripts originate from the »scripttool«, see: Gestalt(n) .

Window Command

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

object.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:

object.cget(option)

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

object.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 grefadvance command.

object.autostartCustomize()

In response to a change in the tcledit checkbutton. Either activate a predefined source file --if already selected-- or launch the file open dialog to locate one.

object.customize( var ID ... )

Alters the »state« of window with ID »ID« depending on the property query of the supplied »var« property name. »var« has to be a property from template »grefadvance«.

object.init()

Undocumented.

object.map()

Event handler, in response to the <Map> event. Does open / close the project initialization scripts: tcledit.tcl and tcltest.tcl.

object.postScripts( menu )

PostCommand menu, available when there are scripts inside the scripttool. Otherwise the menubutton stays inactive.

object.locateEdit()

Locate an alternative edit source code file. This points to tclEdit.tcl at the first point. Otherwise initialize it with the defined edit file.

object.locateTest()

Locate an alternative edit source code file. This points to tclEdit.tcl at the first point. Otherwise initialize it with the defined edit file.

object.editCustomize()

In response to a change in the tcledit checkbutton. Either activate a predefined source file --if already selected-- or launch the file open dialog to locate one.

object.testCustomize()

In response to a change in the tcltest checkbutton. Either activate a predefined source file --if already selected-- or launch the file open dialog to locate one.

object.selectScript( script )

Stores the chosen script inside the supplied script variable, and notifies a optional stripes window about the changes inside the Graphical User Interface.

Dependencies

  • rtl

  • gutilities

  • gstripesVector

← ↖ →
Grefgeneral ↑ Index
SourceForge Logo

Copyright © 2009–2010 Arndt Roger Schneider