OptionInfo

OptionInfo
←	Chapter 3. Inspector and Filters	→

Runtime Library Options

-creator

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

-foreground, -background, -relief, -borderwidth: See the options manual entry for details on the standard options.

Window-specific Options

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.

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

The geometry »manager« , used for the selected »window«.

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

The »assign«ed template or procedure. Identifies the code generation target.

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

The tooltip and status bar information for this »window«.

Tooltip and status messages are separated by »|« characters. The form is <status message > | <Tooltip message >.

Example 3.2. Help Message

option add *Menubar.options \
{ Controls how items are applied|
  Forces the next window to be a 
  child of the current one.
  Does ignore the management definitions!|
  |
  Geometry manager.
  Placed windows do not propagate
  their dimensions. Place is 
  compatible with pack or grid
  in the same parent window.|
  Geometry manager.
  Pack is appropriated for very 
  simple designs with less than
  three windows.|
  ...
}

The Example 3.2, “Help Message” shows one status message and a series of tooltips. This »help« Option Database entry is used inside Jeszra’s »Options« menu. The tool tips are displayed for the menu entry under the cursor. An empty tool-tips used for separator menu entries.

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

A Option Database string property. The HTTP online help for this »window«.

Example 3.3. Using Online Help

# Online Help for Buttons.
option add *Button.href {www.tcl.tk/button.html}

# Answer to the F1-Key:
bind Button <Key-F1> {
   # Launch a Web-Browser.

   # Tell the Browser what page shall
   # being displayed.
   set page [opget %W href {default page}] 
}