1tixPanedWindow(n) Tix Built-In Commands tixPanedWindow(n)
2
6 tixPanedWindow - Create and manipulate tixPanedWindow widgets
7
9 tixPanedWindow pathName ?options?
10
12 The PanedWindow widget supports all the standard options of a frame
13 widget. See the options(n) manual entry for details on the standard
14 options.
15
17 Name: command
18 Class: Command
19 Switch: -command
20 Specifies the command to invoke when the panes change their
22 sizes. This command is called with a list of integers that
23 record the new sizes of the panes. The sizes of the panes are
24 listed in the order of the panes' creation. [-dynamicgeome‐
25 try dynamicGeometry] If set to true, the size of the PanedWindow
26 will dynamically change if the size of any of its panes changes.
27 Otherwise, the size of the PanedWindow will only increase when
28 size of any of its panes changes and will not decrease. The
29 default value is true. [-handleactivebg handleActiveBg] Speci‐
30 fies the active background color of the resize handles. When the
31 mouse cursor enters a resize handle, the resize handle will
32 adopt the active background color. [-handlebg handleBg] Speci‐
33 fies the normal background color of the resize handles.
34 [-height height] Specifies the desired height for the window.
35 [-orientation orientation] Specifies the orientation of the
36 panes. Must be either vertical or horizontal. [-paneborderwidth
37 or -panebd paneBorderWidth] Specifies the border width of the
38 panes. [-panerelief paneRelief] Specifies the border relief of
39 the panes. [-separatoractivebg separatorActiveBg] Specifies the
40 active background color of the separators. When the user grabs a
41 resize handle, the separators will adopt the active background
42 color. [-separatorbg separatorBg] Specifies the normal back‐
43 ground color of the separators. [-width width] Specifies the
44 desired width for the window.
45
47 All the pane subwidgets created as a result of the add command can be
48 accessed by the subwidget command. They are identified by the paneName
49 parameter to the add command.
50
52 The tixPanedWindow command creates a new window (given by the pathName
53 argument) and makes it into a PanedWindow widget. Additional options,
54 described above, may be specified on the command line or in the option
55 database to configure aspects of the PanedWindow widget such as its
56 cursor and relief.
57 The PanedWindow widget allows the user to interactively manipulate the
59 sizes of several panes. The panes can be arranged either vertically or
60 horizontally. Each individual pane may have upper and lower limits of
61 its size. The user changes the sizes of the panes by dragging the
62 resize handle between two panes.
63
65 The tixPanedWindow command creates a new Tcl command whose name is the
66 same as the path name of the PanedWindow widget's window. This command
67 may be used to invoke various operations on the widget. It has the
68 following general form:
69 pathName option ?arg arg ...?
70 PathName is the name of the command, which is the same as the frame
71 widget's path name. Option and the args determine the exact behavior of
72 the command. The following commands are possible for PanedWindow wid‐
73 gets:
74 pathName add paneName ?option value ...?
76 Adds a new pane subwidget with the name paneName into the Paned‐
77 Window widget. Additional configuration options can be given to
78 configure the new button subwidget. Three configuration options
79 are supported:
80 -after pane
82 Specifies that the new pane should be placed after pane
83 in the list of panes in this PanedWindow widget.
84 -at integer
86 Specifies the position of the new pane in the list of
87 panes in this PanedWindow widget. 0 means the first posi‐
88 tion, 1 means the second, and so on. In addition, end
89 means the end of the list.
90 -before pane
92 Specifies that the new pane should be placed before pane
93 in the list of panes in this PanedWindow widget.
94 -expand factor
96 Specifies the expand/shrink factor of this pane. Factor
97 must be a non-negative floating point number. The default
98 value is 0.0. The expand/shrink factor is used to calcu‐
99 late how much each pane should grow or shrink when the
100 size of the PanedWindow main window is changed. When the
101 main window expands/shrinks by n pixels, then pane i will
102 grow/shrink by about n * factor(i) / summation(factors),
103 where factor(i) is the expand/shrink factor of pane i and
104 summation(factors) is the summation of the expand/shrink
105 factors of all the panes. If summation(factors) is 0.0,
106 however, only the last visible pane will be grown or
107 shrunk.
108 -min integer
110 Specifies the minimum size, in pixels, of the new pane;
111 the default is 0.
112 -max integer
114 Specifies the maximum size, in pixels, of the new pane;
115 the default is 10000.
116 -size integer
118 Specifies the size, in pixels, of the new pane; if the
119 -size option is not given, or set to the empty string,
120 the PanedWindow widget will use the natural size of the
121 pane subwidget.
122 pathName cget option
124 Returns the current value of the configuration option given by
125 option. Option may be -min, -max and/or -size, or any option
126 accepted by the Tk frame widget.
127 pathName configure ?option? ?value option value ...?
129 Query or modify the configuration options of the widget. If no
130 option is specified, returns a list describing all of the avail‐
131 able options for pathName (see Tk_ConfigureInfo for information
132 on the format of this list). If option is specified with no
133 value, then the command returns a list describing the one named
134 option (this list will be identical to the corresponding sublist
135 of the value returned if no option is specified). If one or
136 more option-value pairs are specified, then the command modifies
137 the given widget option(s) to have the given value(s); in this
138 case the command returns an empty string. Option may be any of
139 the non-static options of the PanedWindow widget.
140 pathName delete paneName
142 Removes the pane given by paneName and deletes its contents.
143 pathName forget paneName
145 Removes the pane given by paneName but does not delete its con‐
146 tents. This pane can be later added back to the PanedWindow wid‐
147 get by the manage method.
148 pathName manage paneName ?option value ...?
150 Adds the pane given by paneName back to the PanedWindow widget.
151 PaneName must be already forgotten by the forget method. Addi‐
152 tional option-value pairs, same as those accepted by the add
153 method, can be given to control the appearance and position of
154 the pane.
155 pathName panecget paneName option
157 Returns the current value of the configuration option given by
158 option in the pane given by paneName. Option may have any of the
159 values accepted by the add widget command.
160 pathName paneconfigure paneName ?option? ?value ...?
162 When no option is given, prints out the values of all options of
163 this pane. If option is specified with no value, then the com‐
164 mand returns the current value of that option. If one or more
165 option-value pairs are specified, then the command modifies the
166 given pane's option(s) to have the given value(s); in this case
167 the command returns an empty string. Option may be -min, -max
168 and/or -size, or any option accepted by the Tk frame widget. The
169 sizes of the panes may be changed as a result of calling the
170 paneconfigure command.
171 pathName panes
173 Returns a list of the names of all panes.
174 pathName setsize paneName newSize ?direction?
176 Sets the size of the pane specified by paneName to newSize. The
177 direction parameter specifies in which direction the pane should
178 grow/shrink. Possible values are next: the pane will grow or
179 shrink by moving the boundary between itself and the pane to its
180 right or bottom; prev: the pane will grow or shrink by moving
181 the boundary between itself and the pane to its left or top.
182 pathName subwidget name ?args?
184 When no options are given, returns the pathname of the subwidget
185 of the specified name.
186 When options are given, the widget command of the specified subwidget
188 will be called with these options.
189
191 The panes' sizes will be changed when the user drags the handles. The
192 change in the panes' sizes may be subjected to the -min, -max and -size
193 options of the panes.
194
196 TIX, Container Widget
197Tix 4.0 tixPanedWindow(n)