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 "obrender/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     /*! Remember if the window was maximized before going fullscreen */
 151     gboolean pre_fullscreen_max_horz,
 152              pre_fullscreen_max_vert;
 153
 154     /*! The window's strut
 155       The strut defines areas of the screen that are marked off-bounds for
 156       window placement. In theory, where this window exists.
 157     */
 158     StrutPartial strut;
 159
 160     /*! The logical size of the window
 161       The "logical" size of the window is refers to the user's perception of
 162       the size of the window, and is the value that should be displayed to the
 163       user. For example, with xterms, this value it the number of characters
 164       being displayed in the terminal, instead of the number of pixels.
 165     */
 166     Size logical_size;
 167
 168     /*! Width of the border on the window.
 169       The window manager will set this to 0 while the window is being managed,
 170       but needs to restore it afterwards, so it is saved here.
 171     */
 172     gint border_width;
 173
 174     /*! The minimum aspect ratio the client window can be sized to.
 175       A value of 0 means this is ignored.
 176     */
 177     gfloat min_ratio;
 178     /*! The maximum aspect ratio the client window can be sized to.
 179       A value of 0 means this is ignored.
 180     */
 181     gfloat max_ratio;
 182
 183     /*! The minimum size of the client window
 184       If the min is > the max, then the window is not resizable
 185     */
 186     Size min_size;
 187     /*! The maximum size of the client window
 188       If the min is > the max, then the window is not resizable
 189     */
 190     Size max_size;
 191     /*! The size of increments to resize the client window by */
 192     Size size_inc;
 193     /*! The base size of the client window
 194       This value should be subtracted from the window's actual size when
 195       displaying its size to the user, or working with its min/max size
 196     */
 197     Size base_size;
 198
 199     /*! Window decoration and functionality hints */
 200     ObMwmHints mwmhints;
 201
 202     /*! The client's specified colormap */
 203     Colormap colormap;
 204
 205     /*! Where to place the decorated window in relation to the undecorated
 206       window */
 207     gint gravity;
 208
 209     /*! The state of the window, one of WithdrawnState, IconicState, or
 210       NormalState */
 211     glong wmstate;
 212
 213     /*! True if the client supports the delete_window protocol */
 214     gboolean delete_window;
 215
 216     /*! Was the window's position requested by the application or the user?
 217       if by the application, we force it completely onscreen, if by the user
 218       we only force it if it tries to go completely offscreen, if neither, we
 219       should place the window ourselves when it first appears */
 220     guint positioned;
 221
 222     /*! Was the window's size requested by the application or the user?
 223       If by the application we don't let it go outside the available area */
 224     guint sized;
 225
 226     /*! Can the window receive input focus? */
 227     gboolean can_focus;
 228     /*! Notify the window when it receives focus? */
 229     gboolean focus_notify;
 230
 231     /*! Will the client respond to pings? */
 232     gboolean ping;
 233     /*! Indicates if the client is trying to close but has stopped responding
 234       to pings */
 235     gboolean not_responding;
 236     /*! A prompt shown when you are trying to close a client that is not
 237       responding.  It asks if you want to kill the client */
 238     struct _ObPrompt *kill_prompt;
 239     /*! We tried to close the window with a SIGTERM */
 240     gint kill_level;
 241
 242 #ifdef SYNC
 243     /*! The client wants to sync during resizes */
 244     gboolean sync_request;
 245     /*! The XSync counter used for synchronizing during resizes */
 246     guint32 sync_counter;
 247     /*! The value we're waiting for the counter to reach */
 248     gulong sync_counter_value;
 249 #endif
 250
 251     /*! The window uses shape extension to be non-rectangular? */
 252     gboolean shaped;
 253     /*! The window uses shape extension to have non-rectangular input? */
 254     gboolean shaped_input;
 255
 256     /*! The window is modal, so it must be processed before any windows it is
 257       related to can be focused */
 258     gboolean modal;
 259     /*! Only the window's titlebar is displayed */
 260     gboolean shaded;
 261     /*! The window is iconified */
 262     gboolean iconic;
 263     /*! The window is maximized to fill the screen vertically */
 264     gboolean max_vert;
 265     /*! The window is maximized to fill the screen horizontally */
 266     gboolean max_horz;
 267     /*! The window should not be displayed by pagers */
 268     gboolean skip_pager;
 269     /*! The window should not be displayed by taskbars */
 270     gboolean skip_taskbar;
 271     /*! The window is a 'fullscreen' window, and should be on top of all
 272       others */
 273     gboolean fullscreen;
 274     /*! The window should be on top of other windows of the same type.
 275       above takes priority over below. */
 276     gboolean above;
 277     /*! The window should be underneath other windows of the same type.
 278       above takes priority over below. */
 279     gboolean below;
 280     /*! Demands attention flag */
 281     gboolean demands_attention;
 282
 283     /*! The urgent flag */
 284     gboolean urgent;
 285
 286     /*! The layer in which the window will be stacked, windows in lower layers
 287       are always below windows in higher layers. */
 288     ObStackingLayer layer;
 289
 290     /*! A bitmask of values in the ObFrameDecorations enum
 291       The values in the variable are the decorations that the client wants to
 292       be displayed around it.
 293     */
 294     guint decorations;
 295
 296     /*! A user option. When this is set to TRUE the client will not ever
 297       be decorated.
 298     */
 299     gboolean undecorated;
 300
 301     /*! A bitmask of values in the ObFunctions enum
 302       The values in the variable specify the ways in which the user is allowed
 303       to modify this window.
 304     */
 305     guint functions;
 306
 307     /* The window's icon, in a variety of shapes and sizes */
 308     RrImage *icon_set;
 309
 310     /*! Where the window should iconify to/from */
 311     Rect icon_geometry;
 312
 313     /*! A boolean used for algorithms which need to mark clients as visited */
 314     gboolean visited;
 315 };
 316
 317 extern GList      *client_list;
 318
 319 void client_startup(gboolean reconfig);
 320 void client_shutdown(gboolean reconfig);
 321
 322 typedef void (*ObClientCallback)(ObClient *client, gpointer data);
 323
 324 /* Callback functions */
 325
 326 /*! Get notified when the client is unmanaged */
 327 void client_add_destroy_notify(ObClientCallback func, gpointer data);
 328 void client_remove_destroy_notify(ObClientCallback func);
 329 void client_remove_destroy_notify_data(ObClientCallback func, gpointer data);
 330
 331 /*! Manages a given window
 332   @param prompt This specifies an ObPrompt which is being managed.  It is
 333                 possible to manage Openbox-owned windows through this.
 334 */
 335 void client_manage(Window win, struct _ObPrompt *prompt);
 336 /*! Unmanages all managed windows */
 337 void client_unmanage_all(void);
 338 /*! Unmanages a given client */
 339 void client_unmanage(ObClient *client);
 340
 341 /*! This manages a window only so far as is needed to get it's decorations.
 342    This is used when you want to determine a window's decorations before it
 343    is mapped. Call client_fake_unmanage() with the returned client when you
 344    are done with it. */
 345 ObClient *client_fake_manage(Window win);
 346 /*! Free the stuff created by client_fake_manage() */
 347 void client_fake_unmanage(ObClient *self);
 348
 349 /*! Sets the client list on the root window from the client_list */
 350 void client_set_list(void);
 351
 352 /*! Determines if the client should be shown or hidden currently.
 353   @return TRUE if it should be visible; otherwise, FALSE.
 354 */
 355 gboolean client_should_show(ObClient *self);
 356
 357 /*! Returns if the window should be treated as a normal window.
 358   Some windows (desktops, docks, splash screens) have special rules applied
 359   to them in a number of places regarding focus or user interaction. */
 360 gboolean client_normal(ObClient *self);
 361
 362 /*! Returns if the window is one of an application's helper windows
 363   (utilty, menu, etc) */
 364 gboolean client_helper(ObClient *self);
 365
 366 /*! Return if the client is a type which should be given focus from mouse
 367   presses on the *client* window. This doesn't affect clicking on the
 368   decorations. This doesn't count for focus cycling, different rules apply to
 369   that. */
 370 gboolean client_mouse_focusable(ObClient *self);
 371
 372 /*! Return if the client is a type which should be given focus from the
 373   mouse entering the window. This doesn't count for focus cycling, different
 374   rules apply to that. */
 375 gboolean client_enter_focusable(ObClient *self);
 376
 377 /* Returns if the window is focused */
 378 gboolean client_focused(ObClient *self);
 379
 380 /*! When the client is resized but not moved, figure out the new position
 381   for it based on its gravity:
 382   http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
 383 */
 384 void client_gravity_resize_w(ObClient *self, gint *x, gint oldw, gint neww);
 385
 386 /*! When the client is resized but not moved, figure out the new position
 387   for it based on its gravity:
 388   http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
 389 */
 390 void client_gravity_resize_h(ObClient *self, gint *y, gint oldh, gint newh);
 391
 392 /*! Convert a position/size from a given gravity to the client's true gravity,
 393   when the client is only resizing (the reference point doesn't move)
 394  */
 395 void client_convert_gravity_resize(ObClient *self, gint gravity,
 396                                    gint *x, gint *y,
 397                                    gint w, gint h);
 398
 399 #define client_move(self, x, y) \
 400   client_configure(self, x, y, self->area.width, self->area.height, TRUE, TRUE,\
 401                    FALSE)
 402 #define client_resize(self, w, h) \
 403   client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE, FALSE)
 404 #define client_move_resize(self, x, y, w, h) \
 405   client_configure(self, x, y, w, h, TRUE, TRUE, FALSE)
 406 #define client_reconfigure(self, force) \
 407   client_configure(self, ((ObClient*)self)->area.x, ((ObClient*)self)->area.y, \
 408                    ((ObClient*)self)->area.width, \
 409                    ((ObClient*)self)->area.height, FALSE, TRUE, force)
 410
 411 /*! Figure out where a window will end up and what size it will be if you
 412   told it to move/resize to these coordinates.
 413
 414   These values are what client_configure will give the window.
 415
 416   @param x The x coordiante of the new position for the client.
 417   @param y The y coordiante of the new position for the client.
 418   @param w The width component of the new size for the client.
 419   @param h The height component of the new size for the client.
 420   @param logicalw Returns the width component of the new logical width.
 421                   This value is only returned when the new w or h calculated
 422                   differ from the ones passed in.
 423   @param logicalh Returns the height component of the new logical height.
 424                   This value is only returned when the new w or h calculated
 425                   differ from the ones passed in.
 426   @param user Specifies whether this is a user-requested change or a
 427               program requested change. For program requested changes, the
 428               constraints are not checked.
 429 */
 430 void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
 431                           gint *logicalw, gint *logicalh,
 432                           gboolean user);
 433
 434 /*! Move and/or resize the window.
 435   This also maintains things like the client's minsize, and size increments.
 436   @param x The x coordiante of the new position for the client.
 437   @param y The y coordiante of the new position for the client.
 438   @param w The width component of the new size for the client.
 439   @param h The height component of the new size for the client.
 440   @param user Specifies whether this is a user-requested change or a
 441               program requested change. For program requested changes, the
 442               constraints are not checked.
 443   @param final If user is true, then this should specify if this is a final
 444                configuration. e.g. Final should be FALSE if doing an
 445                interactive move/resize, and then be TRUE for the last call
 446                only.
 447   @param force_reply Send a ConfigureNotify to the client regardless of if
 448                      the position/size changed.
 449 */
 450 void client_configure(ObClient *self, gint x, gint y, gint w, gint h,
 451                       gboolean user, gboolean final, gboolean force_reply);
 452
 453 /*! Finds coordinates to keep a client on the screen.
 454   @param self The client
 455   @param x The x coord of the client, may be changed.
 456   @param y The y coord of the client, may be changed.
 457   @param w The width of the client.
 458   @param w The height of the client.
 459   @param rude Be rude about it. If false, it is only moved if it is entirely
 460               not visible. If true, then make sure the window is inside the
 461               struts if possible.
 462   @return true if the client was moved to be on-screen; false if not.
 463 */
 464 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
 465                               gboolean rude);
 466
 467 /*! Moves a client so that it is on screen if it is entirely out of the
 468   viewable screen.
 469   @param self The client to move
 470   @param rude Be rude about it. If false, it is only moved if it is entirely
 471               not visible. If true, then make sure the window is inside the
 472               struts if possible.
 473 */
 474 void client_move_onscreen(ObClient *self, gboolean rude);
 475
 476 /*! dir is either North, South, East or West. It can't be, for example,
 477   Northwest */
 478 void client_find_edge_directional(ObClient *self, ObDirection dir,
 479                                   gint my_head, gint my_tail,
 480                                   gint my_edge_start, gint my_edge_size,
 481                                   gint *dest, gboolean *near_edge);
 482 void client_find_move_directional(ObClient *self, ObDirection dir,
 483                                   gint *x, gint *y);
 484 void client_find_resize_directional(ObClient *self, ObDirection side,
 485                                     gboolean grow,
 486                                     gint *x, gint *y, gint *w, gint *h);
 487
 488 /*! Fullscreen's or unfullscreen's the client window
 489   @param fs true if the window should be made fullscreen; false if it should
 490             be returned to normal state.
 491 */
 492 void client_fullscreen(ObClient *self, gboolean fs);
 493
 494 /*! Determine if the window, using the given client-area, would be considered
 495   as an "oldschool fullscreen" window, that is, if it is filling a whole
 496   monitor. */
 497 gboolean client_is_oldfullscreen(const ObClient const *self, const Rect *area);
 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 desktop If true, and the window is on another desktop, it will still
 587                  be activated.
 588   @param here If true, and the window is on another desktop, it will be moved
 589               to the current desktop, otherwise the desktop will switch to
 590               where the window is.
 591   @param raise If true, the client is brought to the front.
 592   @param unshade If true, the client is unshaded (if it is shaded)
 593   @param user If true, then a user action is what requested the activation;
 594               otherwise, it means an application requested it on its own
 595 */
 596 void client_activate(ObClient *self, gboolean desktop, gboolean here,
 597                      gboolean raise, gboolean unshade, gboolean user);
 598
 599 /*! Bring all of its helper windows to its desktop. These are the utility and
 600   stuff windows. */
 601 void client_bring_helper_windows(ObClient *self);
 602
 603 /*! Bring all of its modal windows to its desktop. */
 604 void client_bring_modal_windows(ObClient *self);
 605
 606 /*! Calculates the stacking layer for the client window */
 607 void client_calc_layer(ObClient *self);
 608
 609 /*! Updates the window's transient status, and any parents of it */
 610 void client_update_transient_for(ObClient *self);
 611 /*! Update the protocols that the window supports and adjusts things if they
 612   change */
 613 void client_update_protocols(ObClient *self);
 614 #ifdef SYNC
 615 /*! Updates the window's sync request counter for resizes */
 616 void client_update_sync_request_counter(ObClient *self);
 617 #endif
 618 /*! Updates the window's colormap */
 619 void client_update_colormap(ObClient *self, Colormap colormap);
 620 /*! Updates the requested opacity for the window from the client. */
 621 void client_update_opacity(ObClient *self);
 622 /*! Updates the WMNormalHints and adjusts things if they change */
 623 void client_update_normal_hints(ObClient *self);
 624
 625 /*! Updates the WMHints and adjusts things if they change
 626   @param initstate Whether to read the initial_state property from the
 627                    WMHints. This should only be used during the mapping
 628                    process.
 629 */
 630 void client_update_wmhints(ObClient *self);
 631 /*! Updates the window's title and icon title */
 632 void client_update_title(ObClient *self);
 633 /*! Updates the strut for the client */
 634 void client_update_strut(ObClient *self);
 635 /*! Updates the window's icons */
 636 void client_update_icons(ObClient *self);
 637 /*! Updates the window's icon geometry (where to iconify to/from) */
 638 void client_update_icon_geometry(ObClient *self);
 639
 640 /*! Set up what decor should be shown on the window and what functions should
 641   be allowed (ObClient::decorations and ObClient::functions).
 642   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 643   @param reconfig When TRUE, the window will be reconfigured to show the
 644          changes
 645 */
 646 void client_setup_decor_and_functions(ObClient *self, gboolean reconfig);
 647
 648 /*! Sets the window's type and transient flag */
 649 void client_get_type_and_transientness(ObClient *self);
 650 /*! Gets the motif wm hints */
 651 void client_get_mwm_hints(ObClient *self);
 652
 653 /*! Returns a client's icon set, or its parents (recursively) if it doesn't
 654   have one
 655 */
 656 RrImage* client_icon(ObClient *self);
 657
 658 /*! Return TRUE if the client is transient for some other window. Return
 659   FALSE if it's not transient or there is no window for it to be
 660   transient for */
 661 gboolean client_has_parent(ObClient *self);
 662
 663 /*! Return TRUE if the client has some transient children, and FALSE otherwise.
 664 */
 665 gboolean client_has_children(ObClient *self);
 666
 667 /*! Searches a client's immediate parents for a focused window. The function
 668   does not check for the passed client, only for *ONE LEVEL* of its parents.
 669   If no focused parent is found, NULL is returned.
 670 */
 671 ObClient *client_search_focus_parent(ObClient *self);
 672
 673 /*! Searches a client's parents for a focused window. The function
 674   does not check for the passed client, but searches through all of its
 675   parents. If no focused parent is found, NULL is returned.
 676 */
 677 ObClient *client_search_focus_parent_full(ObClient *self);
 678
 679 /*! Searches a client's transients for a focused window. The function does not
 680   check for the passed client, only for its transients.
 681   If no focused transient is found, NULL is returned.
 682 */
 683 ObClient *client_search_focus_tree(ObClient *self);
 684
 685 /*! Searches a client's transient tree for a focused window. The function
 686   searches up the tree and down other branches as well as the passed client's.
 687   If no focused client is found, NULL is returned.
 688 */
 689 ObClient *client_search_focus_tree_full(ObClient *self);
 690
 691 /*! Searches a client's group and each member's transients for a focused
 692   window.  This doesn't go up the window's transient tree at all. If no
 693   focused client is found, NULL is returned. */
 694 ObClient *client_search_focus_group_full(ObClient *self);
 695
 696 /*! Return a modal child of the client window that can be focused.
 697     @return A modal child of the client window that can be focused, or 0 if
 698             none was found.
 699 */
 700 ObClient *client_search_modal_child(ObClient *self);
 701
 702 /*! Returns a list of top-level windows which this is a transient for.
 703   It will only contain more than 1 element if the client is transient for its
 704   group.
 705 */
 706 GSList *client_search_all_top_parents(ObClient *self);
 707
 708 /*! Returns a list of top-level windows which this is a transient for, and
 709   which are in the same layer as this client.
 710   It will only contain more than 1 element if the client is transient for its
 711   group.
 712 */
 713 GSList *client_search_all_top_parents_layer(ObClient *self);
 714
 715 /*! Returns the client's parent when it is transient for a direct window
 716   rather than a group. If it has no parents, or is transient for the
 717   group, this returns null */
 718 ObClient *client_direct_parent(ObClient *self);
 719
 720 /*! Returns a window's top level parent. This only counts direct parents,
 721   not groups if it is transient for its group.
 722 */
 723 ObClient *client_search_top_direct_parent(ObClient *self);
 724
 725 /*! Is one client a direct child of another (i.e. not through the group.)
 726   This checks more than one level, so there may be another direct child in
 727   between */
 728 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
 729
 730 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
 731   returns the searched for parent if it is a parent, or NULL if not. */
 732 ObClient *client_search_parent(ObClient *self, ObClient *search);
 733
 734 /*! Search for a transient of a client. The transient is returned if it is one,
 735   NULL is returned if the given search is not a transient of the client. */
 736 ObClient *client_search_transient(ObClient *self, ObClient *search);
 737
 738 /*! Set a client window to be above/below other clients.
 739   @layer < 0 indicates the client should be placed below other clients.<br />
 740          = 0 indicates the client should be placed with other clients.<br />
 741          > 0 indicates the client should be placed above other clients.
 742 */
 743 void client_set_layer(ObClient *self, gint layer);
 744
 745 guint client_monitor(ObClient *self);
 746
 747 ObClient* client_under_pointer(void);
 748
 749 gboolean client_has_group_siblings(ObClient *self);
 750
 751 /*! Returns TRUE if the client has a transient child, a parent, or a
 752   group member.  Returns FALSE otherwise.
 753 */
 754 gboolean client_has_relative(ObClient *self);
 755
 756 /*! Returns TRUE if the client is running on the same machine as Openbox */
 757 gboolean client_on_localhost(ObClient *self);
 758
 759 #endif