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