1Panedwindow(3)        User Contributed Perl Documentation       Panedwindow(3)
2
3
4

NAME

6       Tk::Panedwindow - Create and manipulate Panedwindow widgets
7

SYNOPSIS

9       $panedwindow = $parent->Panedwindow(?options?);
10
11        -background    -height  -width
12        -borderwidth   -orient
13        -cursor        -relief
14

WIDGET-SPECIFIC OPTIONS

16       Option:   -handlepad
17       Name:     handlePad
18       Class:    HandlePad
19           When sash handles are drawn, specifies the distance from the top or
20           left end of the sash (depending on the orientation of the widget)
21           at which to draw the handle.  May be any value accepted by
22           Tk_GetPixels.
23
24       Option:   -handlesize
25       Name:     handleSize
26       Class:    HandleSize
27           Specifies the side length of a sash handle.  Handles are always
28           drawn as squares.  May be any value accepted by Tk_GetPixels.
29
30       Option:   -opaqueresize
31       Name:     opaqueResize
32       Class:    OpaqueResize
33           Specifies whether panes should be resized as a sash is moved
34           (true), or if resizing should be deferred until the sash is placed
35           (false).
36
37       Option:   -sashcursor
38       Name:     sashCursor
39       Class:    SashCursor
40           Mouse cursor to use when over a sash.  If null, sb_h_double_arrow
41           will be used for horizontal Panedwindows, and sb_v_double_arrow
42           will be used for vertical Panedwindows.
43
44       Option:   -sashpad
45       Name:     sashPad
46       Class:    SashPad
47           Specifies the amount of padding to leave of each side of a sash.
48           May be any value accepted by Tk_GetPixels.
49
50       Option:   -sashrelief
51       Name:     sashRelief
52       Class:    SashRelief
53           Relief to use when drawing a sash.  May be any of the standard Tk
54           relief values.
55
56       Option:   -sashwidth
57       Name:     sashWidth
58       Class:    SashWidth
59           Specifies the width of each sash.  May be any value accepted by
60           Tk_GetPixels.
61
62       Option:   -showhandle
63       Name:     showHandle
64       Class:    ShowHandle
65           Specifies whether sash handles should be shown.  May be any valid
66           boolean value.
67

DESCRIPTION

69       The Panedwindow method creates a new window (given by the $panedwindow
70       argument) and makes it into a Panedwindow widget.  Additional options,
71       described above, may be specified on the command line or in the option
72       database to configure aspects of the Panedwindow such as its default
73       background color and relief.
74
75       A Panedwindow widget contains any number of panes, arranged
76       horizontally or vertically, according to the value of the -orient
77       option.  Each pane contains one widget, and each pair of panes is
78       separated by a moveable (via mouse movements) sash.  Moving a sash
79       causes the widgets on either side of the sash to be resized.
80

WIDGET METHODS

82       The Panedwindow method may be used to invoke various operations on the
83       widget.  It has the following general form:
84
85        $widget->method(?arg arg ...?);
86
87       The following commands are possible for Panedwindow widgets:
88
89       $widget->add(?window ...? ?option value ...?);
90           Add one or more windows to the Panedwindow, each in a separate
91           pane.  The arguments consist of the names of one or more windows
92           followed by pairs of arguments that specify how to manage the
93           windows.  Option may have any of the values accepted by the
94           configure subcommand.
95
96       $widget->cget(option);
97           Returns the current value of the configuration option given by
98           option.  Option may have any of the values accepted by the
99           Panedwindow command.
100
101       $widget->configure(?option?, ?value, option, value, ...?);
102           Query or modify the configuration options of the widget.  If no
103           option is specified, returns a list describing all of the available
104           options for $widget (see Tk::configure for information on the
105           format of this list).  If option is specified with no value, then
106           the command returns a list describing the one named option (this
107           list will be identical to the corresponding sublist of the value
108           returned if no option is specified).  If one or more option-value
109           pairs are specified, then the command modifies the given widget
110           option(s) to have the given value(s);  in this case the command
111           returns an empty string. Option may have any of the values accepted
112           by the Panedwindow command.
113
114       $widget->forget(?window ...?);
115           Remove the pane containing $widget from the Panedwindow.  All
116           geometry management options for $widget will be forgotten.
117
118       $widget->identify(x, y);
119           Identify the Panedwindow component underneath the point given by x
120           and y, in window coordinates.  If the point is over a sash or a
121           sash handle, the result is a two element list containing the index
122           of the sash or handle, and a word indicating whether it is over a
123           sash or a handle, such as [0, 'sash'] or [2, 'handle'].  If the
124           point is over any other part of the Panedwindow, the result is an
125           empty list.
126
127       $widget->proxy(?args?);
128           This command is used to query and change the position of the sash
129           proxy, used for rubberband-style pane resizing. It can take any of
130           the following forms:
131
132           $widget->proxyCoord;
133               Return a list containing the x and y coordinates of the most
134               recent proxy location.
135
136           $widget->proxyForget;
137               Remove the proxy from the display.
138
139           $widget->proxyPlace(x, y);
140               Place the proxy at the given x and y coordinates.
141
142       $widget->sash(?args?);
143           This command is used to query and change the position of sashes in
144           the Panedwindow.  It can take any of the following forms:
145
146           $widget->sashCoord(index);
147               Return the current x and y coordinate pair for the sash given
148               by index.  Index must be an integer between 0 and 1 less than
149               the number of panes in the Panedwindow.  The coordinates given
150               are those of the top left corner of the region containing the
151               sash.  $widget->sashDragto(index, x, y) This command computes
152               the difference between the given coordinates and the
153               coordinates given to the last sash coord command for the given
154               sash.  It then moves that sash the computed difference.  The
155               return value is the empty string.
156
157           $widget->sashMark(index, x, y);
158               Records x and y for the sash given by index; used in
159               conjunction with later dragto commands to move the sash.
160
161           $widget->sashPlace(index, x, y);
162               Place the sash given by index at the given coordinates.
163
164       $widget $widget->panecget(option);
165           Query a management option for $widget.  Option may be any value
166           allowed by the paneconfigure subcommand.
167
168       $widget $widget->paneconfigure(?option? ?value option value ...?);
169           Query or modify the management options for $widget.  If no option
170           is specified, returns a list describing all of the available
171           options for $widget (see Tk::configure for information on the
172           format of this list).  If option is specified with no value, then
173           the command returns a list describing the one named option (this
174           list will be identical to the corresponding sublist of the value
175           returned if no option is specified).  If one or more option-value
176           pairs are specified, then the command modifies the given widget
177           option(s) to have the given value(s);  in this case the command
178           returns an empty string.  The following options are supported:
179
180           -after => $widget
181               Insert the window after the window specified.  $widget should
182               be the name of a window already managed by $widget.
183
184           -before => $widget
185               Insert the window before the window specified.  $widget should
186               be the name of a window already managed by $widget.
187
188           -height => size
189               Specify a height for the window.  The height will be the outer
190               dimension of the window including its border, if any.  If size
191               is an empty string, or if -height is not specified, then the
192               height requested internally by the window will be used
193               initially; the height may later be adjusted by the movement of
194               sashes in the Panedwindow.  Size may be any value accepted by
195               Tk_GetPixels.
196
197           -minsize => n
198               Specifies that the size of the window cannot be made less than
199               n.  This constraint only affects the size of the widget in the
200               paned dimension -- the x dimension for horizontal Panedwindows,
201               the y dimension for vertical Panedwindows.  May be any value
202               accepted by Tk_GetPixels.
203
204           -padx => n
205               Specifies a non-negative value indicating how much extra space
206               to leave on each side of the window in the X-direction.  The
207               value may have any of the forms accepted by Tk_GetPixels.
208
209           -pady => n
210               Specifies a non-negative value indicating how much extra space
211               to leave on each side of the window in the Y-direction.  The
212               value may have any of the forms accepted by Tk_GetPixels.
213
214           -sticky => style
215               If a window's pane is larger than the requested dimensions of
216               the window, this option may be used to position (or stretch)
217               the window within its pane.  Style  is a string that contains
218               zero or more of the characters n, s, e or w.  The string can
219               optionally contains spaces or commas, but they are ignored.
220               Each letter refers to a side (north, south, east, or west) that
221               the window will "stick" to.  If both n and s (or e and w) are
222               specified, the window will be stretched to fill the entire
223               height (or width) of its cavity.
224
225           -width => size
226               Specify a width for the window.  The width will be the outer
227               dimension of the window including its border, if any.  If size
228               is an empty string, or if -width is not specified, then the
229               width requested internally by the window will be used
230               initially; the width may later be adjusted by the movement of
231               sashes in the Panedwindow.  Size may be any value accepted by
232               Tk_GetPixels.
233
234       $widget->panes;
235           Returns an ordered list of the widgets managed by $widget.
236

RESIZING PANES

238       A pane is resized by grabbing the sash (or sash handle if present) and
239       dragging with the mouse.  This is accomplished via mouse motion
240       bindings on the widget.  When a sash is moved, the sizes of the panes
241       on each side of the sash, and thus the widgets in those panes, are
242       adjusted.
243
244       When a pane is resized from outside (eg, it is packed to expand and
245       fill, and the containing toplevel is resized), space is added to the
246       final (rightmost or bottommost) pane in the window.
247

KEYWORDS

249       Panedwindow, widget, geometry management
250
251
252
253perl v5.36.0                      2023-01-20                    Panedwindow(3)
Impressum