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