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