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