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