OptionItem

OptionItem
←	Chapter 3. Inspector and Filters	→

Runtime Library Options

-creator

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

-text, -state: See the options manual entry for details on the standard options.

Window-specific Options

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

The identifier, under which this option is accessible.

command for -command.

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

The entry content of the item.

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

The 2x grid row of the parent window. The »optionItem« is inserted into each second row.

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

Tcl Variable, the window path name is retrieved from this variable.

»widvar« and all other variables originate from the »inspector« .

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

Tcl Variable, contains the script which is evaluated. See also optionItem command eval.

The format string resembles: ?script? interpreter windowPathName name value

»scrvar« and all other variables originate from the »inspector« .

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

Tcl Variable, containing a script used to traverse the sub-tree starting with the current window / item. The script is used via Tcl command: »format«.

format \
value of travar \
        interpreter \
        window / item path Name

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

Tcl Variable, contains the script which is evaluated. See also optionItem command eval. »convar« is used to construct the item context menu. This context menu either resembles the history of the given property or a fixed set of acceptable values.

The format string resembles: ?script? interpreter windowPathName name value

»scrvar« and all other variables originate from the »inspector« .

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

Tcl Variable, contains the script which is evaluated. See also optionItem command eval.

The format string resembles: ?script? interpreter windowPathName name value

»intvar« and all other variables originate from the »inspector« .

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

Tcl Variable, currentvar is used to monitor the input focus among »optionItems«. All »optionItems« inside a container, shall have the same variable.

The format string resembles: ?script? interpreter windowPathName name value

»intvar« and all other variables originate from the »inspector« .

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

Tcl Variable, contains the current Inspector page. Possible values for this variable are »pap«, »bindings«, »configure« and »geometry«.

The value of »pagevar« is used in combination with »namevar« to query the visual appearance from the global settings.

getSettings \
    Appearance,Inspector,Commands,[mkFirstUp \
		[set value of pagevar \
          ]],[mkFirstUp value of namevar \
          ] {}

The format string resembles: ?script? interpreter windowPathName name value

»intvar« and all other variables originate from the »inspector« .

Description

The »optionItem« command creates a series of discret windows, one of this windows has the window class »optionItem«.

The »optionItem« window implements the Inspector entries for properties, events, geometry properties and the interface definition.

The »optionItem« window injects itself into the Inspector’s editing area. The »set-row« command is used to do this.

Changes since 2005: tile support, new design. keyboard scrolling.

fixme (Roger) 10/14/2009 : On rtl_compat, strictly all: optionInfo, optionItem and the inspector are ported from rtl_compat, but there is another dependency somewhere deeper down. Investigate.

Window Command

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

object.getInterp()