mainwindow - Create and manipulate a mainwindow widget

SYNOPSIS

mainwindow pathName ?options?
INHERITANCE
itk::Toplevel <- shell <- mainwindow
STANDARD OPTIONS

background
foreground
cursor
highlightBackground
disabledForeground
highlightColor
font
highlightThickness

See the "options" manual entry for details on the standard options.
ASSOCIATED OPTIONS

balloonBackground
balloonForeground
balloonDelay1
balloonDelay2
ballonFont

See the "toolbar" manual entry for details on the above associated options.
INHERITED OPTIONS

title

See the "Toplevel" manual entry for details on the above inherited options.

height
padY
master
width
modality
padX

See the "shell" manual entry for details on the above inherited options.
WIDGET-SPECIFIC OPTIONS

Name: helpLine Class: HelpLine Command-Line Switch: -helpline

Specifies whether or not to display the help line. The value may be given in any of the forms acceptable to Tk_GetBoolean. The default is yes.

Name: menuBarBackground Class: Background Command-Line Switch: -menubarbackground

Specifies the normal background color for the menubar.

Name: menuBarFont Class: Font Command-Line Switch: -menubarfont

Specifies the font to use when drawing text inside the menubar.

Name: menuBarForeround Class: Foreground Command-Line Switch: -menubarforeground

Specifies the normal foreground color for the menubar.

Name: statusLine Class: StatusLine Command-Line Switch: -statusline

Specifies whether or not to display the status line. The value may be given in any of the forms acceptable to Tk_GetBoolean. The default is yes.

Name: toolBarBackground Class: Background Command-Line Switch: -toolbarbackground

Specifies the normal background color for the toolbar.

Name: toolBarFont Class: Font Command-Line Switch: -toolbarfont

Specifies the font to use when drawing text inside the toolbar.

Name: toolBarForeround Class: Foreground Command-Line Switch: -toolbarforeground

Specifies the normal foreground color for the toolbar.

DESCRIPTION

The mainwindow command creates a mainwindow shell which contains a menubar, toolbar, mousebar, childsite, status line, and help line. Each item may be filled and configured to suit individual needs.
METHODS

The mainwindow command create a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:
pathName option ?arg arg ...?
Option and the args determine the exact behavior of the command. The following commands are possible for mainwindow widgets:
INHERITED METHODS

activate
center
deactivate

See the "shell" manual entry for details on the above inherited methods.
WIDGET-SPECIFIC METHODS

pathName cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the mainwindow command.

pathName childsite
Returns the pathname of the child site widget.

pathName configure ?option? ?value option value ...?: Query or modify the configuration options of the widget. 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 widget 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 mainwindow command.

pathName menubar ?args?: The menubar method provides access to the menubar. Invoked with no arguments it returns the pathname of the menubar. With arguments, they are evaluated against the menubar which in effect provides access to the entire API of the menubar. See the "menubar" manual entry for details on the commands available in the menubar.

pathName mousebar ?args?: The mousebar method provides access to the mousebar which is a vertical toolbar. Invoked with no arguments it returns the pathname of the mousebar. With arguments, they are evaluated against the mousebar which in effect provides access to the entire API of the underlying toolbar. See the "toolbar" manual entry for details on the commands available in the mousebar.

pathName msgd ?args?: The msgd method provides access to the messagedialog contained in the mainwindow. Invoked with no arguments it returns the pathname of the messagedialog. With arguments, they are evaluated against the messagedialog which in effect provides access to the entire API of the messagedialog. See the "messagedialog" manual entry for details on the commands available in the messagedialog.

pathName toolbar ?args?: The toolbar method provides access to the toolbar. Invoked with no arguments it returns the pathname of the toolbar. With arguments, they are evaluated against the toolbar which in effect provides access to the entire API of the toolbar. See the "toolbar" manual entry for details on the commands available in the toolbar.

COMPONENTS

Name:                   help
Class:                  Label

The help component provides a location for displaying any help strings provided in the menubar, toolbar, or mousebar. See the "label" widget manual entry for details on the help component item.

Name:                   menubar
Class:                  Menubar

The menubar component is the menubar located at the top of the window. See the "menubar" widget manual entry for details on the menubar component item.

Name:                   mousebar
Class:                  Toolbar

The mousebar component is the vertical toolbar located on the right side of the window. See the "toolbar" widget manual entry for details on the mousebar component item.

Name:                   msgd
Class:                  Messagedialog

The msgd component is a messagedialog which may be reconfigured as needed and used repeatedly throughout the application. See the "messagedialog" widget manual entry for details on the messagedialog component item.

Name:                   status
Class:                  Label

The status component provides a location for displaying application status information. See the "label" widget manual entry for details on the status component item.

Name:                   toolbar
Class:                  Toolbar

The toolbar component is the horizontal toolbar located on the top of the window. See the "toolbar" widget manual entry for details on the toolbar component item.

EXAMPLE

 mainwindow .mw

 #
 # Add a File menubutton
 #
 .mw menubar add menubutton file -text "File" -underline 0 -padx 8 -pady 2 \\
    -menu {options -tearoff no
	   command new -label "New" -underline 0 \\
	       -helpstr "Create a new file"
	   command open -label "Open ..." -underline 0 \\
	       -helpstr "Open an existing file"
	   command save -label "Save" -underline 0 \\
	       -helpstr "Save the current file"
	   command saveas -label "Save As ..." -underline 5 \\
	       -helpstr "Save the file as a differnet name"
	   command print -label "Print" -underline 0 \\
	       -helpstr "Print the file"
           separator sep1
	   command close -label "Close" -underline 0 \\
	       -helpstr "Close the file"
	   separator sep2
	   command exit -label "Exit" -underline 1 \\
	       -helpstr "Exit this application" 
    }

 #
 # Install a scrolledtext widget in the childsite.
 #
 scrolledtext [.mw childsite].st
 pack [.mw childsite].st -fill both -expand yes

 #
 # Activate the main window.
 #
 .mw activate

AUTHORS

Mark L. Ulferts

John A. Tucker

KEYWORDS

mainwindow, shell, widget