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