Itcl Paned Widget
A description will go here eventually.
Synopsis
paned
pathName ?options?
- create a new paned widget named pathName.
- pathName option ?args...?
- manipulate the paned widget named pathName.
Options
- Name:
width
- Class:
Width
- Command-Line Switch:
-width
- Default:
100
- The width of the widget in screen units.
- Name:
height
- Class:
Height
- Command-Line Switch:
-height
- Default:
100
- The height of the widget in screen units.
- Name:
orient
- Class:
Orient
- Command-Line Switch:
-orient
- Default:
horizontal
- The orientation of the panes. If the orient option is
set to
horizontal
, the panes are laid out horizontally
across the widget with pane 0 leftmost and with vertical sashes
between each pane. If set to vertical
, the panes are laid
out verticallywith pane 0 topmost and with horizontal sashes
between each pane.
- Name:
sashRelief
- Class:
SashRelief
- Command-Line Switch:
-sashrelief
- Default:
sunken
- The 3D relief in which the sashes are drawn. This option can take
any of the values acceptable to
Tk_GetRelief
(3).
- Name:
sashWidth
- Class:
SashWidth
- Command-Line Switch:
-sashwidth
- Default:
2
- The width of the sashes dividing each pane, in screen units.
- Name:
sashBackground
- Class:
Background
- Command-Line Switch:
-sashbackground
- Default:
#ccc
- The colour of the sashes dividing each pane. This colour is used
to calculate the top and bottom shadow colours used to draw the sashes'
3D appearance.
- Name:
handleSize
- Class:
HandleSize
- Command-Line Switch:
-handlesize
- Default:
9
- The length of the sides of the square handles used to drag the sashes
dividing the panes. This option is measured in screen units.
- Name:
handleBackground
- Class:
Background
- Command-Line Switch:
-handlebackground
- Default:
#ccc
- The default colour of the sash handles.
- Name:
handleActiveBackground
- Class:
ActiveBackground
- Command-Line Switch:
-handleactivebackground
- Default:
goldenrod
- The colour in which the sash handles are drawn when the mouse pointer
is over them.
- Name:
handleBorderWidth
- Class:
BorderWidth
- Command-Line Switch:
-handleborderwidth
- Default:
2
- The width of the 3D border drawn around the sash handles.
- Name:
handleRelief
- Class:
Relief
- Command-Line Switch:
-handlerelief
- Default:
raised
- The 3D relief in which the sash handles are drawn. This option
can take any of the values acceptable to
Tk_GetRelief
(3).
- Name:
background
- Class:
Background
- Command-Line Switch:
-background
- Default:
#ccc
- The background colour of the widget. This is usually not visible
because the widget is covered by the managed widgets and sashes.
- Name:
immediate
- Class:
Immediate
- Command-Line Switch:
-immediate
- Default:
0
- If set to
1
, the managed widgets are resized as the
sash handles are dragged. If set to 0
, the managed widgets
are only resized when the mouse button is released after the sash
handles have been dragged. The former option can be excrutiatingly slow
if large widget hierarchies are resized.
- Name: N/A
- Class: N/A
- Command-Line Switch:
-panes
- Default:
{1 1}
- A Tcl list of floating point numbers defining the number and
relative size of the panes. The length of the list defines the number
of panes. The elements of the list define the relative size of each pane.
For instance, the default value
{1 1}
defines two panes,
both of which are the same size. The value {2 1}
defines
two panes, of which the pane 0 is twice as large pane 1 (pane 0 takes
up 2/3 of the paned widget's area and pane 1 takes up 1/3 of the area.
The value {1 2 1}
defines three panes: pane 1 takes up
half the available area and panes 0 and 2 take up a quarter of the area
each.
Widget Command
- pathName
configure
option value ?option value ...?
- Configure the widget by changing one or more of its public
variables.
- pathName
manage
pane widget
- Manage the geometry of widget via pane pane.
Widget is placed into the paned widget so as to take up the
entire area allocated to pane and will be resized when the
sashes bordering pane are moved.
Bindings
By default, the following bindings apply to paned widgets:
- Moving the mouse pointer into a sash handle will highlight the handle
by changing its color to the paned widget's
handleActiveBackground.
- Moving the mouse pointer out of a sash handle will return the colour of
the handle to the paned widget's handleBackground.
- Pressing mouse button 1 while the pointer is over a sash handle will
"press" the handle - the handle will be redrawn with a sunken appearance -
and the handle will start to be dragged.
- Moving the mouse with button 1 down after pressing a sash handle will
drag the sash horizontally or vertically, depending on the orientation of
the paned widget. If the paned widget's immediate option is set,
the panes on either side of the sash will be resized as the sash is dragged.
Otherwise the panes will be resized when the handle is released.
- Releasing mouse button 1 after dragging a handle will cause the handle
to be redrawn with its usual faised appearance. If the paned widget's
immediate option is not set, the panes on either side of the
sash will be resized.
Nat Pryce (np2@doc.ic.ac.uk)