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