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