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