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