make it possible to temporarily raise a window to the top, and restore it. also...
[mikachu/openbox.git] / openbox / client.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    client.h for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #ifndef __client_h
21 #define __client_h
22
23 #include "misc.h"
24 #include "mwm.h"
25 #include "geom.h"
26 #include "stacking.h"
27 #include "window.h"
28 #include "render/color.h"
29
30 #include <glib.h>
31 #include <X11/Xlib.h>
32
33 struct _ObFrame;
34 struct _ObGroup;
35 struct _ObSessionState;
36
37 typedef struct _ObClient      ObClient;
38 typedef struct _ObClientIcon  ObClientIcon;
39
40 /*! Holds an icon in ARGB format */
41 struct _ObClientIcon
42 {
43     gint width;
44     gint height;
45     RrPixel32 *data;
46 };
47
48 /*! Possible window types */
49 typedef enum
50 {
51     OB_CLIENT_TYPE_DESKTOP, /*!< A desktop (bottom-most window) */
52     OB_CLIENT_TYPE_DOCK,    /*!< A dock bar/panel window */
53     OB_CLIENT_TYPE_TOOLBAR, /*!< A toolbar window, pulled off an app */
54     OB_CLIENT_TYPE_MENU,    /*!< An unpinned menu from an app */
55     OB_CLIENT_TYPE_UTILITY, /*!< A small utility window such as a palette */
56     OB_CLIENT_TYPE_SPLASH,  /*!< A splash screen window */
57     OB_CLIENT_TYPE_DIALOG,  /*!< A dialog window */
58     OB_CLIENT_TYPE_NORMAL   /*!< A normal application window */
59 } ObClientType;
60
61 /*! The things the user can do to the client window */
62 typedef enum
63 {
64     OB_CLIENT_FUNC_RESIZE     = 1 << 0, /*!< Allow user resizing */
65     OB_CLIENT_FUNC_MOVE       = 1 << 1, /*!< Allow user moving */
66     OB_CLIENT_FUNC_ICONIFY    = 1 << 2, /*!< Allow to be iconified */
67     OB_CLIENT_FUNC_MAXIMIZE   = 1 << 3, /*!< Allow to be maximized */
68     OB_CLIENT_FUNC_SHADE      = 1 << 4, /*!< Allow to be shaded */
69     OB_CLIENT_FUNC_FULLSCREEN = 1 << 5, /*!< Allow to be made fullscreen */
70     OB_CLIENT_FUNC_CLOSE      = 1 << 6, /*!< Allow to be closed */
71     OB_CLIENT_FUNC_ABOVE      = 1 << 7, /*!< Allow to be put in lower layer */
72     OB_CLIENT_FUNC_BELOW      = 1 << 8, /*!< Allow to be put in higher layer */
73     OB_CLIENT_FUNC_UNDECORATE = 1 << 9  /*!< Allow to be undecorated */
74 } ObFunctions;
75
76 struct _ObClient
77 {
78     ObWindow obwin;
79     Window  window;
80
81     /*! The window's decorations. NULL while the window is being managed! */
82     struct _ObFrame *frame;
83
84     /*! The number of unmap events to ignore on the window */
85     gint ignore_unmaps;
86
87     /*! The id of the group the window belongs to */
88     struct _ObGroup *group;
89
90     /*! Saved session data to apply to this client */
91     struct _ObSessionState *session;
92
93     /*! Whether or not the client is a transient window. It may or may not
94       have parents when this is true. */
95     gboolean transient;
96     /*! Whether or not the client is transient for its group */
97     gboolean transient_for_group;
98     /*! The client which are parents of this client */
99     GSList *parents;
100     /*! The clients which are transients (children) of this client */
101     GSList *transients;
102     /*! The desktop on which the window resides (0xffffffff for all
103       desktops) */
104     guint desktop;
105
106     /*! The startup id for the startup-notification protocol. This will be
107       NULL if a startup id is not set. */
108     gchar *startup_id;
109
110     /*! Normal window title */
111     gchar *title;
112     /*! Window title when iconified */
113     gchar *icon_title;
114     /*! Hostname of machine running the client */
115     gchar *client_machine;
116     /*! The command used to run the program. Pre-XSMP window identification. */
117     gchar *wm_command;
118
119     /*! The application that created the window */
120     gchar *name;
121     /*! The class of the window, can used for grouping */
122     gchar *class;
123     /*! The specified role of the window, used for identification */
124     gchar *role;
125     /*! The session client id for the window. *This can be NULL!* */
126     gchar *sm_client_id;
127
128     /*! The type of window (what its function is) */
129     ObClientType type;
130
131     /*! Position and size of the window
132       This will not always be the actual position of the window on screen, it
133       is, rather, the position requested by the client, to which the window's
134       gravity is applied.
135     */
136     Rect area;
137
138     /*! Position of the client window relative to the root window */
139     Point root_pos;
140
141     /*! Position and size of the window prior to being maximized */
142     Rect pre_max_area;
143     /*! Position and size of the window prior to being fullscreened */
144     Rect pre_fullscreen_area;
145
146     /*! The window's strut
147       The strut defines areas of the screen that are marked off-bounds for
148       window placement. In theory, where this window exists.
149     */
150     StrutPartial strut;
151
152     /*! The logical size of the window
153       The "logical" size of the window is refers to the user's perception of
154       the size of the window, and is the value that should be displayed to the
155       user. For example, with xterms, this value it the number of characters
156       being displayed in the terminal, instead of the number of pixels.
157     */
158     Size logical_size;
159
160     /*! Width of the border on the window.
161       The window manager will set this to 0 while the window is being managed,
162       but needs to restore it afterwards, so it is saved here.
163     */
164     gint border_width;
165
166     /*! The minimum aspect ratio the client window can be sized to.
167       A value of 0 means this is ignored.
168     */
169     gfloat min_ratio;
170     /*! The maximum aspect ratio the client window can be sized to.
171       A value of 0 means this is ignored.
172     */
173     gfloat max_ratio;
174
175     /*! The minimum size of the client window
176       If the min is > the max, then the window is not resizable
177     */
178     Size min_size;
179     /*! The maximum size of the client window
180       If the min is > the max, then the window is not resizable
181     */
182     Size max_size;
183     /*! The size of increments to resize the client window by */
184     Size size_inc;
185     /*! The base size of the client window
186       This value should be subtracted from the window's actual size when
187       displaying its size to the user, or working with its min/max size
188     */
189     Size base_size;
190
191     /*! Window decoration and functionality hints */
192     ObMwmHints mwmhints;
193
194     /*! The client's specified colormap */
195     Colormap colormap;
196
197     /*! Where to place the decorated window in relation to the undecorated
198       window */
199     gint gravity;
200
201     /*! The state of the window, one of WithdrawnState, IconicState, or
202       NormalState */
203     glong wmstate;
204
205     /*! True if the client supports the delete_window protocol */
206     gboolean delete_window;
207
208     /*! Was the window's position requested by the application or the user?
209       if by the application, we force it completely onscreen, if by the user
210       we only force it if it tries to go completely offscreen, if neither, we
211       should place the window ourselves when it first appears */
212     guint positioned;
213
214     /*! Was the window's size requested by the application or the user?
215       If by the application we don't let it go outside the available area */
216     guint sized;
217
218     /*! Can the window receive input focus? */
219     gboolean can_focus;
220     /*! Notify the window when it receives focus? */
221     gboolean focus_notify;
222
223 #ifdef SYNC
224     /*! The client wants to sync during resizes */
225     gboolean sync_request;
226     /*! The XSync counter used for synchronizing during resizes */
227     guint32 sync_counter;
228     /*! The value we're waiting for the counter to reach */
229     gulong sync_counter_value;
230 #endif
231
232     /*! The window uses shape extension to be non-rectangular? */
233     gboolean shaped;
234
235     /*! The window is modal, so it must be processed before any windows it is
236       related to can be focused */
237     gboolean modal;
238     /*! Only the window's titlebar is displayed */
239     gboolean shaded;
240     /*! The window is iconified */
241     gboolean iconic;
242     /*! The window is maximized to fill the screen vertically */
243     gboolean max_vert;
244     /*! The window is maximized to fill the screen horizontally */
245     gboolean max_horz;
246     /*! The window should not be displayed by pagers */
247     gboolean skip_pager;
248     /*! The window should not be displayed by taskbars */
249     gboolean skip_taskbar;
250     /*! The window is a 'fullscreen' window, and should be on top of all
251       others */
252     gboolean fullscreen;
253     /*! The window should be on top of other windows of the same type.
254       above takes priority over below. */
255     gboolean above;
256     /*! The window should be underneath other windows of the same type.
257       above takes priority over below. */
258     gboolean below;
259     /*! Demands attention flag */
260     gboolean demands_attention;
261
262     /*! The urgent flag */
263     gboolean urgent;
264
265     /*! The layer in which the window will be stacked, windows in lower layers
266       are always below windows in higher layers. */
267     ObStackingLayer layer;
268
269     /*! A bitmask of values in the ObFrameDecorations enum
270       The values in the variable are the decorations that the client wants to
271       be displayed around it.
272     */
273     guint decorations;
274
275     /*! A user option. When this is set to TRUE the client will not ever
276       be decorated.
277     */
278     gboolean undecorated;
279
280     /*! A bitmask of values in the ObFunctions enum
281       The values in the variable specify the ways in which the user is allowed
282       to modify this window.
283     */
284     guint functions;
285
286     /*! Icons for the client as specified on the client window */
287     ObClientIcon *icons;
288     /*! The number of icons in icons */
289     guint nicons;
290
291     /*! Where the window should iconify to/from */
292     Rect icon_geometry;
293 };
294
295 extern GList      *client_list;
296
297 void client_startup(gboolean reconfig);
298 void client_shutdown(gboolean reconfig);
299
300 typedef void (*ObClientCallback)(ObClient *client, gpointer data);
301
302 /* Callback functions */
303
304 /*! Get notified when the client is unmanaged */
305 void client_add_destroy_notify(ObClientCallback func, gpointer data);
306 void client_remove_destroy_notify(ObClientCallback func);
307
308 /*! Manages all existing windows */
309 void client_manage_all();
310 /*! Manages a given window
311 */
312 void client_manage(Window win);
313 /*! Unmanages all managed windows */
314 void client_unmanage_all();
315 /*! Unmanages a given client */
316 void client_unmanage(ObClient *client);
317
318 /*! This manages a window only so far as is needed to get it's decorations.
319    This is used when you want to determine a window's decorations before it
320    is mapped. Call client_fake_unmanage() with the returned client when you
321    are done with it. */
322 ObClient *client_fake_manage(Window win);
323 /*! Free the stuff created by client_fake_manage() */
324 void client_fake_unmanage(ObClient *self);
325
326 /*! Sets the client list on the root window from the client_list */
327 void client_set_list();
328
329 /*! Determines if the client should be shown or hidden currently.
330   @return TRUE if it should be visible; otherwise, FALSE.
331 */
332 gboolean client_should_show(ObClient *self);
333
334 /*! Returns if the window should be treated as a normal window.
335   Some windows (desktops, docks, splash screens) have special rules applied
336   to them in a number of places regarding focus or user interaction. */
337 gboolean client_normal(ObClient *self);
338
339 /*! Returns if the window is one of an application's helper windows
340   (utilty, menu, etc) */
341 gboolean client_helper(ObClient *self);
342
343 /*! Return if the client is a type which should be given focus from mouse
344   presses on the *client* window. This doesn't affect clicking on the
345   decorations. This doesn't count for focus cycling, different rules apply to
346   that. */
347 gboolean client_mouse_focusable(ObClient *self);
348
349 /*! Return if the client is a type which should be given focus from the
350   mouse entering the window. This doesn't count for focus cycling, different
351   rules apply to that. */
352 gboolean client_enter_focusable(ObClient *self);
353
354 /* Returns if the window is focused */
355 gboolean client_focused(ObClient *self);
356
357 /*! When the client is resized but not moved, figure out the new position
358   for it based on its gravity:
359   http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
360 */
361 void client_gravity_resize_w(ObClient *self, gint *x, gint oldw, gint neww);
362
363 /*! When the client is resized but not moved, figure out the new position
364   for it based on its gravity:
365   http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
366 */
367 void client_gravity_resize_h(ObClient *self, gint *y, gint oldh, gint newh);
368
369 /*! Convert a position/size from a given gravity to the client's true gravity,
370   when the client is only resizing (the reference point doesn't move)
371  */
372 void client_convert_gravity_resize(ObClient *self, gint gravity,
373                                    gint *x, gint *y,
374                                    gint w, gint h);
375
376 #define client_move(self, x, y) \
377   client_configure(self, x, y, self->area.width, self->area.height, TRUE, TRUE,\
378                    FALSE)
379 #define client_resize(self, w, h) \
380   client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE, FALSE)
381 #define client_move_resize(self, x, y, w, h) \
382   client_configure(self, x, y, w, h, TRUE, TRUE, FALSE)
383 #define client_reconfigure(self, force) \
384   client_configure(self, ((ObClient*)self)->area.x, ((ObClient*)self)->area.y, \
385                    ((ObClient*)self)->area.width, \
386                    ((ObClient*)self)->area.height, FALSE, TRUE, force)
387
388 /*! Figure out where a window will end up and what size it will be if you
389   told it to move/resize to these coordinates.
390
391   These values are what client_configure will give the window.
392
393   @param x The x coordiante of the new position for the client.
394   @param y The y coordiante of the new position for the client.
395   @param w The width component of the new size for the client.
396   @param h The height component of the new size for the client.
397   @param logicalw Returns the width component of the new logical width.
398                   This value is only returned when the new w or h calculated
399                   differ from the ones passed in.
400   @param logicalh Returns the height component of the new logical height.
401                   This value is only returned when the new w or h calculated
402                   differ from the ones passed in.
403   @param user Specifies whether this is a user-requested change or a
404               program requested change. For program requested changes, the
405               constraints are not checked.
406 */
407 void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
408                           gint *logicalw, gint *logicalh,
409                           gboolean user);
410
411 /*! Move and/or resize the window.
412   This also maintains things like the client's minsize, and size increments.
413   @param x The x coordiante of the new position for the client.
414   @param y The y coordiante of the new position for the client.
415   @param w The width component of the new size for the client.
416   @param h The height component of the new size for the client.
417   @param user Specifies whether this is a user-requested change or a
418               program requested change. For program requested changes, the
419               constraints are not checked.
420   @param final If user is true, then this should specify if this is a final
421                configuration. e.g. Final should be FALSE if doing an
422                interactive move/resize, and then be TRUE for the last call
423                only.
424   @param force_reply Send a ConfigureNotify to the client regardless of if
425                      the position/size changed.
426 */
427 void client_configure(ObClient *self, gint x, gint y, gint w, gint h,
428                       gboolean user, gboolean final, gboolean force_reply);
429
430 /*! Finds coordinates to keep a client on the screen.
431   @param self The client
432   @param x The x coord of the client, may be changed.
433   @param y The y coord of the client, may be changed.
434   @param w The width of the client.
435   @param w The height of the client.
436   @param rude Be rude about it. If false, it is only moved if it is entirely
437               not visible. If true, then make sure the window is inside the
438               struts if possible.
439   @return true if the client was moved to be on-screen; false if not.
440 */
441 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
442                               gboolean rude);
443
444 /*! Moves a client so that it is on screen if it is entirely out of the
445   viewable screen.
446   @param self The client to move
447   @param rude Be rude about it. If false, it is only moved if it is entirely
448               not visible. If true, then make sure the window is inside the
449               struts if possible.
450 */
451 void client_move_onscreen(ObClient *self, gboolean rude);
452
453 /*! dir is either North, South, East or West. It can't be, for example,
454   Northwest */
455 void client_find_edge_directional(ObClient *self, ObDirection dir,
456                                   gint my_head, gint my_tail,
457                                   gint my_edge_start, gint my_edge_size,
458                                   gint *dest, gboolean *near_edge);
459 void client_find_move_directional(ObClient *self, ObDirection dir,
460                                   gint *x, gint *y);
461 void client_find_resize_directional(ObClient *self, ObDirection side,
462                                     gboolean grow,
463                                     gint *x, gint *y, gint *w, gint *h);
464
465 /*! Fullscreen's or unfullscreen's the client window
466   @param fs true if the window should be made fullscreen; false if it should
467             be returned to normal state.
468 */
469 void client_fullscreen(ObClient *self, gboolean fs);
470
471 /*! Iconifies or uniconifies the client window
472   @param iconic true if the window should be iconified; false if it should be
473                 restored.
474   @param curdesk If iconic is FALSE, then this determines if the window will
475                  be uniconified to the current viewable desktop (true) or to
476                  its previous desktop (false)
477 */
478 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk,
479                     gboolean hide_animation);
480
481 /*! Maximize or unmaximize the client window
482   @param max true if the window should be maximized; false if it should be
483              returned to normal size.
484   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
485 */
486 void client_maximize(ObClient *self, gboolean max, gint dir);
487
488 /*! Shades or unshades the client window
489   @param shade true if the window should be shaded; false if it should be
490                unshaded.
491 */
492 void client_shade(ObClient *self, gboolean shade);
493
494 /*! Set a client window to have decorations or not */
495 void client_set_undecorated(ObClient *self, gboolean undecorated);
496
497 /*! Hilite the window to make the user notice it */
498 void client_hilite(ObClient *self, gboolean hilite);
499
500 /*! Request the client to close its window */
501 void client_close(ObClient *self);
502
503 /*! Kill the client off violently */
504 void client_kill(ObClient *self);
505
506 /*! Sends the window to the specified desktop
507   @param donthide If TRUE, the window will not be shown/hidden after its
508                   desktop has been changed. Generally this should be FALSE.
509   @param dontraise If TRUE, the window will not be raised. Generally this should
510                    be FALSE.
511 */
512 void client_set_desktop(ObClient *self, guint target, gboolean donthide,
513                         gboolean dontraise);
514
515 /*! Show the client if it should be shown. Returns if the window is shown. */
516 gboolean client_show(ObClient *self);
517
518 /*! Show the client if it should be shown. Returns if the window is hidden. */
519 gboolean client_hide(ObClient *self);
520
521 /*! Show the client if it should be shown, and hide it if it should be
522   hidden. This is for example, when switching desktops.
523 */
524 void client_showhide(ObClient *self);
525
526 /*! Validate client, by making sure no Destroy or Unmap events exist in
527   the event queue for the window.
528   @return true if the client is valid; false if the client has already
529           been unmapped/destroyed, and so is invalid.
530 */
531 gboolean client_validate(ObClient *self);
532
533 /*! Sets the wm_state to the specified value */
534 void client_set_wm_state(ObClient *self, glong state);
535
536 /*! Adjusts the window's net_state
537   This should not be called as part of the window mapping process! It is for
538   use when updating the state post-mapping.<br>
539   client_apply_startup_state is used to do the same things during the mapping
540   process.
541 */
542 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
543
544 /* Given a ObClient, find the client that focus would actually be sent to if
545    you wanted to give focus to the specified ObClient. Will return the same
546    ObClient passed to it or another ObClient if appropriate. */
547 ObClient *client_focus_target(ObClient *self);
548
549 /*! Returns what client_focus would return if passed the same client, but
550   without focusing it or modifying the focus order lists. */
551 gboolean client_can_focus(ObClient *self);
552
553 /*! Attempt to focus the client window */
554 gboolean client_focus(ObClient *self);
555
556 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
557   when the user deliberately selects a window for use.
558   @param here If true, then the client is brought to the current desktop;
559               otherwise, the desktop is changed to where the client lives.
560   @param raise If true, the client is brought to the front.
561   @param unshade If true, the client is unshaded (if it is shaded)
562   @param user If true, then a user action is what requested the activation;
563               otherwise, it means an application requested it on its own
564 */
565 void client_activate(ObClient *self, gboolean here, gboolean raise,
566                      gboolean unshade, gboolean user);
567
568 /*! Bring all of its helper windows to its desktop. These are the utility and
569   stuff windows. */
570 void client_bring_helper_windows(ObClient *self);
571
572 /*! Bring all of its modal windows to its desktop. */
573 void client_bring_modal_windows(ObClient *self);
574
575 /*! Calculates the stacking layer for the client window */
576 void client_calc_layer(ObClient *self);
577
578 /*! Updates the window's transient status, and any parents of it */
579 void client_update_transient_for(ObClient *self);
580 /*! Update the protocols that the window supports and adjusts things if they
581   change */
582 void client_update_protocols(ObClient *self);
583 #ifdef SYNC
584 /*! Updates the window's sync request counter for resizes */
585 void client_update_sync_request_counter(ObClient *self);
586 #endif
587 /*! Updates the window's colormap */
588 void client_update_colormap(ObClient *self, Colormap colormap);
589 /*! Updates the WMNormalHints and adjusts things if they change */
590 void client_update_normal_hints(ObClient *self);
591
592 /*! Updates the WMHints and adjusts things if they change
593   @param initstate Whether to read the initial_state property from the
594                    WMHints. This should only be used during the mapping
595                    process.
596 */
597 void client_update_wmhints(ObClient *self);
598 /*! Updates the window's title and icon title */
599 void client_update_title(ObClient *self);
600 /*! Updates the strut for the client */
601 void client_update_strut(ObClient *self);
602 /*! Updates the window's icons */
603 void client_update_icons(ObClient *self);
604 /*! Updates the window's icon geometry (where to iconify to/from) */
605 void client_update_icon_geometry(ObClient *self);
606
607 /*! Set up what decor should be shown on the window and what functions should
608   be allowed (ObClient::decorations and ObClient::functions).
609   This also updates the NET_WM_ALLOWED_ACTIONS hint.
610   @param reconfig When TRUE, the window will be reconfigured to show the
611          changes
612 */
613 void client_setup_decor_and_functions(ObClient *self, gboolean reconfig);
614
615 /*! Sets the window's type and transient flag */
616 void client_get_type_and_transientness(ObClient *self);
617
618 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
619
620 /*! Return TRUE if the client is transient for some other window. Return
621   FALSE if it's not transient or there is no window for it to be
622   transient for */
623 gboolean client_has_parent(ObClient *self);
624
625 /*! Searches a client's direct parents for a focused window. The function does
626   not check for the passed client, only for *ONE LEVEL* of its parents.
627   If no focused parentt is found, NULL is returned.
628 */
629 ObClient *client_search_focus_parent(ObClient *self);
630
631 /*! Searches a client's transients for a focused window. The function does not
632   check for the passed client, only for its transients.
633   If no focused transient is found, NULL is returned.
634 */
635 ObClient *client_search_focus_tree(ObClient *self);
636
637 /*! Searches a client's transient tree for a focused window. The function
638   searches up the tree and down other branches as well as the passed client's.
639   If no focused client is found, NULL is returned.
640 */
641 ObClient *client_search_focus_tree_full(ObClient *self);
642
643 /*! Searches a client's group and each member's transients for a focused
644   window.  This doesn't go up the window's transient tree at all. If no
645   focused client is found, NULL is returned. */
646 ObClient *client_search_focus_group_full(ObClient *self);
647
648 /*! Return a modal child of the client window that can be focused.
649     @return A modal child of the client window that can be focused, or 0 if
650             none was found.
651 */
652 ObClient *client_search_modal_child(ObClient *self);
653
654 /*! Returns a list of top-level windows which this is a transient for.
655   It will only contain more than 1 element if the client is transient for its
656   group.
657 */
658 GSList *client_search_all_top_parents(ObClient *self);
659
660 /*! Returns a list of top-level windows which this is a transient for, and
661   which are in the same layer as this client.
662   It will only contain more than 1 element if the client is transient for its
663   group.
664 */
665 GSList *client_search_all_top_parents_layer(ObClient *self);
666
667 /*! Returns the client's parent when it is transient for a direct window
668   rather than a group. If it has no parents, or is transient for the
669   group, this returns null */
670 ObClient *client_direct_parent(ObClient *self);
671
672 /*! Returns a window's top level parent. This only counts direct parents,
673   not groups if it is transient for its group.
674 */
675 ObClient *client_search_top_direct_parent(ObClient *self);
676
677 /*! Is one client a direct child of another (i.e. not through the group.) */
678 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
679
680 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
681   returns the searched for parent if it is a parent, or NULL if not. */
682 ObClient *client_search_parent(ObClient *self, ObClient *search);
683
684 /*! Search for a transient of a client. The transient is returned if it is one,
685   NULL is returned if the given search is not a transient of the client. */
686 ObClient *client_search_transient(ObClient *self, ObClient *search);
687
688 /*! Set a client window to be above/below other clients.
689   @layer < 0 indicates the client should be placed below other clients.<br />
690          = 0 indicates the client should be placed with other clients.<br />
691          > 0 indicates the client should be placed above other clients.
692 */
693 void client_set_layer(ObClient *self, gint layer);
694
695 guint client_monitor(ObClient *self);
696
697 ObClient* client_under_pointer();
698
699 gboolean client_has_group_siblings(ObClient *self);
700
701 #endif