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     /*! 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
 330 /*! Manages all existing windows */
 331 void client_manage_all(void);
 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 /*! Iconifies or uniconifies the client window
 496   @param iconic true if the window should be iconified; false if it should be
 497                 restored.
 498   @param curdesk If iconic is FALSE, then this determines if the window will
 499                  be uniconified to the current viewable desktop (true) or to
 500                  its previous desktop (false)
 501 */
 502 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk,
 503                     gboolean hide_animation);
 504
 505 /*! Maximize or unmaximize the client window
 506   @param max true if the window should be maximized; false if it should be
 507              returned to normal size.
 508   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
 509 */
 510 void client_maximize(ObClient *self, gboolean max, gint dir);
 511
 512 /*! Shades or unshades the client window
 513   @param shade true if the window should be shaded; false if it should be
 514                unshaded.
 515 */
 516 void client_shade(ObClient *self, gboolean shade);
 517
 518 /*! Set a client window to have decorations or not */
 519 void client_set_undecorated(ObClient *self, gboolean undecorated);
 520
 521 /*! Hilite the window to make the user notice it */
 522 void client_hilite(ObClient *self, gboolean hilite);
 523
 524 /*! Request the client to close its window */
 525 void client_close(ObClient *self);
 526
 527 /*! Kill the client off violently */
 528 void client_kill(ObClient *self);
 529
 530 /*! Sends the window to the specified desktop
 531   @param donthide If TRUE, the window will not be shown/hidden after its
 532                   desktop has been changed. Generally this should be FALSE.
 533   @param dontraise If TRUE, the window will not be raised. Generally this should
 534                    be FALSE.
 535 */
 536 void client_set_desktop(ObClient *self, guint target, gboolean donthide,
 537                         gboolean dontraise);
 538
 539 /*! Show the client if it should be shown. Returns if the window is shown. */
 540 gboolean client_show(ObClient *self);
 541
 542 /*! Show the client if it should be shown. Returns if the window is hidden. */
 543 gboolean client_hide(ObClient *self);
 544
 545 /*! Show the client if it should be shown, and hide it if it should be
 546   hidden. This is for example, when switching desktops.
 547 */
 548 void client_showhide(ObClient *self);
 549
 550 /*! Validate client, by making sure no Destroy or Unmap events exist in
 551   the event queue for the window.
 552   @return true if the client is valid; false if the client has already
 553           been unmapped/destroyed, and so is invalid.
 554 */
 555 gboolean client_validate(ObClient *self);
 556
 557 /*! Sets the wm_state to the specified value */
 558 void client_set_wm_state(ObClient *self, glong state);
 559
 560 /*! Adjusts the window's net_state
 561   This should not be called as part of the window mapping process! It is for
 562   use when updating the state post-mapping.<br>
 563   client_apply_startup_state is used to do the same things during the mapping
 564   process.
 565 */
 566 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
 567
 568 /* Given a ObClient, find the client that focus would actually be sent to if
 569    you wanted to give focus to the specified ObClient. Will return the same
 570    ObClient passed to it or another ObClient if appropriate. */
 571 ObClient *client_focus_target(ObClient *self);
 572
 573 /*! Returns what client_focus would return if passed the same client, but
 574   without focusing it or modifying the focus order lists. */
 575 gboolean client_can_focus(ObClient *self);
 576
 577 /*! Attempt to focus the client window */
 578 gboolean client_focus(ObClient *self);
 579
 580 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
 581   when the user deliberately selects a window for use.
 582   @param desktop If true, and the window is on another desktop, it will still
 583                  be activated.
 584   @param here If true, and the window is on another desktop, it will be moved
 585               to the current desktop, otherwise the desktop will switch to
 586               where the window is.
 587   @param raise If true, the client is brought to the front.
 588   @param unshade If true, the client is unshaded (if it is shaded)
 589   @param user If true, then a user action is what requested the activation;
 590               otherwise, it means an application requested it on its own
 591 */
 592 void client_activate(ObClient *self, gboolean desktop, gboolean here,
 593                      gboolean raise, gboolean unshade, gboolean user);
 594
 595 /*! Bring all of its helper windows to its desktop. These are the utility and
 596   stuff windows. */
 597 void client_bring_helper_windows(ObClient *self);
 598
 599 /*! Bring all of its modal windows to its desktop. */
 600 void client_bring_modal_windows(ObClient *self);
 601
 602 /*! Calculates the stacking layer for the client window */
 603 void client_calc_layer(ObClient *self);
 604
 605 /*! Updates the window's transient status, and any parents of it */
 606 void client_update_transient_for(ObClient *self);
 607 /*! Update the protocols that the window supports and adjusts things if they
 608   change */
 609 void client_update_protocols(ObClient *self);
 610 #ifdef SYNC
 611 /*! Updates the window's sync request counter for resizes */
 612 void client_update_sync_request_counter(ObClient *self);
 613 #endif
 614 /*! Updates the window's colormap */
 615 void client_update_colormap(ObClient *self, Colormap colormap);
 616 /*! Updates the WMNormalHints and adjusts things if they change */
 617 void client_update_normal_hints(ObClient *self);
 618
 619 /*! Updates the WMHints and adjusts things if they change
 620   @param initstate Whether to read the initial_state property from the
 621                    WMHints. This should only be used during the mapping
 622                    process.
 623 */
 624 void client_update_wmhints(ObClient *self);
 625 /*! Updates the window's title and icon title */
 626 void client_update_title(ObClient *self);
 627 /*! Updates the strut for the client */
 628 void client_update_strut(ObClient *self);
 629 /*! Updates the window's icons */
 630 void client_update_icons(ObClient *self);
 631 /*! Updates the window's icon geometry (where to iconify to/from) */
 632 void client_update_icon_geometry(ObClient *self);
 633
 634 /*! Set up what decor should be shown on the window and what functions should
 635   be allowed (ObClient::decorations and ObClient::functions).
 636   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 637   @param reconfig When TRUE, the window will be reconfigured to show the
 638          changes
 639 */
 640 void client_setup_decor_and_functions(ObClient *self, gboolean reconfig);
 641
 642 /*! Sets the window's type and transient flag */
 643 void client_get_type_and_transientness(ObClient *self);
 644 /*! Gets the motif wm hints */
 645 void client_get_mwm_hints(ObClient *self);
 646
 647 /*! Returns a client's icon set, or its parents (recursively) if it doesn't
 648   have one
 649 */
 650 RrImage* client_icon(ObClient *self);
 651
 652 /*! Return TRUE if the client is transient for some other window. Return
 653   FALSE if it's not transient or there is no window for it to be
 654   transient for */
 655 gboolean client_has_parent(ObClient *self);
 656
 657 /*! Searches a client's immediate parents for a focused window. The function
 658   does not check for the passed client, only for *ONE LEVEL* of its parents.
 659   If no focused parent is found, NULL is returned.
 660 */
 661 ObClient *client_search_focus_parent(ObClient *self);
 662
 663 /*! Searches a client's parents for a focused window. The function
 664   does not check for the passed client, but searches through all of its
 665   parents. If no focused parent is found, NULL is returned.
 666 */
 667 ObClient *client_search_focus_parent_full(ObClient *self);
 668
 669 /*! Searches a client's transients for a focused window. The function does not
 670   check for the passed client, only for its transients.
 671   If no focused transient is found, NULL is returned.
 672 */
 673 ObClient *client_search_focus_tree(ObClient *self);
 674
 675 /*! Searches a client's transient tree for a focused window. The function
 676   searches up the tree and down other branches as well as the passed client's.
 677   If no focused client is found, NULL is returned.
 678 */
 679 ObClient *client_search_focus_tree_full(ObClient *self);
 680
 681 /*! Searches a client's group and each member's transients for a focused
 682   window.  This doesn't go up the window's transient tree at all. If no
 683   focused client is found, NULL is returned. */
 684 ObClient *client_search_focus_group_full(ObClient *self);
 685
 686 /*! Return a modal child of the client window that can be focused.
 687     @return A modal child of the client window that can be focused, or 0 if
 688             none was found.
 689 */
 690 ObClient *client_search_modal_child(ObClient *self);
 691
 692 /*! Returns a list of top-level windows which this is a transient for.
 693   It will only contain more than 1 element if the client is transient for its
 694   group.
 695 */
 696 GSList *client_search_all_top_parents(ObClient *self);
 697
 698 /*! Returns a list of top-level windows which this is a transient for, and
 699   which are in the same layer as this client.
 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_layer(ObClient *self);
 704
 705 /*! Returns the client's parent when it is transient for a direct window
 706   rather than a group. If it has no parents, or is transient for the
 707   group, this returns null */
 708 ObClient *client_direct_parent(ObClient *self);
 709
 710 /*! Returns a window's top level parent. This only counts direct parents,
 711   not groups if it is transient for its group.
 712 */
 713 ObClient *client_search_top_direct_parent(ObClient *self);
 714
 715 /*! Is one client a direct child of another (i.e. not through the group.)
 716   This checks more than one level, so there may be another direct child in
 717   between */
 718 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
 719
 720 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
 721   returns the searched for parent if it is a parent, or NULL if not. */
 722 ObClient *client_search_parent(ObClient *self, ObClient *search);
 723
 724 /*! Search for a transient of a client. The transient is returned if it is one,
 725   NULL is returned if the given search is not a transient of the client. */
 726 ObClient *client_search_transient(ObClient *self, ObClient *search);
 727
 728 /*! Set a client window to be above/below other clients.
 729   @layer < 0 indicates the client should be placed below other clients.<br />
 730          = 0 indicates the client should be placed with other clients.<br />
 731          > 0 indicates the client should be placed above other clients.
 732 */
 733 void client_set_layer(ObClient *self, gint layer);
 734
 735 guint client_monitor(ObClient *self);
 736
 737 ObClient* client_under_pointer(void);
 738
 739 gboolean client_has_group_siblings(ObClient *self);
 740
 741 /*! Returns TRUE if the client is running on the same machine as Openbox */
 742 gboolean client_on_localhost(ObClient *self);
 743
 744 #endif