mdiclient - Create and manipulate a Multiple Document Interface
(MDI)
client widget
SYNOPSIS
mtiwidgets::mdiclient pathName ?options?
INHERITANCE
itk::Widget <- mdiclient
STANDARD OPTIONS
activeBackground
activeForeground
borderWidth
|
foreground
height
relief
|
takeFocus
width
|
|
See the "options" manual entry for details on the standard options.
WIDGET-SPECIFIC OPTIONS
Name: class
Class: Class
Command-Line Switch: -class
Indicates which of three select states (none, up, down) the button is
in.
Name: balloonBackground
Class: BalloonBackground
Command-Line Switch: -balloonbackground
Background color for balloon help.
Name: balloonforeground
Class: BalloonForeground
Command-Line Switch: -balloonforeground
Foreground (text) color for balloon help.
Name: closecommand
Class: Command
Command-Line Switch: -closecommand
Command executed when close button is pressed.
Name: command
Class: Command
Command-Line Switch: -command
Indicates which of three select states (none, up, down) the button is
in.
Name: expelcommand
Class: Command
Command-Line Switch: -expelcommand
Command executed when expel button is pressed. If command string is
empy, then no expel button is displayed.
Name: expelImage
Class: ExpelImage
Command-Line Switch: -expelimage
Image to display on the expel button. If not specified, an default
image will be used.
Name: icon
Class: Icon
Command-Line Switch: -icon
Defines the icon to display in the upper left corner of the title bar
and on the clients tab. The image should represent the type of the
window.
Name: inactiveBackground
Class: InactiveBackground
Command-Line Switch: -inactivebackground
Indicates which of three select states (none, up, down) the button is
in.
Name: inactiveForeground
Class: InactiveForeground
Command-Line Switch: -inactiveforeground
Indicates which of three select states (none, up, down) the button is
in.
Name: mark
Class: Mark
Command-Line Switch: -mark
Sets the mark character displayed with the label in the tab for this
client. This property should be set using the mdiframe SetMark method
instead of configuring this property directly.
Name: maxcommand
Class: Command
Command-Line Switch: -maxcommand
Defines the command to execute when the maxcommand (maximize) button is
pressed. If the command string is empty, no button is displayed.
Name: mincommand
Class: Command
Command-Line Switch: -mincommand
Defines the command to execute when the mincommand (minimize) button is
pressed. If the command string is empty, no button is displayed.
Name: minheight
Class: Height
Command-Line Switch: -minheight
Indicates which of three select states (none, up, down) the button is
in.
Name: minwidth
Class: Width
Command-Line Switch: -minwidth
Indicates which of three select states (none, up, down) the button is
in.
Name: plusCommand
Class: Command
Command-Line Switch: -pluscommand
Defines the command to execute when the pluscommand (zoom) button is
pressed. If the command string is empty, no button is displayed.
Name: plusImage
Class: PlusImage
Command-Line Switch: -plusimage
Defines the image to display in the pluscommand button. If no
image is specified, a default image will be used.
Name: state
Class: State
Command-Line Switch: -state
Indicates which of three select states (active, inactive, or normal)
the client is
in.
Name: status
Class: Status
Command-Line Switch: -status
Indicates the current status of the client. Valid values are: normal,
min, or max.
Name: tabtitle
Class: TabTitle
Command-Line Switch: -tabtitle
Defines the label string to display in the tab.
Name: title
Class: Title
Command-Line Switch: -title
Indicates which of three select states (none, up, down) the button is
in.
DESCRIPTION
The mdiclient command creates a client window frame widget inside a
mdiframe.
(see mdiframe for more
information.)
METHODS
The mdiclient command creates 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 mdiclient widgets:
ASSOCIATED METHODS
None
WIDGET-SPECIFIC METHODS
- pathName action args
- Currently not implemented as this is handled by the mdiframe.
- pathName activate
- The client is made the active client in the frame.
- pathName cget option
- Returns the current value of the configuration option given by
option. Option may have any of the values accepted by the mdiclient
command.
- pathName childsite
- Returns the pathName to the clientsite within the 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 mdiclient command.
- pathName cursor x y
- This method will return a indication of which edge (if any)
the
cursor (located at x, y) is over. The return value is one of top_left_corner,
bottom_left_corner, left_side, top_right_corner, bottom_right_corner,
right_side, bottom_side, or top_side.
If
the
point specified is at any edge an empty string is returned. This
method
is used by the mdiframe class to
identify which
cursor to display and to control the resize operation.
- pathName deactivate
- The client is made inactive.
- pathName join
- Causes client to dock back into the mdiframe.
- pathName rip
- Causes client to undock from the mdiframe.
- pathName ripped
- Returns true if the client is undocked.
Note: the methods rip, join, and
ripped depend on [wm toplevel] implementation
(TIP #125)
COMPONENTS
Name:
clip
Class:
Frame
This is the internal region of the client window which
contains
the system titlebar and the childsite (cs).
Name:
close
Class:
Button
The close window button in the title bar.
Name:
cs
Class:
Frame
The childsite frame. The application specific widgets
get
"packed" into this frame.
Name:
file
Class:
Label
This is the file icon in the upper left corner of the
client
frame. It contains the client system menu.
Name:
max
Class:
Button
This is the maximize button in the title bar.
Name:
menu
Class:
Menu
This is the system menu which contains the restore, move,
resize,
minimize, maximize, and close commands.
Name:
min
Class:
Button
This is the minimize button in the title bar.
Name:
plusbutton
Class:
Button
This is the plus (zoom) button in the title bar.
Name:
system
Class:
Frame
This defines the frame for the title bar and buttons.
Name:
title
Class:
Label
This is the title text label in the title bar.
Name:
wf
Class:
Frame
This is the window frame which defines the outer most
relief
of the client window.
EXAMPLE
The mdiclient is never called directly. See the mdiframe example.
AUTHOR
Brian Griffin
KEYWORDS
mdi, Multiple Document Interface, mdiclinet, mdiframe, repeat, widget