Rtl_shell

Copyright © 2009 Arndt Roger Schneider

Rtl_shell
Prev	Chapter 5. Dialog Templates	Next

Name

rtl_shell — Create and manipulate rtl_shell windows

Synopsis

              object = Rtl_shell(parent, ?options?)

Runtime Library Options

-creator

The RTL based option creator is used to instantiate the template rtl_shell 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, -background, -borderwidth, -height, -width, -relief, -highlightthickness, -highlightcolor, -highlightbackground, -exportselection, -foreground, -insertofftime, -insertontime, -insertwidth, -padx, -pady, -selectbackground, -selectborderwidth, -selectforeground, -state, -insertbackground, -insertborderwidth: 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: -prompt, Database Name: prompt, Database Class; -

String, defines what text shall being used as the prompt identifying the containing interpreter.

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

A string sequence, this sequence is used to change between the containing interpreter and the chosen slave interpreter.

The default switchcmd is »+-«.

Command-Line Name: -maxbuffer, Database Name: maxbuffer, Database Class: -

Undocumented

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

Set where the scrollbars are inserted.

Possible values are: »top«, »bottom«, »left«, »right« and combinations thereof.

Command-Line Name: -copyright, Database Name: copyright, Database Class: -

Undocumented

Command-Line Name: -spacing1, Database Name: spacing1, Database Class; Spacing1

Requests additional space above each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the first line on the display. This option may be overridden with -spacing1 options in tags.

Command-Line Name: -spacing2, Database Name: spacing2, Database Class; Spacing2

For lines that wrap (so that they cover more than one line on the display) this option specifies additional space to provide between the display lines that represent a single line of text. The value may have any of the standard forms for screen distances. This option may be overridden with -spacing2 options in tags.

Command-Line Name: -spacing3, Database Name: spacing3, Database Class; Spacing3

Requests additional space below each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the last line on the display. This option may be overridden with -spacing3 options in tags.

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

Specifies a set of tab stops for the window. The option's value consists of a list of screen distances giving the positions of the tab stops. Each position may optionally be followed in the next list element by one of the keywords left, right, center, or numeric, which specifies how to justify text relative to the tab stop. Left is the default; it causes the text following the tab character to be positioned with its left edge at the tab position. Right means that the right edge of the text following the tab character is positioned at the tab position, and center means that the text is centered at the tab position. Numeric means that the decimal point in the text is positioned at the tab position; if there is no decimal point then the least significant digit of the number is positioned just to the left of the tab position; if there is no number in the text then the text is right-justified at the tab position. For example, -tabs {2c left 4c 6c center} creates three tab stops at two-centimeter intervals; the first two use left justification and the third uses center justification. If the list of tab stops does not have enough elements to cover all of the tabs in a text line, then Tk extrapolates new tab stops using the spacing and alignment from the last tab stop in the list. The value of the tabs option may be overridden by -tabs options in tags. If no -tabs option is specified, or if it is specified as an empty list, then Tk uses default tabs spaced every eight (average size) characters.

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

Specifies how to handle lines in the text that are too long to be displayed in a single line of the text's window. The value must be none or char or word. A wrap mode of none means that each line of text appears as exactly one line on the screen; extra characters that don't fit on the screen are not displayed. In the other modes each line of text will be broken up into several screen lines if necessary to keep all the characters visible. In char mode a screen line break may occur after any character; in word mode a line break will only be made at word boundaries.

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

String, defines what text shall being used as the prompt identifying the used slave interpreter.

A string substitution »%1$s« may occur in the local prompt string. This format substitution will be expanded with the current interpreter.

Example 5.1. Local Prompt

-localprompt {vegetables %1$s :} \
-interp myLocalInterpreter;

# Produces the following local prompt inside the
# Rtl_shell:
vegetables myLocalInterpreter :

Description

Figure 5.1. rtl_shell