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