Don't need to explicitly check for xft.
[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 a given window
325   @param prompt This specifies an ObPrompt which is being managed.  It is
326                 possible to manage Openbox-owned windows through this.
327 */
328 void client_manage(Window win, struct _ObPrompt *prompt);
329 /*! Unmanages all managed windows */
330 void client_unmanage_all(void);
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(void);
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
400 /*! Make a client reconfigure so that it will honour its current max/min sizes
401   and other bounds.
402   @param force If TRUE, then a ConfigureNotify event will be sent to the client
403                even if nothing has changed.
404 */
405 void client_reconfigure(ObClient *self, gboolean force);
406
407 /*! Figure out where a window will end up and what size it will be if you
408   told it to move/resize to these coordinates.
409
410   These values are what client_configure will give the window.
411
412   @param x The x coordiante of the new position for the client.
413   @param y The y coordiante of the new position for the client.
414   @param w The width component of the new size for the client.
415   @param h The height component of the new size for the client.
416   @param logicalw Returns the width component of the new logical width.
417                   This value is only returned when the new w or h calculated
418                   differ from the ones passed in.
419   @param logicalh Returns the height component of the new logical height.
420                   This value is only returned when the new w or h calculated
421                   differ from the ones passed in.
422   @param user Specifies whether this is a user-requested change or a
423               program requested change. For program requested changes, the
424               constraints are not checked.
425 */
426 void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
427                           gint *logicalw, gint *logicalh,
428                           gboolean user);
429
430 /*! Move and/or resize the window.
431   This also maintains things like the client's minsize, and size increments.
432   @param x The x coordiante of the new position for the client.
433   @param y The y coordiante of the new position for the client.
434   @param w The width component of the new size for the client.
435   @param h The height component of the new size for the client.
436   @param user Specifies whether this is a user-requested change or a
437               program requested change. For program requested changes, the
438               constraints are not checked.
439   @param final If user is true, then this should specify if this is a final
440                configuration. e.g. Final should be FALSE if doing an
441                interactive move/resize, and then be TRUE for the last call
442                only.
443   @param force_reply Send a ConfigureNotify to the client regardless of if
444                      the position/size changed.
445 */
446 void client_configure(ObClient *self, gint x, gint y, gint w, gint h,
447                       gboolean user, gboolean final, gboolean force_reply);
448
449 /*! Finds coordinates to keep a client on the screen.
450   @param self The client
451   @param x The x coord of the client, may be changed.
452   @param y The y coord of the client, may be changed.
453   @param w The width of the client.
454   @param w The height of the client.
455   @param rude Be rude about it. If false, it is only moved if it is entirely
456               not visible. If true, then make sure the window is inside the
457               struts if possible.
458   @return true if the client was moved to be on-screen; false if not.
459 */
460 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
461                               gboolean rude);
462
463 /*! Moves a client so that it is on screen if it is entirely out of the
464   viewable screen.
465   @param self The client to move
466   @param rude Be rude about it. If false, it is only moved if it is entirely
467               not visible. If true, then make sure the window is inside the
468               struts if possible.
469 */
470 void client_move_onscreen(ObClient *self, gboolean rude);
471
472 /*! dir is either North, South, East or West. It can't be, for example,
473   Northwest */
474 void client_find_edge_directional(ObClient *self, ObDirection dir,
475                                   gint my_head, gint my_tail,
476                                   gint my_edge_start, gint my_edge_size,
477                                   gint *dest, gboolean *near_edge);
478 void client_find_move_directional(ObClient *self, ObDirection dir,
479                                   gint *x, gint *y);
480 void client_find_resize_directional(ObClient *self, ObDirection side,
481                                     gboolean grow,
482                                     gint *x, gint *y, gint *w, gint *h);
483
484 /*! Fullscreen's or unfullscreen's the client window
485   @param fs true if the window should be made fullscreen; false if it should
486             be returned to normal state.
487 */
488 void client_fullscreen(ObClient *self, gboolean fs);
489
490 /*! Iconifies or uniconifies the client window
491   @param iconic true if the window should be iconified; false if it should be
492                 restored.
493   @param curdesk If iconic is FALSE, then this determines if the window will
494                  be uniconified to the current viewable desktop (true) or to
495                  its previous desktop (false)
496 */
497 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk,
498                     gboolean hide_animation);
499
500 /*! Maximize or unmaximize the client window
501   @param max true if the window should be maximized; false if it should be
502              returned to normal size.
503   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
504 */
505 void client_maximize(ObClient *self, gboolean max, gint dir);
506
507 /*! Shades or unshades the client window
508   @param shade true if the window should be shaded; false if it should be
509                unshaded.
510 */
511 void client_shade(ObClient *self, gboolean shade);
512
513 /*! Set a client window to have decorations or not */
514 void client_set_undecorated(ObClient *self, gboolean undecorated);
515
516 /*! Hilite the window to make the user notice it */
517 void client_hilite(ObClient *self, gboolean hilite);
518
519 /*! Request the client to close its window */
520 void client_close(ObClient *self);
521
522 /*! Kill the client off violently */
523 void client_kill(ObClient *self);
524
525 /*! Sends the window to the specified desktop
526   @param donthide If TRUE, the window will not be shown/hidden after its
527                   desktop has been changed. Generally this should be FALSE.
528   @param dontraise If TRUE, the window will not be raised. Generally this should
529                    be FALSE.
530 */
531 void client_set_desktop(ObClient *self, guint target, gboolean donthide,
532                         gboolean dontraise);
533
534 /*! Show the client if it should be shown. Returns if the window is shown. */
535 gboolean client_show(ObClient *self);
536
537 /*! Show the client if it should be shown. Returns if the window is hidden. */
538 gboolean client_hide(ObClient *self);
539
540 /*! Show the client if it should be shown, and hide it if it should be
541   hidden. This is for example, when switching desktops.
542 */
543 void client_showhide(ObClient *self);
544
545 /*! Validate client, by making sure no Destroy or Unmap events exist in
546   the event queue for the window.
547   @return true if the client is valid; false if the client has already
548           been unmapped/destroyed, and so is invalid.
549 */
550 gboolean client_validate(ObClient *self);
551
552 /*! Sets the wm_state to the specified value */
553 void client_set_wm_state(ObClient *self, glong state);
554
555 /*! Adjusts the window's net_state
556   This should not be called as part of the window mapping process! It is for
557   use when updating the state post-mapping.<br>
558   client_apply_startup_state is used to do the same things during the mapping
559   process.
560 */
561 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
562
563 /* Given a ObClient, find the client that focus would actually be sent to if
564    you wanted to give focus to the specified ObClient. Will return the same
565    ObClient passed to it or another ObClient if appropriate. */
566 ObClient *client_focus_target(ObClient *self);
567
568 /*! Returns what client_focus would return if passed the same client, but
569   without focusing it or modifying the focus order lists. */
570 gboolean client_can_focus(ObClient *self);
571
572 /*! Attempt to focus the client window */
573 gboolean client_focus(ObClient *self);
574
575 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
576   when the user deliberately selects a window for use.
577   @param here If true, then the client is brought to the current desktop;
578               otherwise, the desktop is changed to where the client lives.
579   @param raise If true, the client is brought to the front.
580   @param unshade If true, the client is unshaded (if it is shaded)
581   @param user If true, then a user action is what requested the activation;
582               otherwise, it means an application requested it on its own
583 */
584 void client_activate(ObClient *self, gboolean here, gboolean raise,
585                      gboolean unshade, gboolean user);
586
587 /*! Bring all of its helper windows to its desktop. These are the utility and
588   stuff windows. */
589 void client_bring_helper_windows(ObClient *self);
590
591 /*! Bring all of its modal windows to its desktop. */
592 void client_bring_modal_windows(ObClient *self);
593
594 /*! Calculates the stacking layer for the client window */
595 void client_calc_layer(ObClient *self);
596
597 /*! Updates the window's transient status, and any parents of it */
598 void client_update_transient_for(ObClient *self);
599 /*! Update the protocols that the window supports and adjusts things if they
600   change */
601 void client_update_protocols(ObClient *self);
602 #ifdef SYNC
603 /*! Updates the window's sync request counter for resizes */
604 void client_update_sync_request_counter(ObClient *self);
605 #endif
606 /*! Updates the window's colormap */
607 void client_update_colormap(ObClient *self, Colormap colormap);
608 /*! Updates the WMNormalHints and adjusts things if they change */
609 void client_update_normal_hints(ObClient *self);
610
611 /*! Updates the WMHints and adjusts things if they change
612   @param initstate Whether to read the initial_state property from the
613                    WMHints. This should only be used during the mapping
614                    process.
615 */
616 void client_update_wmhints(ObClient *self);
617 /*! Updates the window's title and icon title */
618 void client_update_title(ObClient *self);
619 /*! Updates the strut for the client */
620 void client_update_strut(ObClient *self);
621 /*! Updates the window's icons */
622 void client_update_icons(ObClient *self);
623 /*! Updates the window's icon geometry (where to iconify to/from) */
624 void client_update_icon_geometry(ObClient *self);
625
626 /*! Set up what decor should be shown on the window and what functions should
627   be allowed (ObClient::decorations and ObClient::functions).
628   This also updates the NET_WM_ALLOWED_ACTIONS hint.
629   @param reconfig When TRUE, the window will be reconfigured to show the
630          changes
631 */
632 void client_setup_decor_and_functions(ObClient *self, gboolean reconfig);
633
634 /*! Sets the window's type and transient flag */
635 void client_get_type_and_transientness(ObClient *self);
636
637 /*! Returns a client's icon set, or its parents (recursively) if it doesn't
638   have one
639 */
640 RrImage* client_icon(ObClient *self);
641
642 /*! Return TRUE if the client is transient for some other window. Return
643   FALSE if it's not transient or there is no window for it to be
644   transient for */
645 gboolean client_has_parent(ObClient *self);
646
647 /*! Searches a client's immediate parents for a focused window. The function
648   does not check for the passed client, only for *ONE LEVEL* of its parents.
649   If no focused parent is found, NULL is returned.
650 */
651 ObClient *client_search_focus_parent(ObClient *self);
652
653 /*! Searches a client's parents for a focused window. The function
654   does not check for the passed client, but searches through all of its
655   parents. If no focused parent is found, NULL is returned.
656 */
657 ObClient *client_search_focus_parent_full(ObClient *self);
658
659 /*! Searches a client's transients for a focused window. The function does not
660   check for the passed client, only for its transients.
661   If no focused transient is found, NULL is returned.
662 */
663 ObClient *client_search_focus_tree(ObClient *self);
664
665 /*! Searches a client's transient tree for a focused window. The function
666   searches up the tree and down other branches as well as the passed client's.
667   If no focused client is found, NULL is returned.
668 */
669 ObClient *client_search_focus_tree_full(ObClient *self);
670
671 /*! Searches a client's group and each member's transients for a focused
672   window.  This doesn't go up the window's transient tree at all. If no
673   focused client is found, NULL is returned. */
674 ObClient *client_search_focus_group_full(ObClient *self);
675
676 /*! Return a modal child of the client window that can be focused.
677     @return A modal child of the client window that can be focused, or 0 if
678             none was found.
679 */
680 ObClient *client_search_modal_child(ObClient *self);
681
682 /*! Returns a list of top-level windows which this is a transient for.
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(ObClient *self);
687
688 /*! Returns a list of top-level windows which this is a transient for, and
689   which are in the same layer as this client.
690   It will only contain more than 1 element if the client is transient for its
691   group.
692 */
693 GSList *client_search_all_top_parents_layer(ObClient *self);
694
695 /*! Returns the client's parent when it is transient for a direct window
696   rather than a group. If it has no parents, or is transient for the
697   group, this returns null */
698 ObClient *client_direct_parent(ObClient *self);
699
700 /*! Returns a window's top level parent. This only counts direct parents,
701   not groups if it is transient for its group.
702 */
703 ObClient *client_search_top_direct_parent(ObClient *self);
704
705 /*! Is one client a direct child of another (i.e. not through the group.)
706   This checks more than one level, so there may be another direct child in
707   between */
708 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
709
710 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
711   returns the searched for parent if it is a parent, or NULL if not. */
712 ObClient *client_search_parent(ObClient *self, ObClient *search);
713
714 /*! Search for a transient of a client. The transient is returned if it is one,
715   NULL is returned if the given search is not a transient of the client. */
716 ObClient *client_search_transient(ObClient *self, ObClient *search);
717
718 /*! Set a client window to be above/below other clients.
719   @layer < 0 indicates the client should be placed below other clients.<br />
720          = 0 indicates the client should be placed with other clients.<br />
721          > 0 indicates the client should be placed above other clients.
722 */
723 void client_set_layer(ObClient *self, gint layer);
724
725 guint client_monitor(ObClient *self);
726
727 ObClient* client_under_pointer(void);
728
729 gboolean client_has_group_siblings(ObClient *self);
730
731 /*! Returns TRUE if the client is running on the same machine as Openbox */
732 gboolean client_on_localhost(ObClient *self);
733
734 #endif