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