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