1WMShell(library call) WMShell(library call)
2
6 WMShell — The WMShell widget class
7
9 #include <Xm/Xm.h>
10 #include <X11/Shell.h>
11
13 WMShell is a top-level widget that encapsulates the interaction with
14 the window manager.
15 Classes
17 WMShell inherits behavior and resources from the Core, Composite, and
18 Shell classes.
19 The class pointer is wmShellWidgetClass.
21 The class name is WMShell.
23 New Resources
25 The following table defines a set of widget resources used by the pro‐
26 grammer to specify data. The programmer can also set the resource val‐
27 ues for the inherited classes to set attributes for this widget. To
28 reference a resource by name or by class in a .Xdefaults file, remove
29 the XmN or XmC prefix and use the remaining letters. To specify one of
30 the defined values for a resource in a .Xdefaults file, remove the Xm
31 prefix and use the remaining letters (in either lowercase or uppercase,
32 but include any underscores between words). The codes in the access
33 column indicate if the given resource can be set at creation time (C),
34 set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
35 not applicable (N/A).
36 ┌───────────────────────────────────────────────────────────────────────────────┐
38 │ │ WMShell│Resource │Set │ │
39 │Name │ Class │ Type │ Default │ Access │
40 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
41 │XmNbaseHeight │ XmCBaseHeight │ int │ XtUnspecifiedShellInt │ CSG │
42 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
43 │XmNbaseWidth │ XmCBaseWidth │ int │ XtUnspecifiedShellInt │ CSG │
44 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
45 │XmNheightInc │ XmCHeightInc │ int │ XtUnspecifiedShellInt │ CSG │
46 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
47 │XmNiconMask │ XmCIconMask │ Pixmap │ NULL │ CSG │
48 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
49 │XmNiconPixmap │ XmCIconPixmap │ Pixmap │ NULL │ CSG │
50 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
51 │XmNiconWindow │ XmCIconWindow │ Window │ NULL │ CSG │
52 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
53 │XmNiconX │ XmCIconX │ int │ XtUnspecifiedShellInt │ CSG │
54 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
55 │XmNiconY │ XmCIconY │ int │ XtUnspecifiedShellInt │ CSG │
56 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
57 │XmNinitialState │ XmCInitialState │ int │ NormalState │ CSG │
58 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
59 │XmNinput │ XmCInput │ Boolean │ False │ CSG │
60 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
61 │XmNmaxAspectX │ XmCMaxAspectX │ int │ XtUnspecifiedShellInt │ CSG │
62 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
63 │XmNmaxAspectY │ XmCMaxAspectY │ int │ XtUnspecifiedShellInt │ CSG │
64 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
65 │XmNmaxHeight │ XmCMaxHeight │ int │ XtUnspecifiedShellInt │ CSG │
66 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
67 │XmNmaxWidth │ XmCMaxWidth │ int │ XtUnspecifiedShellInt │ CSG │
68 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
69 │XmNminAspectX │ XmCMinAspectX │ int │ XtUnspecifiedShellInt │ CSG │
70 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
71 │XmNminAspectY │ XmCMinAspectY │ int │ XtUnspecifiedShellInt │ CSG │
72 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
73 │XmNminHeight │ XmCMinHeight │ int │ XtUnspecifiedShellInt │ CSG │
74 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
75 │XmNminWidth │ XmCMinWidth │ int │ XtUnspecifiedShellInt │ CSG │
76 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
77 │XmNtitle │ XmCTitle │ String │ dynamic │ CSG │
78 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
79 │XmNtitleEncoding │ XmCTitleEncoding │ Atom │ dynamic │ CSG │
80 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
81 │XmNtransient │ XmCTransient │ Boolean │ False │ CSG │
82 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
83 │XmNwaitForWm │ XmCWaitForWm │ Boolean │ True │ CSG │
84 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
85 │XmNwidthInc │ XmCWidthInc │ int │ XtUnspecifiedShellInt │ CSG │
86 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
87 │XmNwindowGroup │ XmCWindowGroup │ Window │ dynamic │ CSG │
88 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
89 │XmNwinGravity │ XmCWinGravity │ int │ dynamic │ CSG │
90 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
91 │XmNwmTimeout │ XmCWmTimeout │ int │ 5000 ms │ CSG │
92 ├─────────────────┼──────────────────┼─────────┼───────────────────────┼────────┤
93 └─────────────────┴──────────────────┴─────────┴───────────────────────┴────────┘
94 XmNbaseHeight
95 Specifies the base for a progression of preferred heights for
96 the window manager to use in sizing the widget. The pre‐
97 ferred heights are XmNbaseHeight plus integral multiples of
98 XmNheightInc, with a minimum of XmNminHeight and a maximum of
99 XmNmaxHeight. If an initial value is not supplied for XmN‐
100 baseHeight but is supplied for XmNbaseWidth, the value of
101 XmNbaseHeight is set to 0 (zero) when the widget is realized.
102 XmNbaseWidth
104 Specifies the base for a progression of preferred widths for
105 the window manager to use in sizing the widget. The pre‐
106 ferred widths are XmNbaseWidth plus integral multiples of
107 XmNwidthInc, with a minimum of XmNminWidth and a maximum of
108 XmNmaxWidth. If an initial value is not supplied for XmN‐
109 baseWidth but is supplied for XmNbaseHeight, the value of
110 XmNbaseWidth is set to 0 (zero) when the widget is realized.
111 XmNheightInc
113 Specifies the increment for a progression of preferred
114 heights for the window manager to use in sizing the widget.
115 The preferred heights are XmNbaseHeight plus integral multi‐
116 ples of XmNheightInc, with a minimum of XmNminHeight and a
117 maximum of XmNmaxHeight. If an initial value is not supplied
118 for XmNheightInc but is supplied for XmNwidthInc, the value
119 of XmNheightInc is set to 1 when the widget is realized.
120 XmNiconMask
122 Specifies a bitmap that could be used by the window manager
123 to clip the XmNiconPixmap bitmap to make the icon nonrectan‐
124 gular.
125 XmNiconPixmap
127 Specifies a bitmap that could be used by the window manager
128 as the application's icon.
129 XmNiconWindow
131 Specifies the ID of a window that could be used by the window
132 manager as the application's icon.
133 XmNiconX Specifies a suitable place to put the application's icon;
135 this is a hint to the window manager in root window coordi‐
136 nates. Because the window manager controls icon placement
137 policy, this resource may be ignored.
138 XmNiconY Specifies a suitable place to put the application's icon;
140 this is a hint to the window manager in root window coordi‐
141 nates. Because the window manager controls icon placement
142 policy, this resource may be ignored.
143 XmNinitialState
145 Specifies the state the application wants the widget instance
146 to start in. It must be one of the constants NormalState or
147 IconicState.
148 XmNinput Specifies the application's input model for this widget and
150 its descendants. The meaning of a True or False value for
151 this resource depends on the presence or absence of a
152 WM_TAKE_FOCUS atom in the WM_PROTOCOLS property:
153 ┌────────────────┬──────────┬───────────────┐
155 │Input Model │ XmNinput │ WM_TAKE_FOCUS │
156 ├────────────────┼──────────┼───────────────┤
157 │No input │ False │ Absent │
158 ├────────────────┼──────────┼───────────────┤
159 │Passive │ True │ Absent │
160 ├────────────────┼──────────┼───────────────┤
161 │Locally active │ True │ Present │
162 ├────────────────┼──────────┼───────────────┤
163 │Globally active │ False │ Present │
164 ├────────────────┼──────────┼───────────────┤
165 └────────────────┴──────────┴───────────────┘
166 For more information on input models, see the X Consortium
167 Standard Inter-Client Communication Conventions Manual
168 (ICCCM).
169 XmNmaxAspectX
171 Specifies the numerator of the maximum aspect ratio (X/Y)
172 that the application wants the widget instance to have.
173 XmNmaxAspectY
175 Specifies the denominator of the maximum aspect ratio (X/Y)
176 that the application wants the widget instance to have.
177 XmNmaxHeight
179 Specifies the maximum height that the application wants the
180 widget instance to have.
181 XmNmaxWidth
183 Specifies the maximum width that the application wants the
184 widget instance to have.
185 XmNminAspectX
187 Specifies the numerator of the minimum aspect ratio (X/Y)
188 that the application wants the widget instance to have.
189 XmNminAspectY
191 Specifies the denominator of the minimum aspect ratio (X/Y)
192 that the application wants the widget instance to have.
193 XmNminHeight
195 Specifies the minimum height that the application wants the
196 widget instance to have.
197 XmNminWidth
199 Specifies the minimum width that the application wants the
200 widget instance to have.
201 XmNtitle Specifies the application name to be displayed by the window
203 manager. The default is the icon name, if specified; other‐
204 wise, it is the name of the application. When XtGetValues is
205 called on this resource, the returned value is a pointer to
206 the actual resource value and should not be freed.
207 XmNtitleEncoding
209 Specifies a property type that represents the encoding of the
210 XmNtitle string. If a language procedure has been set, the
211 default is None; otherwise, the default is XA_STRING. When
212 the widget is realized, if the value is None, the correspond‐
213 ing name is assumed to be in the current locale. The name is
214 passed to XmbTextListToTextProperty with an encoding style of
215 XStdICCTextStyle. The resulting encoding is STRING if the
216 name is fully convertible to STRING; otherwise it is COM‐
217 POUND_TEXT. The values of the encoding resources are not
218 changed; they remain None.
219 XmNtransient
221 Specifies a Boolean value that is True if the widget instance
222 is transient, typically a popup on behalf of another widget.
223 The window manager may treat a transient widget's window dif‐
224 ferently from other windows. For example, a window manager
225 may not iconify a transient window separately from its asso‐
226 ciated application. Applications and users should not nor‐
227 mally alter this resource.
228 XmNwaitForWm
230 When True, specifies that the Intrinsics waits the length of
231 time given by the XmNwmTimeout resource for the window man‐
232 ager to respond to certain actions before assuming that there
233 is no window manager present. This resource is altered by
234 the Intrinsics as it receives, or fails to receive, responses
235 from the window manager.
236 XmNwidthInc
238 Specifies the base for a progression of preferred widths for
239 the window manager to use in sizing the widget. The pre‐
240 ferred widths are XmNbaseWidth plus integral multiples of
241 XmNwidthInc, with a minimum of XmNminWidth and a maximum of
242 XmNmaxWidth. If an initial value is not supplied for XmN‐
243 widthInc but is supplied for XmNheightInc, the value of XmN‐
244 widthInc is set to 1 when the widget is realized.
245 XmNwindowGroup
247 Specifies the ID of a window with which this widget instance
248 is associated. By convention, this window is the "leader" of
249 a group of windows. A window manager may treat all windows
250 in a group in some way; for example, it may always move or
251 iconify them together.
252 If no initial value is specified, the value is set to the
254 window of the first realized ancestor widget in the parent
255 hierarchy when the widget is realized. If a value of XtUn‐
256 specifiedWindowGroup is specified, no window group is set.
257 XmNwinGravity
259 Specifies the window gravity for use by the window manager in
260 positioning the widget. If no initial value is specified,
261 the value is set when the widget is realized. If XmNgeometry
262 is not NULL, XmNwinGravity is set to the window gravity
263 returned by XWMGeometry. Otherwise, XmNwinGravity is set to
264 NorthWestGravity.
265 XmNwmTimeout
267 Specifies the length of time that the Intrinsics waits for
268 the window manager to respond to certain actions before
269 assuming that there is no window manager present. The value
270 is in milliseconds and must not be negative.
271 Inherited Resources
273 WMShell inherits behavior and resources from the superclasses described
274 in the following tables. For a complete description of each resource,
275 refer to the reference page for that superclass.
276 ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐
278 │ │ Shell Res│ource Set │ │ │
279 │Name │ Class │ Type │ Default │ Access │
280 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
281 │XmNallowShellResize │ XmCAllowShellResize │ Boolean │ False │ CG │
282 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
283 │XmNcreatePopupChildProc │ XmCCreatePopupChildProc │ XtCreatePopupChildProc │ NULL │ CSG │
284 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
285 │XmNgeometry │ XmCGeometry │ String │ NULL │ CSG │
286 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
287 │XmNoverrideRedirect │ XmCOverrideRedirect │ Boolean │ False │ CSG │
288 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
289 │XmNpopdownCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
290 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
291 │XmNpopupCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
292 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
293 │XmNsaveUnder │ XmCSaveUnder │ Boolean │ False │ CSG │
294 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
295 │XmNvisual │ XmCVisual │ Visual * │ CopyFromParent │ CSG │
296 ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
297 └────────────────────────┴─────────────────────────┴────────────────────────┴────────────────┴────────┘
298 ┌───────────────────────────────────────────────────────────────────────┐
299 │ │ Composite Reso│urce Set │ │ │
300 │Name │ Class │ Type │ Default │ Access │
301 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
302 │XmNchildren │ XmCReadOnly │ WidgetList │ NULL │ G │
303 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
304 │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL │ CSG │
305 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
306 │XmNnumChildren │ XmCReadOnly │ Cardinal │ 0 │ G │
307 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
308 └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
309 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
310 │ │ Core Resource Se│t │ │ │
311 │Name │ Class │ Type │ Default │ Access │
312 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
313 │XmNaccelerators │ XmCAccelerators │ XtAccelerators │ dynamic │ CSG │
314 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
315 │XmNancestorSensitive │ XmCSensitive │ Boolean │ dynamic │ G │
316 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
317 │XmNbackground │ XmCBackground │ Pixel │ dynamic │ CSG │
318 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
319 │XmNbackgroundPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
320 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
321 │XmNborderColor │ XmCBorderColor │ Pixel │ XtDefaultForeground │ CSG │
322 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
323 │XmNborderPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
324 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
325 │XmNborderWidth │ XmCBorderWidth │ Dimension │ 0 │ CSG │
326 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
327 │XmNcolormap │ XmCColormap │ Colormap │ dynamic │ CG │
328 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
329 │XmNdepth │ XmCDepth │ int │ dynamic │ CG │
330 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
331 │XmNdestroyCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
332 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
333 │XmNheight │ XmCHeight │ Dimension │ dynamic │ CSG │
334 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
335 │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean │ True │ C │
336 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
337 │XmNmappedWhenManaged │ XmCMappedWhenManaged │ Boolean │ True │ CSG │
338 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
339 │XmNscreen │ XmCScreen │ Screen * │ dynamic │ CG │
340 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
341 │XmNsensitive │ XmCSensitive │ Boolean │ True │ CSG │
342 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
343 │XmNtranslations │ XmCTranslations │ XtTranslations │ dynamic │ CSG │
344 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
345 │XmNwidth │ XmCWidth │ Dimension │ dynamic │ CSG │
346 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
347 │XmNx │ XmCPosition │ Position │ 0 │ CSG │
348 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
349 │XmNy │ XmCPosition │ Position │ 0 │ CSG │
350 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
351 └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
352 Translations
353 There are no translations for WMShell.
354
356 Composite(3), Core(3), and Shell(3).
357 WMShell(library call)