Fix client_activate() to work for internal Openbox menus
[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     /*! The window uses shape extension to have non-rectangular input? */
250     gboolean shaped_input;
251
252     /*! The window is modal, so it must be processed before any windows it is
253       related to can be focused */
254     gboolean modal;
255     /*! Only the window's titlebar is displayed */
256     gboolean shaded;
257     /*! The window is iconified */
258     gboolean iconic;
259     /*! The window is maximized to fill the screen vertically */
260     gboolean max_vert;
261     /*! The window is maximized to fill the screen horizontally */
262     gboolean max_horz;
263     /*! The window should not be displayed by pagers */
264     gboolean skip_pager;
265     /*! The window should not be displayed by taskbars */
266     gboolean skip_taskbar;
267     /*! The window is a 'fullscreen' window, and should be on top of all
268       others */
269     gboolean fullscreen;
270     /*! The window should be on top of other windows of the same type.
271       above takes priority over below. */
272     gboolean above;
273     /*! The window should be underneath other windows of the same type.
274       above takes priority over below. */
275     gboolean below;
276     /*! Demands attention flag */
277     gboolean demands_attention;
278
279     /*! The urgent flag */
280     gboolean urgent;
281
282     /*! The layer in which the window will be stacked, windows in lower layers
283       are always below windows in higher layers. */
284     ObStackingLayer layer;
285
286     /*! A bitmask of values in the ObFrameDecorations enum
287       The values in the variable are the decorations that the client wants to
288       be displayed around it.
289     */
290     guint decorations;
291
292     /*! A user option. When this is set to TRUE the client will not ever
293       be decorated.
294     */
295     gboolean undecorated;
296
297     /*! A bitmask of values in the ObFunctions enum
298       The values in the variable specify the ways in which the user is allowed
299       to modify this window.
300     */
301     guint functions;
302
303     /* The window's icon, in a variety of shapes and sizes */
304     RrImage *icon_set;
305
306     /*! Where the window should iconify to/from */
307     Rect icon_geometry;
308
309     /*! A boolean used for algorithms which need to mark clients as visited */
310     gboolean visited;
311 };
312
313 extern GList      *client_list;
314
315 void client_startup(gboolean reconfig);
316 void client_shutdown(gboolean reconfig);
317
318 typedef void (*ObClientCallback)(ObClient *client, gpointer data);
319
320 /* Callback functions */
321
322 /*! Get notified when the client is unmanaged */
323 void client_add_destroy_notify(ObClientCallback func, gpointer data);
324 void client_remove_destroy_notify(ObClientCallback func);
325
326 /*! Manages all existing windows */
327 void client_manage_all();
328 /*! Manages a given window
329   @param prompt This specifies an ObPrompt which is being managed.  It is
330                 possible to manage Openbox-owned windows through this.
331 */
332 void client_manage(Window win, struct _ObPrompt *prompt);
333 /*! Unmanages all managed windows */
334 void client_unmanage_all();
335 /*! Unmanages a given client */
336 void client_unmanage(ObClient *client);
337
338 /*! This manages a window only so far as is needed to get it's decorations.
339    This is used when you want to determine a window's decorations before it
340    is mapped. Call client_fake_unmanage() with the returned client when you
341    are done with it. */
342 ObClient *client_fake_manage(Window win);
343 /*! Free the stuff created by client_fake_manage() */
344 void client_fake_unmanage(ObClient *self);
345
346 /*! Sets the client list on the root window from the client_list */
347 void client_set_list();
348
349 /*! Determines if the client should be shown or hidden currently.
350   @return TRUE if it should be visible; otherwise, FALSE.
351 */
352 gboolean client_should_show(ObClient *self);
353
354 /*! Returns if the window should be treated as a normal window.
355   Some windows (desktops, docks, splash screens) have special rules applied
356   to them in a number of places regarding focus or user interaction. */
357 gboolean client_normal(ObClient *self);
358
359 /*! Returns if the window is one of an application's helper windows
360   (utilty, menu, etc) */
361 gboolean client_helper(ObClient *self);
362
363 /*! Return if the client is a type which should be given focus from mouse
364   presses on the *client* window. This doesn't affect clicking on the
365   decorations. This doesn't count for focus cycling, different rules apply to
366   that. */
367 gboolean client_mouse_focusable(ObClient *self);
368
369 /*! Return if the client is a type which should be given focus from the
370   mouse entering the window. This doesn't count for focus cycling, different
371   rules apply to that. */
372 gboolean client_enter_focusable(ObClient *self);
373
374 /* Returns if the window is focused */
375 gboolean client_focused(ObClient *self);
376
377 /*! When the client is resized but not moved, figure out the new position
378   for it based on its gravity:
379   http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
380 */
381 void client_gravity_resize_w(ObClient *self, gint *x, gint oldw, gint neww);
382
383 /*! When the client is resized but not moved, figure out the new position
384   for it based on its gravity:
385   http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
386 */
387 void client_gravity_resize_h(ObClient *self, gint *y, gint oldh, gint newh);
388
389 /*! Convert a position/size from a given gravity to the client's true gravity,
390   when the client is only resizing (the reference point doesn't move)
391  */
392 void client_convert_gravity_resize(ObClient *self, gint gravity,
393                                    gint *x, gint *y,
394                                    gint w, gint h);
395
396 #define client_move(self, x, y) \
397   client_configure(self, x, y, self->area.width, self->area.height, TRUE, TRUE,\
398                    FALSE)
399 #define client_resize(self, w, h) \
400   client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE, FALSE)
401 #define client_move_resize(self, x, y, w, h) \
402   client_configure(self, x, y, w, h, TRUE, TRUE, FALSE)
403 #define client_reconfigure(self, force) \
404   client_configure(self, ((ObClient*)self)->area.x, ((ObClient*)self)->area.y, \
405                    ((ObClient*)self)->area.width, \
406                    ((ObClient*)self)->area.height, FALSE, TRUE, force)
407
408 /*! Figure out where a window will end up and what size it will be if you
409   told it to move/resize to these coordinates.
410
411   These values are what client_configure will give the window.
412
413   @param x The x coordiante of the new position for the client.
414   @param y The y coordiante of the new position for the client.
415   @param w The width component of the new size for the client.
416   @param h The height component of the new size for the client.
417   @param logicalw Returns the width component of the new logical width.
418                   This value is only returned when the new w or h calculated
419                   differ from the ones passed in.
420   @param logicalh Returns the height component of the new logical height.
421                   This value is only returned when the new w or h calculated
422                   differ from the ones passed in.
423   @param user Specifies whether this is a user-requested change or a
424               program requested change. For program requested changes, the
425               constraints are not checked.
426 */
427 void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
428                           gint *logicalw, gint *logicalh,
429                           gboolean user);
430
431 /*! Move and/or resize the window.
432   This also maintains things like the client's minsize, and size increments.
433   @param x The x coordiante of the new position for the client.
434   @param y The y coordiante of the new position for the client.
435   @param w The width component of the new size for the client.
436   @param h The height component of the new size for the client.
437   @param user Specifies whether this is a user-requested change or a
438               program requested change. For program requested changes, the
439               constraints are not checked.
440   @param final If user is true, then this should specify if this is a final
441                configuration. e.g. Final should be FALSE if doing an
442                interactive move/resize, and then be TRUE for the last call
443                only.
444   @param force_reply Send a ConfigureNotify to the client regardless of if
445                      the position/size changed.
446 */
447 void client_configure(ObClient *self, gint x, gint y, gint w, gint h,
448                       gboolean user, gboolean final, gboolean force_reply);
449
450 /*! Finds coordinates to keep a client on the screen.
451   @param self The client
452   @param x The x coord of the client, may be changed.
453   @param y The y coord of the client, may be changed.
454   @param w The width of the client.
455   @param w The height of the client.
456   @param rude Be rude about it. If false, it is only moved if it is entirely
457               not visible. If true, then make sure the window is inside the
458               struts if possible.
459   @return true if the client was moved to be on-screen; false if not.
460 */
461 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
462                               gboolean rude);
463
464 /*! Moves a client so that it is on screen if it is entirely out of the
465   viewable screen.
466   @param self The client to move
467   @param rude Be rude about it. If false, it is only moved if it is entirely
468               not visible. If true, then make sure the window is inside the
469               struts if possible.
470 */
471 void client_move_onscreen(ObClient *self, gboolean rude);
472
473 /*! dir is either North, South, East or West. It can't be, for example,
474   Northwest */
475 void client_find_edge_directional(ObClient *self, ObDirection dir,
476                                   gint my_head, gint my_tail,
477                                   gint my_edge_start, gint my_edge_size,
478                                   gint *dest, gboolean *near_edge);
479 void client_find_move_directional(ObClient *self, ObDirection dir,
480                                   gint *x, gint *y);
481 void client_find_resize_directional(ObClient *self, ObDirection side,
482                                     gboolean grow,
483                                     gint *x, gint *y, gint *w, gint *h);
484
485 /*! Fullscreen's or unfullscreen's the client window
486   @param fs true if the window should be made fullscreen; false if it should
487             be returned to normal state.
488 */
489 void client_fullscreen(ObClient *self, gboolean fs);
490
491 /*! Iconifies or uniconifies the client window
492   @param iconic true if the window should be iconified; false if it should be
493                 restored.
494   @param curdesk If iconic is FALSE, then this determines if the window will
495                  be uniconified to the current viewable desktop (true) or to
496                  its previous desktop (false)
497 */
498 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk,
499                     gboolean hide_animation);
500
501 /*! Maximize or unmaximize the client window
502   @param max true if the window should be maximized; false if it should be
503              returned to normal size.
504   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
505 */
506 void client_maximize(ObClient *self, gboolean max, gint dir);
507
508 /*! Shades or unshades the client window
509   @param shade true if the window should be shaded; false if it should be
510                unshaded.
511 */
512 void client_shade(ObClient *self, gboolean shade);
513
514 /*! Set a client window to have decorations or not */
515 void client_set_undecorated(ObClient *self, gboolean undecorated);
516
517 /*! Hilite the window to make the user notice it */
518 void client_hilite(ObClient *self, gboolean hilite);
519
520 /*! Request the client to close its window */
521 void client_close(ObClient *self);
522
523 /*! Kill the client off violently */
524 void client_kill(ObClient *self);
525
526 /*! Sends the window to the specified desktop
527   @param donthide If TRUE, the window will not be shown/hidden after its
528                   desktop has been changed. Generally this should be FALSE.
529   @param dontraise If TRUE, the window will not be raised. Generally this should
530                    be FALSE.
531 */
532 void client_set_desktop(ObClient *self, guint target, gboolean donthide,
533                         gboolean dontraise);
534
535 /*! Show the client if it should be shown. Returns if the window is shown. */
536 gboolean client_show(ObClient *self);
537
538 /*! Show the client if it should be shown. Returns if the window is hidden. */
539 gboolean client_hide(ObClient *self);
540
541 /*! Show the client if it should be shown, and hide it if it should be
542   hidden. This is for example, when switching desktops.
543 */
544 void client_showhide(ObClient *self);
545
546 /*! Validate client, by making sure no Destroy or Unmap events exist in
547   the event queue for the window.
548   @return true if the client is valid; false if the client has already
549           been unmapped/destroyed, and so is invalid.
550 */
551 gboolean client_validate(ObClient *self);
552
553 /*! Sets the wm_state to the specified value */
554 void client_set_wm_state(ObClient *self, glong state);
555
556 /*! Adjusts the window's net_state
557   This should not be called as part of the window mapping process! It is for
558   use when updating the state post-mapping.<br>
559   client_apply_startup_state is used to do the same things during the mapping
560   process.
561 */
562 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
563
564 /* Given a ObClient, find the client that focus would actually be sent to if
565    you wanted to give focus to the specified ObClient. Will return the same
566    ObClient passed to it or another ObClient if appropriate. */
567 ObClient *client_focus_target(ObClient *self);
568
569 /*! Returns what client_focus would return if passed the same client, but
570   without focusing it or modifying the focus order lists. */
571 gboolean client_can_focus(ObClient *self);
572
573 /*! Attempt to focus the client window */
574 gboolean client_focus(ObClient *self);
575
576 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
577   when the user deliberately selects a window for use.
578   @param desktop If true, and the window is on another desktop, it will still
579                  be activated.
580   @param raise If true, the client is brought to the front.
581   @param unshade If true, the client is unshaded (if it is shaded)
582   @param user If true, then a user action is what requested the activation;
583               otherwise, it means an application requested it on its own
584 */
585 void client_activate(ObClient *self, gboolean desktop, gboolean raise,
586                      gboolean unshade, gboolean user);
587
588 /*! Bring all of its helper windows to its desktop. These are the utility and
589   stuff windows. */
590 void client_bring_helper_windows(ObClient *self);
591
592 /*! Bring all of its modal windows to its desktop. */
593 void client_bring_modal_windows(ObClient *self);
594
595 /*! Calculates the stacking layer for the client window */
596 void client_calc_layer(ObClient *self);
597
598 /*! Updates the window's transient status, and any parents of it */
599 void client_update_transient_for(ObClient *self);
600 /*! Update the protocols that the window supports and adjusts things if they
601   change */
602 void client_update_protocols(ObClient *self);
603 #ifdef SYNC
604 /*! Updates the window's sync request counter for resizes */
605 void client_update_sync_request_counter(ObClient *self);
606 #endif
607 /*! Updates the window's colormap */
608 void client_update_colormap(ObClient *self, Colormap colormap);
609 /*! Updates the WMNormalHints and adjusts things if they change */
610 void client_update_normal_hints(ObClient *self);
611
612 /*! Updates the WMHints and adjusts things if they change
613   @param initstate Whether to read the initial_state property from the
614                    WMHints. This should only be used during the mapping
615                    process.
616 */
617 void client_update_wmhints(ObClient *self);
618 /*! Updates the window's title and icon title */
619 void client_update_title(ObClient *self);
620 /*! Updates the strut for the client */
621 void client_update_strut(ObClient *self);
622 /*! Updates the window's icons */
623 void client_update_icons(ObClient *self);
624 /*! Updates the window's icon geometry (where to iconify to/from) */
625 void client_update_icon_geometry(ObClient *self);
626
627 /*! Set up what decor should be shown on the window and what functions should
628   be allowed (ObClient::decorations and ObClient::functions).
629   This also updates the NET_WM_ALLOWED_ACTIONS hint.
630   @param reconfig When TRUE, the window will be reconfigured to show the
631          changes
632 */
633 void client_setup_decor_and_functions(ObClient *self, gboolean reconfig);
634
635 /*! Sets the window's type and transient flag */
636 void client_get_type_and_transientness(ObClient *self);
637 /*! Gets the motif wm hints */
638 void client_get_mwm_hints(ObClient *self);
639
640 /*! Returns a client's icon set, or its parents (recursively) if it doesn't
641   have one
642 */
643 RrImage* client_icon(ObClient *self);
644
645 /*! Return TRUE if the client is transient for some other window. Return
646   FALSE if it's not transient or there is no window for it to be
647   transient for */
648 gboolean client_has_parent(ObClient *self);
649
650 /*! Searches a client's immediate parents for a focused window. The function
651   does not check for the passed client, only for *ONE LEVEL* of its parents.
652   If no focused parent is found, NULL is returned.
653 */
654 ObClient *client_search_focus_parent(ObClient *self);
655
656 /*! Searches a client's parents for a focused window. The function
657   does not check for the passed client, but searches through all of its
658   parents. If no focused parent is found, NULL is returned.
659 */
660 ObClient *client_search_focus_parent_full(ObClient *self);
661
662 /*! Searches a client's transients for a focused window. The function does not
663   check for the passed client, only for its transients.
664   If no focused transient is found, NULL is returned.
665 */
666 ObClient *client_search_focus_tree(ObClient *self);
667
668 /*! Searches a client's transient tree for a focused window. The function
669   searches up the tree and down other branches as well as the passed client's.
670   If no focused client is found, NULL is returned.
671 */
672 ObClient *client_search_focus_tree_full(ObClient *self);
673
674 /*! Searches a client's group and each member's transients for a focused
675   window.  This doesn't go up the window's transient tree at all. If no
676   focused client is found, NULL is returned. */
677 ObClient *client_search_focus_group_full(ObClient *self);
678
679 /*! Return a modal child of the client window that can be focused.
680     @return A modal child of the client window that can be focused, or 0 if
681             none was found.
682 */
683 ObClient *client_search_modal_child(ObClient *self);
684
685 /*! Returns a list of top-level windows which this is a transient for.
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(ObClient *self);
690
691 /*! Returns a list of top-level windows which this is a transient for, and
692   which are in the same layer as this client.
693   It will only contain more than 1 element if the client is transient for its
694   group.
695 */
696 GSList *client_search_all_top_parents_layer(ObClient *self);
697
698 /*! Returns the client's parent when it is transient for a direct window
699   rather than a group. If it has no parents, or is transient for the
700   group, this returns null */
701 ObClient *client_direct_parent(ObClient *self);
702
703 /*! Returns a window's top level parent. This only counts direct parents,
704   not groups if it is transient for its group.
705 */
706 ObClient *client_search_top_direct_parent(ObClient *self);
707
708 /*! Is one client a direct child of another (i.e. not through the group.)
709   This checks more than one level, so there may be another direct child in
710   between */
711 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
712
713 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
714   returns the searched for parent if it is a parent, or NULL if not. */
715 ObClient *client_search_parent(ObClient *self, ObClient *search);
716
717 /*! Search for a transient of a client. The transient is returned if it is one,
718   NULL is returned if the given search is not a transient of the client. */
719 ObClient *client_search_transient(ObClient *self, ObClient *search);
720
721 /*! Set a client window to be above/below other clients.
722   @layer < 0 indicates the client should be placed below other clients.<br />
723          = 0 indicates the client should be placed with other clients.<br />
724          > 0 indicates the client should be placed above other clients.
725 */
726 void client_set_layer(ObClient *self, gint layer);
727
728 guint client_monitor(ObClient *self);
729
730 ObClient* client_under_pointer();
731
732 gboolean client_has_group_siblings(ObClient *self);
733
734 /*! Returns TRUE if the client is running on the same machine as Openbox */
735 gboolean client_on_localhost(ObClient *self);
736
737 #endif