TnmTerm(3tnm) · carta

NAME

TnmTerm - A Tcl/Tk package for simple output terminals

The TnmTerm package provides a set of Tcl/Tk command procedures used to create and display simple output terminals.

The TnmTerm package is loaded into a Tcl interpreter by using the following sequence of Tcl commands:

package require Tnm
package require TnmTerm $tnm(version)

All the TnmTerm commands live in the TnmTerm namespace. You can import these commands into the current namespace by using the following Tcl command:

namespace import TnmTerm::*

It is however suggested to import commands explicitely or to use the full name in scripts to avoid name clashes.

TnmTerm::Open path: The TnmTerm::Open procedure creates a new output terminal. The terminal is created with the given widget path.

TnmTerm::Clear path: The TnmTerm::Clear procedure removes all the text from the output terminal and positions the curser in the first line and first column.

TnmTerm::Write path text: The TnmTerm::Write procedure appends the text at the end of the text in the terminal window identified by path.

TnmTerm::SetName path name: The TnmTerm::SetName procedure sets the name of the terminal window identified by path. The name is displayed in the title bar of the window manager.

TnmTerm::SetIcon path bitmap: The TnmTerm::SetIcon procedure sets the bitmap icon displayed when the output terminal window identified by path is iconified.

TnmTerm::ToggleFreeze path: The TnmTerm::ToggleFreeze procedure toggles the frozen state of the output terminal window identified by path on and off. New text written to the terminal window normally scrolls the window so that the text is visible. No automatic scrolling will take place in the frozen state. The procedure returns a boolean indicating whether the terminal is currently in the frozen state or not.

TnmTerm::ToggleWrap path: The TnmTerm::ToggleWrap procedure toggles the line wrapping mode of the output terminal window identified by path. Normally, text lines that exceed the line length of the terminal window will not be shown completely. If the wrap mode is on, the long text lines will wrap around and be displayed in several lines in the terminal window. The procedure returns a boolean indicating whether the terminal is currently in wrap mode or not.

TnmTerm::ToggleXScroll path: The TnmTerm::ToggleYScroll procedure toggles the visibility of the horizontal scrollbar attached to the output terminal window identified by path. The procedure returns a boolean indicating whether the scrollbar is visible or not.

TnmTerm::ToggleYScroll path: The TnmTerm::ToggleYScroll procedure toggles the visibility of the vertical scrollbar attached to the output terminal window identified by path. The procedure returns a boolean indicating whether the scrollbar is visible or not.

TnmTerm::Save path: The TnmTerm::Save procedure issues a dialog to save the contents of the terminal window identified by path into a text file.

TnmTerm::Load path: The TnmTerm::Load procedure issues a dialog to read a text file into the terminal window identified by path.

TnmTerm::Print path: The TnmTerm::Print procedure issues a dialog to send the contents of the terminal window identified by path to a local printer.

TnmTerm::EMail path: The TnmTerm::EMail procedure issues a dialog to send the contents of the terminal window identified by path via email.

TnmTerm::Close path: The TnmTerm::Close procedure closes and destroys an existing output terminal identified by path.

Juergen Schoenwaelder <[email protected]>