1XmPaned(library call) XmPaned(library call)
2
6 XmPaned — The Paned widget class
7
9 #include <Xm/Paned.h>
10
12 The Paned widget manages children in a vertically or horizontally tiled
13 fashion with each child in a separate pane. The panes may be dynami‐
14 cally resized by the user using "control sashes" that appear between
15 the panes.
16 Application programmers have control over whether or not sashes and
18 separators are displayed, the preferred size of each pane, and which
19 pane will be forced to absorb size restrictions imposed by the Paned
20 widget's parent.
21 Geometry Management
23 The Paned widget usually resizes its children to their preferred sizes
24 when a new child is managed. It will first attempt to resize itself to
25 contain its panes exactly. If this is not possible then it will hunt
26 through the children, from bottom to top (or right to left), for a pane
27 to resize.
28 The Paned widget will attempt to honor the geometry request of its
30 children. It will first attempt to resize itself to satisfy the
31 request then go through the layout rules below to satisfy the request.
32 Only if all panes are at their min/max values will a geometry request
33 be refused. If the XmNallowResize resource is False for the child then
34 all geometry requests will be denied,
35 of course.
36 Special Considerations
38 When a user resizes a pane with the sashes, the Paned widget assumes
39 that this new size is the preferred size of both the pane above and the
40 pane below, unless the XmNresizeToPreferred constraint resource is True
41 for that pane.
42 Layout Semantics
44 In order to make effective use of the Paned widget it is helpful to
45 know the rules it uses to determine which child will be resized in any
46 given situation. There are three rules used to determine which child
47 is resized. While these rules are always the same, the panes that are
48 searched can change depending upon what caused the change of layout.
49 Layout Rules
51 1. Do not let a pane grow larger than its max or smaller than its min
52 size. In addition do not let a pane without a sash shrink below
53 its preferred size due to a grip movement of another pane.
54 2. Do not adjust panes with XmNskipAdjust set.
56 3. Do not adjust panes away from their preferred size, although moving
58 one closer to its preferred size is fine.
59 When searching the children the Paned widget looks for panes that sat‐
61 isfy all the rules, and if unsuccessful then it eliminates rule 3 and
62 then 2. Rule 1 is always enforced.
63 If the relayout is due to a resize or change in management then the
65 panes are searched from bottom to top. If space is needed above the
66 current sash the panes are searched from bottom to top beginning with
67 the second pane above the grip that was moved. If space is needed below
68 the current sash the panes are searched from top to bottom beginning
69 with the second pane below the grip that was moved. The Paned widget
70 never wraps its pane resizing. Therefore if space is needed below the
71 sash then no widget above the sash will ever be resized.
72 Note: If the orientation is horizontal then substitute "right" for
74 "bottom" and "left" for "top" in the above paragraph.
75 Resizing Panes
77 When the Paned widget is resized it must determine a new size for each
78 pane. There are two methods of doing this. The Paned widget can either
79 give each pane its preferred size and then resize the panes to fit, or
80 it can use the current sizes and then resize the panes to fit. The XmN‐
81 resizeToPreferred constraint resource allows the application to tell
82 the Paned widget whether to query the child about its preferred size
83 (subject to the XmNpreferredPaneSize) or to use the current size when
84 refiguring the pane locations after the Paned widget has been resized.
85 All panes assume they should resize to their preferred size until the
87 Paned widget becomes visible to the user.
88 Classes
91 Paned inherits behavior and resources from the Core, Composite, Con‐
92 straint, abd Xmmanager classes.
93 The class pointer of xmPanedWidgetClass.
95 The class name is XmPaned.
97 New resources
99 The following table defines a set of widget resources used by the pro‐
100 grammer to specify data. The programmer can also set the resource val‐
101 ues for the inherited classes to set attributes for this widget. To
102 reference a resource by name or by class in a .Xdefaults file, remove
103 the XmN or XmC prefix and use the remaining letters. To specify one of
104 the defined values for a resource in a .Xdefaults file, remove the Xm
105 prefix and use the remaining letters (in either lowercase or uppercase,
106 but include any underscores between words). The codes in the access
107 column indicate if the given resource can be set at creation time (C),
108 set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
109 not applicable (N/A).
110 ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
112 │ XmPaned Re│source Set │ │ │ │
113 │Name │ Class │ Type │ Default │ Access │
114 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
115 │XmNcursor │ XmCursor │ tCursor │ None │ CSG │
116 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
117 │XmNmarginHeight │ XmCMarginHeight │ Dimension │ 3 │ CSG │
118 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
119 │XmNmarginWidth │ XmCMarginWidth │ Dimension │ 3 │ CSG │
120 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
121 │XmNorientation │ XmCOrientation │ unsigned char │ XmVERTICAL │ CSG │
122 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
123 │XmNrefigureMode │ XmCBoolean │ Boolean │ True │ CSG │
124 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
125 │XmNsashHeight │ XmCSashHeight │ Dimension │ 8 │ CSG │
126 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
127 │XmNsashIndent │ XmCSashIndent │ Position │ -10 │ CSG │
128 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
129 │XmNsashShadowThickness │ XmCShadowThickness │ Dimension │ dynamic │ CSG │
130 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
131 │XmNsashTranslations%Translations%XtTranslations%see below │ │ │ │ │
132 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
133 │XmNsashWidth │ XmCSashWidth │ Dimension │ 10 │ CSG │
134 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
135 │XmNseparatorOn │ XmCSeparatorOn │ Boolean │ True │ CSG │
136 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
137 │XmNspacing │ XmCSpacing │ Dimension │ 8 │ CSG │
138 ├──────────────────────────────────────────────────────────┼────────────────────┼───────────────┼────────────┼────────┤
139 └──────────────────────────────────────────────────────────┴────────────────────┴───────────────┴────────────┴────────┘
140 XmNcursor Image that will be displayed as the pointer cursor whenever
141 the pointer is over this widget. If the children do not
142 explicitly set their cursor attribute then this resource will
143 be inherited by each child.
144 XmNmarginHeight
146 Specifies the distance between the top and bottom edges of
147 the Paned widget and its children.
148 XmNmarginWidth
150 Specifies the distance between the left and right edges of
151 the Paned widget and its children.
152 XmNorientation
154 Specifies the layout as either vertical (with the XmVERTICAL
155 value) or horizontal (with the XmHORIZONTAL value). In the
156 vertical layout, the children are laid out in a vertically
157 tiled format. In the horizontal layout, the children are laid
158 out in a horizontal layout, with the sash moveable along the
159 horizontal axis.
160 XmNrefigureMode
162 Determines whether the panes' positions are recomputed and
163 repositioned when programmatic changes are being made to the
164 Paned widget. Setting this resource to True resets the chil‐
165 dren to their appropriate positions.
166 XmNsashHeight
168 Specifies the height of the sash.
169 XmNsashIndent
171 Specifies the horizontal placement of the sash along each
172 pane. A positive value causes the sash to be offset from the
173 near (left) side of the Paned widget, and a negative value
174 causes the sash to be offset from the far (right) side of the
175 Paned widget. If the offset is greater than the width of the
176 Paned widget minus the width of the sash, the sash is placed
177 flush against the near side of the Paned widget.
178 Whether the placement actually corresponds to the left or
180 right side of the Paned widget depends on the XmNlayoutDirec‐
181 tion resource of the widget.
182 XmNsashTranslations
184 Translation bindings for the sash. See below.
185 XmNsashShadowThickness
187 Specifies the thickness of the shadows of the sashes.
188 XmNsashWidth
190 Specifies the width of the sash.
191 XmNseparatorOn
193 Determines whether a separator is created between each of the
194 panes. Setting this resource to True creates a Separator at
195 the midpoint between each of the panes.
196 XmNspacing
198 Specifies the distance between each child pane.
199 ┌───────────────────────────────────────────────────────────────────────────────────┐
201 │ │ XmPaned Constraint │Resource Set│ │ │
202 │Name │ Class │ Type │ Default │ Access │
203 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
204 │XmNallowResize │ XmCBoolean │ Boolean │ False │ CSG │
205 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
206 │XmNpaneMaximum │ XmCPaneMaximum │ Dimension │ 1000 │ CSG │
207 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
208 │XmNpaneMinimum │ XmCPaneMinimum │ Dimension │ 1 │ CSG │
209 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
210 │XmNskipAdjust │ XmCBoolean │ Boolean │ False │ CSG │
211 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
212 │XmNpreferredPaneSize │ XmCPreferredPaneSize │ Dimension │ XmPanedAskChild │ │
213 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
214 │XmNresizeToPreferred │ XmCBoolean │ Boolean │ False │ │
215 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
216 │XmNshowSash │ XmCBoolean │ Boolean │ True │ │
217 ├─────────────────────┼──────────────────────┼───────────┼─────────────────┼────────┤
218 └─────────────────────┴──────────────────────┴───────────┴─────────────────┴────────┘
219 XmNallowResize
220 Allows an application to specify whether the Paned widget
221 should allow a pane to request to be resized. This flag has
222 an effect only after the Paned widget and its children have
223 been realized. If this flag is set to True, the Paned widget
224 tries to honor requests to alter the height of the pane. If
225 False, it always denies pane requests to resize.
226 XmNpaneMaximum
228 Allows an application to specify the maximum size to which a
229 pane may be resized. This value must be greater than the
230 specified minimum.
231 XmNpaneMinimum
233 Allows an application to specify the minimum size to which a
234 pane may be resized. This value must be greater than 0
235 (zero).
236 XmNskipAdjust
238 When set to True, this Boolean resource allows an application
239 to specify that the Paned widget should not automatically
240 resize this pane.
241 XmNpreferredPaneSize
243 Preferred size of the pane. If this value is not set the
244 paned widget will query the child for a preferred size. This
245 resource allows the user or application to provide a new pre‐
246 ferred size.
247 XmNresizeToPreferred
249 Specifies whether to resize each pane to its preferred size
250 when the Paned window is resized. If this is False then only
251 those panes the user has not resized with the sashes will be
252 resized to their preferred size.
253 XmNshowSash
255 If True show the Sash below or to the right of this pane.
256 Inherited Resources
258 Paned widget inherits behavior and resources from the superclasses
259 described in the following tables. For a complete description of each
260 resource, refer to the reference page for that superclass.
261 ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
263 │ │ XmManager │Resource Set │ │ │
264 │Name │ Class │ Type │ Default │ Access │
265 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
266 │XmNbottomShadowColor │ XmCBottomShadowColor │ Pixel │ dynamic │ CSG │
267 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
268 │XmNbottomShadowPixmap │ XmCBottomShadowPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
269 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
270 │XmNforeground │ XmCForeground │ Pixel │ dynamic │ CSG │
271 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
272 │XmNhelpCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
273 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
274 │XmNhighlightColor │ XmCHighlightColor │ Pixel │ dynamic │ CSG │
275 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
276 │XmNhighlightPixmap │ XmCHighlightPixmap │ Pixmap │ dynamic │ CSG │
277 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
278 │XmNinitialFocus │ XmCInitialFocus │ Widget │ NULL │ CSG │
279 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
280 │XmNlayoutDirection │ XmCLayoutDirection │ XmDirection │ dynamic │ CG │
281 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
282 │XmNnavigationType │ XmCNavigationType │ XmNavigationType │ XmTAB_GROUP │ CSG │
283 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
284 │XmNpopupHandlerCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
285 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
286 │XmNshadowThickness │ XmCShadowThickness │ Dimension │ 2 │ CSG │
287 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
288 │XmNstringDirection │ XmCStringDirection │ XmStringDirection │ dynamic │ CG │
289 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
290 │XmNtopShadowColor │ XmCTopShadowColor │ Pixel │ dynamic │ CSG │
291 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
292 │XmNtopShadowPixmap │ XmCTopShadowPixmap │ Pixmap │ dynamic │ CSG │
293 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
294 │XmNtraversalOn │ XmCTraversalOn │ Boolean │ True │ CSG │
295 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
296 │XmNunitType │ XmCUnitType │ unsigned char │ dynamic │ CSG │
297 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
298 │XmNuserData │ XmCUserData │ XtPointer │ NULL │ CSG │
299 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
300 └────────────────────────┴───────────────────────┴───────────────────┴──────────────────────┴────────┘
301 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
302 │ │ Core Resource Se│t │ │ │
303 │Name │ Class │ Type │ Default │ Access │
304 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
305 │XmNaccelerators │ XmCAccelerators │ XtAccelerators │ dynamic │ CSG │
306 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
307 │XmNancestorSensitive │ XmCSensitive │ Boolean │ dynamic │ G │
308 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
309 │XmNbackground │ XmCBackground │ Pixel │ dynamic │ CSG │
310 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
311 │XmNbackgroundPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
312 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
313 │XmNborderColor │ XmCBorderColor │ Pixel │ XtDefaultForeground │ CSG │
314 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
315 │XmNborderPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
316 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
317 │XmNborderWidth │ XmCBorderWidth │ Dimension │ 0 │ CSG │
318 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
319 │XmNcolormap │ XmCColormap │ Colormap │ dynamic │ CG │
320 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
321 │XmNdepth │ XmCDepth │ int │ dynamic │ CG │
322 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
323 │XmNdestroyCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
324 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
325 │XmNheight │ XmCHeight │ Dimension │ dynamic │ CSG │
326 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
327 │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean │ True │ C │
328 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
329 │XmNmappedWhenManaged │ XmCMappedWhenManaged │ Boolean │ True │ CSG │
330 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
331 │XmNscreen │ XmCScreen │ Screen * │ dynamic │ CG │
332 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
333 │XmNsensitive │ XmCSensitive │ Boolean │ True │ CSG │
334 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
335 │XmNtranslations │ XmCTranslations │ XtTranslations │ dynamic │ CSG │
336 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
337 │XmNwidth │ XmCWidth │ Dimension │ dynamic │ CSG │
338 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
339 │XmNx │ XmCPosition │ Position │ 0 │ CSG │
340 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
341 │XmNy │ XmCPosition │ Position │ 0 │ CSG │
342 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
343 └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
344 ┌─────────────────────────────────────────────────────────────────────────────────┐
345 │ │ Composite│Resource Set │ │ │
346 │Name │ Class │ Type │ Default │ Access │
347 ├──────────────────┼───────────────────┼─────────────┼───────────────────┼────────┤
348 │XmNchildren │ XmCReadOnly │ WidgetList │ NULL │ G │
349 ├──────────────────┼───────────────────┼─────────────┼───────────────────┼────────┤
350 │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ default procedure │ CSG │
351 ├──────────────────┼───────────────────┼─────────────┼───────────────────┼────────┤
352 │XmNnumChildren │ XmCReadOnly │ Cardinal │ 0 │ G │
353 ├──────────────────┼───────────────────┼─────────────┼───────────────────┼────────┤
354 │ │ │ │ │ │
355 └──────────────────┴───────────────────┴─────────────┴───────────────────┴────────┘
356 Translations
357 XmPaned widget inherits translations from XmManager.
358 The translations for sashes within the Paned widget are described in
360 the following table.
361 The following key names are listed in the X standard key event transla‐
363 tion table syntax. This format is the one used by Motif to specify the
364 widget actions corresponding to a given key. A brief overview of the
365 format is provided under VirtualBindings(3). For a complete descrip‐
366 tion of the format, please refer to the X Toolkit Instrinsics Documen‐
367 tation.
368 ∼c ∼s ∼m ∼a <Btn1Down>:
370 SashAction(Start)
371 ∼c ∼s ∼m ∼a <Btn1Motion>:
373 SashAction(Move)
374 ∼c ∼s ∼m ∼a <Btn1Up>:
376 SashAction(Commit)
377 ∼c ∼s ∼m ∼a <Btn2Down>:
379 SashAction(Start)
380 ∼c ∼s ∼m ∼a <Btn2Motion>:
382 SashAction(Move)
383 ∼c ∼s ∼m ∼a <Btn2Up>:
385 SashAction(Commit)
386 :<Key><osfHelp>:
388 Help()
389 :c <Key><osfUp>:
391 SashAction(Key,10,Up)
392 :<Key><osfUp>:
394 SashAction(Key,1,Up)
395 :c <Key><osfRight>:
397 SashAction(Key,10,Right)
398 :<Key><osfRight>:
400 SashAction(Key,1,Right)
401 :c <Key><osfDown>:
403 SashAction(Key,10,Down)
404 :<Key><osfDown>:
406 SashAction(Key,1,Down)
407 :c <Key><osfLeft>:
409 SashAction(Key,10,Left)
410 :<Key><osfLeft>:
412 SashAction(Key,1,Left)
413 s ∼m ∼a <Key>Tab:
415 PrevTabGroup()
416 ∼m ∼a <Key>Tab:
418 NextTabGroup()
419 Action Routines
421 The XmPaned action routines are
422 Help(): Calls the callbacks for XmNhelpCallback if any exist. If
424 there are no help callbacks for this widget, this action
425 calls the help callbacks for the nearest ancestor that has
426 them.
427 NextTabGroup():
429 Moves the keyboard focus to the next tab group. By default,
430 each pane and sash is a tab group.
431 PrevTabGroup():
433 Moves the keyboard focus to the previous tab group. By
434 default, each pane and sash is a tab group.
435 SashAction(action) or SashAction(Key,increment,direction):
437 The Start action activates the interactive placement of the
438 pane's borders. The Move action causes the sash to track the
439 position of the pointer. If one of the panes reaches its
440 minimum or maximum size, adjustment continues with the next
441 adjustable pane. The Commit action ends sash motion.
442 When sash action is caused by a keyboard event, the sash with
444 the keyboard focus is moved according to the increment and
445 direction specified. DefaultIncr adjusts the sash by one
446 line. LargeIncr adjusts the sash by one view region. The
447 direction is specified as either Up, Down, Left, or Right.
448 Note that the SashAction action routine is not a direct
450 action routine of the XmPaned, but rather an action of the
451 Sash control created by the XmPaned.
452 Additional Behavior
454 This widget has the following additional behavior:
455 <FocusIn>:
457 Moves the keyboard focus to the sash and highlights it
458 <FocusOut>:
460 Unsets the keyboard focus in the sash and unhighlights it
461 Virtual Bindings
463 The bindings for virtual keys are vendor specific. For information
464 about bindings for virtual buttons and keys, see VirtualBindings(3).
465
467 Composite(3), Constraint(3), Core(3), XmCreatePaned(3), XmManager(3),
468 XmPaneGetpanes(3), XmVaCreatePaned(3), and XmVaCreateManagedPaned(3).
469 XmPaned(library call)