4
>Root Window Properties (+Related Messages)</TITLE
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.72
10
HREF="index.html"><LINK
12
TITLE="Non-ICCCM features"
15
TITLE="Other Root Window Messages"
16
HREF="x208.html"></HEAD
27
SUMMARY="Header navigation table"
73
>3. Root Window Properties (+Related Messages)</A
76
>Whenever this spec speaks about <SPAN
78
>"sending a message to the root
80
>, it is understood that the client is supposed to create
81
a ClientMessage event with the specified contents and send it by using
82
a SendEvent request with the following arguments:
84
CLASS="PROGRAMLISTING"
87
event-mask (SubstructureNotify|SubstructureRedirect)
88
event the specified ClientMessage</PRE
97
>3.1. _NET_SUPPORTED</A
100
CLASS="PROGRAMLISTING"
101
>_NET_SUPPORTED, ATOM[]/32</PRE
103
>This property MUST be set by the Window Manager to indicate which hints it
104
supports. For example: considering _NET_WM_STATE
105
both this atom and all supported states e.g. _NET_WM_STATE_MODAL,
106
_NET_WM_STATE_STICKY, would be listed. This assumes that backwards
107
incompatible changes will not be made to the hints (without being renamed).
116
>3.2. _NET_CLIENT_LIST</A
119
CLASS="PROGRAMLISTING"
120
>_NET_CLIENT_LIST, WINDOW[]/32
121
_NET_CLIENT_LIST_STACKING, WINDOW[]/32</PRE
123
>These arrays contain all X Windows managed by the Window Manager.
124
_NET_CLIENT_LIST has initial mapping order, starting with the oldest window.
125
_NET_CLIENT_LIST_STACKING has bottom-to-top stacking order. These properties
126
SHOULD be set and updated by the Window Manager.
135
>3.3. _NET_NUMBER_OF_DESKTOPS</A
138
CLASS="PROGRAMLISTING"
139
>_NET_NUMBER_OF_DESKTOPS, CARDINAL/32</PRE
141
>This property SHOULD be set and updated by the Window Manager to indicate the
142
number of virtual desktops.
145
>A Pager can request change in the desktops number by sending a _NET_NUMBER_OF_DESKTOPS message to the root window:
148
CLASS="PROGRAMLISTING"
149
>_NET_NUMBER_OF_DESKTOPS
150
message_type = _NET_NUMBER_OF_DESKTOPS
152
data.l[0] = new_number_of_desktops</PRE
154
>The Window Manager is free to honor or reject this request. If request is honored _NET_NUMBER_OF_DESKTOPS MUST be set to the new number of desktops, _NET_VIRTUAL_ROOTS MUST be set to store the new number of desktop virtual root window IDs and _NET_DESKTOP_VIEWPORT and _NET_WORKAREA must also be changed accordingly. The _NET_DESKTOP_NAMES property MAY remain unchanged.
158
If the number of desktops is shrinking and _NET_CURRENT_DESKTOP is out of the new range of available desktops, then this MUST be set to the last available desktop from the new set. If number of desktops is shrinking then clients that are still present on desktops, that are out of the new range, MUST be moved to the very last desktop from the new set. For these _NET_WM_DESKTOP MUST be updated.
167
>3.4. _NET_DESKTOP_GEOMETRY</A
170
CLASS="PROGRAMLISTING"
171
>_NET_DESKTOP_GEOMETRY width, height, CARDINAL[2]/32</PRE
173
>Array of two cardinals that defines the common size of all desktops.
174
This property SHOULD be set by the Window Manager.
177
>A Pager can request a change in the desktop geometry by sending a _NET_DESKTOP_GEOMETRY client
178
message to the root window:
181
CLASS="PROGRAMLISTING"
182
>_NET_DESKTOP_GEOMETRY
183
message_type = _NET_DESKTOP_GEOMETRY
185
data.l[0] = new_width
186
data.l[1] = new_height</PRE
188
>The Window Manager MAY choose to ignore this message, in which case _NET_DESKTOP_GEOMETRY property will remain unchanged.
197
>3.5. _NET_DESKTOP_VIEWPORT</A
200
CLASS="PROGRAMLISTING"
201
>_NET_DESKTOP_VIEWPORT x, y, CARDINAL[][2]/32</PRE
203
>Array of pairs of cardinals that define the top left corner of each desktops
204
viewport. For Window Managers that don't support large desktops, this MUST
205
always be set to (0,0).
208
>A Pager can request to change the viewport for the current desktop by sending a
209
_NET_DESKTOP_VIEWPORT client message to the root window:
212
CLASS="PROGRAMLISTING"
213
>_NET_DESKTOP_VIEWPORT
214
message_type = _NET_DESKTOP_VIEWPORT
217
data.l[1] = new_vy</PRE
219
>The Window Manager MAY choose to ignore this message, in which case _NET_DESKTOP_VIEWPORT property will remain unchanged.
228
>3.6. _NET_CURRENT_DESKTOP</A
231
CLASS="PROGRAMLISTING"
232
>_NET_CURRENT_DESKTOP desktop, CARDINAL/32</PRE
234
>The index of the current desktop. This is always an integer between 0 and
235
_NET_NUMBER_OF_DESKTOPS - 1. This MUST be set and updated by the Window
236
Manager If a Pager wants to switch to another virtual desktop, it MUST send
237
a _NET_CURRENT_DESKTOP client message to the root window:
240
CLASS="PROGRAMLISTING"
241
>_NET_CURRENT_DESKTOP
242
message_type = _NET_CURRENT_DESKTOP
244
data.l[0] = new_index</PRE
252
>3.7. _NET_DESKTOP_NAMES</A
255
CLASS="PROGRAMLISTING"
256
>_NET_DESKTOP_NAMES, UTF8_STRING[]</PRE
258
>The names of all virtual desktops. This is a list of NULL-terminated strings in UTF-8 [1] encoding. This property MAY be changed by a Pager or the Window Manager at any time.
261
>Note: The number of names could be different from _NET_NUMBER_OF_DESKTOPS.
262
If it is less than _NET_NUMBER_OF_DESKTOPS - then the desktops with high
263
numbers are unnamed. If it is larger than _NET_NUMBER_OF_DESKTOPS, then the
264
excess names outside of the _NET_NUMBER_OF_DESKTOPS are considered to be
265
reserved in case number of desktops is increased.</P
267
>Rationale: The name is not a necessary attribute of a virtual desktop. Thus
268
the availability or unavailability of names has no impact on virtual desktop
269
functionality. Since names are set by users and users are likely to preset
270
names for a fixed number of desktops, it doesn't make sense to shrink or grow
271
this list when the number of available desktops changes.</P
279
>3.8. _NET_ACTIVE_WINDOW</A
282
CLASS="PROGRAMLISTING"
283
>_NET_ACTIVE_WINDOW, WINDOW/32</PRE
285
>The window ID of the currently active window or None if no window has the focus.
286
This is a read-only property set by the
287
Window Manager. If a client (for example, a taskbar) wants to activate
288
another window, it MUST send a _NET_ACTIVE_WINDOW client message to the root
292
CLASS="PROGRAMLISTING"
294
window = window to activate
295
message_type = _NET_ACTIVE_WINDOW
297
data.l[0] = 0 /* may be used later */</PRE
305
>3.9. _NET_WORKAREA</A
308
CLASS="PROGRAMLISTING"
309
>_NET_WORKAREA, x, y, width, height CARDINAL[][4]/32
312
>This property MUST be set by WM upon calculating the work area for
313
each desktop. Contains a geometry for each desktop. These geometries are
314
specified relative to the viewport on each desktop and specify an area that is
315
completely contained within the viewport.
316
Work area SHOULD be used by desktop applications to place desktop icons appropriately.
319
> The Window Manager SHOULD calculate this space by taking the current page minus space occupied by dock and panel windows, as indicated by the <A
320
HREF="x225.html#NETWMSTRUT"
322
> property set on client windows.
331
>3.10. _NET_SUPPORTING_WM_CHECK</A
334
CLASS="PROGRAMLISTING"
335
>_NET_SUPPORTING_WM_CHECK, WINDOW/32</PRE
337
>The Window Manager MUST set this property on the root window to be the ID of a
338
child window created by the WM, to indicate that a compliant WM is
339
active. The child window MUST also have the _NET_SUPPORTING_WM_CHECK
340
property set to the ID of the child window. The child window MUST also
341
have the _NET_WM_NAME property set to the name of the Window Manager.
344
>Rationale: The child window is used to distinguish an active Window Manager
345
from a stale _NET_SUPPORTING_WM_CHECK
346
property that happens to point to another window. If the
347
_NET_SUPPORTING_WM_CHECK window on the client window is missing
348
or not properly set, clients SHOULD assume that no conforming
349
Window Manager is present.
358
>3.11. _NET_VIRTUAL_ROOTS</A
361
CLASS="PROGRAMLISTING"
362
>_NET_VIRTUAL_ROOTS, WINDOW[]/32</PRE
364
>To implement virtual desktops, some window managers reparent client windows to
365
a child of the root window. Window managers using this technique MUST set
366
this property to a list of IDs for windows that are acting as virtual root
367
windows. This property allows background setting programs to work with
368
virtual roots and allows clients to figure out the WM frame windows of their
378
>3.12. _NET_DESKTOP_LAYOUT</A
381
CLASS="PROGRAMLISTING"
382
>_NET_DESKTOP_LAYOUT, orientation, x, y, starting_corner CARDINAL[4]/32
383
#define _NET_WM_ORIENTATION_HORZ 0
384
#define _NET_WM_ORIENTATION_VERT 1
386
#define _NET_WM_TOPLEFT 0
387
#define _NET_WM_TOPRIGHT 1
388
#define _NET_WM_BOTTOMRIGHT 2
389
#define _NET_WM_BOTTOMLEFT 3</PRE
395
>This property is set by a Pager, not by the Window
399
When setting this property, the Pager must own a manager selection (as
400
defined in the ICCCM 2.8). The manager selection is called
403
>_NET_DESKTOP_LAYOUT_Sn</TT
408
> is the screen number. The purpose of
409
this property is to allow the Window Manager to know the desktop
410
layout displayed by the Pager.
415
>_NET_DESKTOP_LAYOUT</TT
416
> describes the layout of virtual
417
desktops relative to each other. More specifically, it describes the layout
418
used by the owner of the manager selection. The Window Manager may use
419
this layout information or may choose to ignore it.
420
The property contains four values: the Pager orientation, the number of
421
desktops in the X direction, the number in the Y direction, and the
422
starting corner of the Pager.
425
> Note: In order to interoperate with Pagers implementing an earlier
426
draft of this document, Window Managers should accept a
429
>_NET_DESKTOP_LAYOUT</TT
430
> property of length 3 and
434
> as the starting corner in this case.
437
> The virtual desktops are arranged in a rectangle
438
with X rows and Y columns. If X times Y does not match the total number of
439
desktops as specified by
442
>_NET_NUMBER_OF_DESKTOPS</TT
443
>, the highest-numbered
444
workspaces are assumed to be nonexistent. Either X or Y (but not
445
both) may be specified as 0 in which case its actual value will be
448
>_NET_NUMBER_OF_DESKTOPS</TT
452
> When the orientation is <TT
454
>_NET_WM_ORIENTATION_HORZ</TT
456
the desktops are layed out in rows, with the first desktop in the
457
specified starting corner. So a layout with X=4 and Y=3 starting in
461
> corner looks like this:
463
CLASS="PROGRAMLISTING"
472
With starting_corner <TT
474
>_NET_WM_BOTTOMRIGHT</TT
478
CLASS="PROGRAMLISTING"
490
> When the orientation is <TT
492
>_NET_WM_ORIENTATION_VERT</TT
494
the layout for X=4 and Y=3 starting in the <TT
501
CLASS="PROGRAMLISTING"
510
With starting_corner <TT
512
>_NET_WM_TOPRIGHT</TT
516
CLASS="PROGRAMLISTING"
527
> The numbers here are the desktop numbers, as for
530
>_NET_CURRENT_DESKTOP</TT
540
>3.13. _NET_SHOWING_DESKTOP</A
543
CLASS="PROGRAMLISTING"
544
>_NET_SHOWING_DESKTOP desktop, CARDINAL/32</PRE
546
> Some Window Managers have a "showing the desktop" mode in which windows
547
are hidden, and the desktop background is displayed and focused. If a
548
Window Manager supports the _NET_SHOWING_DESKTOP hint, it MUST set it
549
to a value of 1 if the Window Manager is in "showing the desktop" mode,
550
and a value of zero if the Window Manager is not in this mode.
553
> If a Pager wants to enter or leave the mode, it MUST
554
send a _NET_SHOWING_DESKTOP client message to the root window
555
requesting the change:
557
CLASS="PROGRAMLISTING"
558
>_NET_SHOWING_DESKTOP
559
message_type = _NET_SHOWING_DESKTOP
561
data.l[0] = boolean 0 or 1</PRE
563
The Window Manager may choose to ignore this client message.
572
SUMMARY="Footer navigation table"
611
>Non-ICCCM features</TD
621
>Other Root Window Messages</TD
b'\\ No newline at end of file'