ref: bd6c2aad586814b091ce5aca9d41cf2c51adb37b
dir: /man/1/tktester/
.TH TKTESTER 1
.SH NAME
tktester \- test Tk widgets and help design Tk layouts
.SH SYNOPSIS
.B wm/tktester
[
.B -import
]
.SH DESCRIPTION
.I Tktester
not only tests the
.IR tk (2)
widget implementation but can help when designing Tk application layouts.
Its main window contains the design area where widgets are placed and edited. Most of the commands for creating and moving widgets are located on the control bar just below the design area although a few commands may be found in the menus at the top of the window. Output is sent to the text box below the control bar.
.PP
Widget properties may be modified using the config window and widget commands called from the command window.
.SH Main Window
This is split into four areas:
.PP
.SS Menu Bar
This contains various file operations as well as a few commands
.TP 10
.B File
New: Starts a new file
.br
Open: Opens a saved file
.br
Snarf: Sends the current file to snarf
.br
Save: Saves the current file
.br
Save as: Asks for a new filename and then saves the file
.br
Exit: Close \f1tktester\fR
.TP
.PP
Files are saved in the form of a list of tk commands. This means that they can easily be imported into programs as part of an array. Files to be loaded must have .f as the top frame with no widgets outside it.
.TP 10
.B Row/Column
The current row/column is the one in which the currently selected widget/empty cell is located
Insert - inserts a new row/column either before or after the currently selected row/column
Delete - deletes currently selected row/column
Format - sets the properties for the current row/column
.TP
.B Hidden
Forget - removes the current widget from the display area but does not delete it. The widget name is then added to the 'Hidden' menu and can still be selected by clicking on its name there. This can be useful for operations which require widgets that are not currently packed e.g. placing a frame as a window within a canvas. Forgotten items will still be saved.
.TP
.B Disabled
This menu only appears when a widget has been disabled. In this state, button bindings are ignored so it becomes impossible to select the widget. When a widget is disabled, its name is automatically added to the 'Disabled' menu and can be selected from there.
.PP
.SS Design Area
This is the main area of the main window where the widgets are displayed. To select a widget, click on it with mouse button 3, the control bar shows the name and other information about the currently selected widget. Frames themselves can only be selected by clicking on their label, clicking elsewhere on the frame (if there is no widget there) will select the empty cell, any new widget created will be placed here. Once a widget has been selected, you can move it by clicking on the empty destination cell with mouse button 2. Individual widgets can be moved from one frame to another but frames themselves can currently only be moved within the same parent frame. Clicking mouse button 2 on a widget will delete that widget if the \f1Free Delete\fR button on the control bar is on.
.SS Control Bar
This is split into three different menus. To select the different submenus, click on the >> at the end of the menu title.
.PP
\fIData Menu\fR
.TP 10
.B Widget
shows information about the current widget
.br
clicking on the \f1Destroy\fR button will delete the currently selected widget.
The \f1Free Delete\fR button to the right of the \f1Destroy\fR button can be toggled on and off by clicking on it. When turned on (red background) , clicking mouse button 2 on a widget in the design area will delete it.
.TP
.B Grid
shows information about the current grid
.br
Clicking the \f1Hide Labels\fR button will hide the frame labels so that you can see what the screen will look like normally.
.PP
\f1Position and Formatting Menu\fR
.TP 10
.B Move
Move the widget within its current frame
.TP
.B Spanning
Change row and column spanning properties
.TP
.B Padding
Set cell padding, checkbox selects internal or external padding
.TP
.B Position
Adjust widget position, widget can be stretched if opposite positions are selected e.g. to flill horizontaly, select < and >
.PP
\f1New Menu\fR
.PP
Clicking on 'New' will bring up the pack menu, here you can set packing to down or right. This is used when a new widget is created. If the user has not selected an empty cell, the new widget will be placed either below or to the right of the currently selected widget. Clicking on '>>' will scroll the buttons within the menu to the left to allow access to those that might be off screen.
.PP
.SS Output Box
Output and errors are reported here. This box may be hidden by clicking on the grey button located at the bottom of the main window.
.PP
.SH POPUP WINDOWS
.B
.PP
.SS Config Window
This window is opened by clicking on the red button located at the bottom of the main window. To configure a widget's options, the widget must be selected. To modify an option, type the new value required into the relevant entry box and click the 'set' button. Any output (including error messages) returned will be sent to the output box.
.PP
There are two template buttons at the bottom of the config window, set as default and save as default. Set will cause each new widget of the same type to be created with the same options as the currently selected widget. This default will not be remembered once \f1tktester\fR has been closed. Save does the same as set except the default is saved so it will be not be lost if \f1tktester\fR is closed.
.PP
Default Template Options
.PP A few special characters can be used when setting default widget options.
.TP 5
.B %n
the name of the widget e.g. .f.f1.b2
.TP
.B %t
the widget type e.g. button
.TP
.B %i
the number of the widget
.PP
By default, each widget with a -text option is set to {%t %i} e.g. button 2. Note: These options only work with default templates, setting the -text option of a specific button to {%t %i} will just cause '%t %i' to be displayed.
.PP
.SS Command Window
This window is opened by clicking on the green button located at the bottom of the main window. To call the commands for a particular widget, the widget must be selected.
.PP
The command window is split into two listboxes and one entry box. The first listbox contains all the main commands available for the current widget type. Selecting a command will bring up a list of subcommands (if they exist) in the second listbox as well as displaying any arguments required above the entrybox. To run a command, first select the command (and any subcommand), then enter the required arguments into the entry box and click run. The command, as well as any output, is sent to the output box on the main window. If no output is returned, the output box will display 'ok'.
.PP
.SH OPTIONS
.TP 10
.B -import
Tells
.I tktester
to import valid widget commands from the man pages. This data is saved in the
.B tkwargs/
directory, which must already exist.
.SH FILES
The file
.B tkwargs/widgets
must contain a list of widgets, one per line as follows:
.IP
.RI [ name ]
.RB [ abv ]
.PP
with the fields separated by tabs or spaces.
For example:
.IP
.B "menubutton mb"
.br
.B "listbox lb"
.PP
.SH SOURCE
.B /appl/wm/tktester
.SH BUGS
The command window sometimes lists a command more than once. It does not matter which one is used.
.PP
In a saved file, any grid commands must put -row and -column options \f1before\fR -rowspan or -columnspan.
.PP
Tktester can crash when loading a file if it is not in the correct format.
.PP
.SH PROPOSED ADDITIONS
.SS Allow renaming of widgets
At the moment, \f1tktester\fR can only load, save and use tk commands where the widget names adhere to the format .abv[n] where abv is the abreviation for the widget type e.g. b for buttons, sb for scrollbars etc and n is an optional number. It would be better to allow users to have more meaningful names such as .f.fmenu. Implementing this would also make it possible to load in commands written outside of \f1tktester\fR for testing or modification purposes.
.PP
.SS Column and Row indicators
This would more clearly show which rows and columns widgets were in (especially when widgets are spanning more than one). Also could be used to select individual rows and columns more explicity and maybe for multiple selections.