Grefbench
← Chapter 2. Toolbar Templates →

Name

grefbench — Create and manipulate grefbench windows

Synopsis

          # package require grefbench in Tcl/Tk.
          require 'path to package/grefbench'
          object = TkGrefbench.new(parent) {
              ?options?
          }

Runtime Library Options

-creator

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

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

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

Window-specific Options

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: -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: -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: -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: -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: -docbookexternaleditor, Database Name: docbookExternalEditor, Database Class: -

Undocumented

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: -palettes, Database Name: palettes, Database Class; -

window pathName pointing to a view, containing many Galette children.

This window is treated as a scratch area, where a series of Galette windows can be placed and interactively rearranged.

The editor may create new Galette windows, delete, show or hide them from view.

Description

The »grefbench« command creates a »grefbench« window.

»grefbench« is a multiple-pages page inside the preferences. It hosts »grefadvance«, »grefpackages« and its associated sub-dialog: »grefpkproperties«, »grefpalman«.

»grefbench« thus aggregates anything related to the working with Jeszra itself; only the more general customization aspects are missing.

Window Command

A Window created through the grefbench 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:

objectcget(option)

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the grefbench 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 grefbench command.

object.init()

Initialize the »grefbench« dialog. Only stripes is applied on the grefbench window.

Dependencies

  • rtl_tabset

  • grefpackages

  • grefadvance

  • grefpalman

← ↖ →
Grefpkproperties ↑ Chapter 3. Inspector and Filters
SourceForge Logo

Copyright © 2009–2010 Arndt Roger Schneider