openbox/client.h

   1 /* -*- indent-tabs-mode: t; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    client.h for the Openbox window manager
   4    Copyright (c) 2003        Ben Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __client_h
  20 #define __client_h
  21
  22 #include "misc.h"
  23 #include "mwm.h"
  24 #include "geom.h"
  25 #include "stacking.h"
  26 #include "render/color.h"
  27
  28 #include <glib.h>
  29 #include <X11/Xlib.h>
  30
  31 struct _ObFrame;
  32 struct _ObGroup;
  33 struct _ObSessionState;
  34
  35 typedef struct _ObClient     ObClient;
  36 typedef struct _ObClientIcon ObClientIcon;
  37
  38 /* The value in client.transient_for indicating it is a transient for its
  39    group instead of for a single window */
  40 #define OB_TRAN_GROUP ((void*)~0l)
  41
  42 /*! Holds an icon in ARGB format */
  43 struct _ObClientIcon
  44 {
  45     gint width;
  46     gint height;
  47     RrPixel32 *data;
  48 };
  49
  50 /*! Possible window types */
  51 typedef enum
  52 {
  53     OB_CLIENT_TYPE_DESKTOP, /*!< A desktop (bottom-most window) */
  54     OB_CLIENT_TYPE_DOCK,    /*!< A dock bar/panel window */
  55     OB_CLIENT_TYPE_TOOLBAR, /*!< A toolbar window, pulled off an app */
  56     OB_CLIENT_TYPE_MENU,    /*!< An unpinned menu from an app */
  57     OB_CLIENT_TYPE_UTILITY, /*!< A small utility window such as a palette */
  58     OB_CLIENT_TYPE_SPLASH,  /*!< A splash screen window */
  59     OB_CLIENT_TYPE_DIALOG,  /*!< A dialog window */
  60     OB_CLIENT_TYPE_NORMAL   /*!< A normal application window */
  61 } ObClientType;
  62
  63 /*! The things the user can do to the client window */
  64 typedef enum
  65 {
  66     OB_CLIENT_FUNC_RESIZE     = 1 << 0, /*!< Allow user resizing */
  67     OB_CLIENT_FUNC_MOVE       = 1 << 1, /*!< Allow user moving */
  68     OB_CLIENT_FUNC_ICONIFY    = 1 << 2, /*!< Allow to be iconified */
  69     OB_CLIENT_FUNC_MAXIMIZE   = 1 << 3, /*!< Allow to be maximized */
  70     OB_CLIENT_FUNC_SHADE      = 1 << 4, /*!< Allow to be shaded */
  71     OB_CLIENT_FUNC_FULLSCREEN = 1 << 5, /*!< Allow to be made fullscreen */
  72     OB_CLIENT_FUNC_CLOSE      = 1 << 6  /*!< Allow to be closed */
  73 } ObFunctions;
  74
  75 struct _ObClient
  76 {
  77     ObWindow obwin;
  78
  79     Window  window;
  80
  81     /*! The window's decorations. NULL while the window is being managed! */
  82     struct _ObFrame *frame;
  83
  84     /*! The number of unmap events to ignore on the window */
  85     int ignore_unmaps;
  86
  87     /*! The id of the group the window belongs to */
  88     struct _ObGroup *group;
  89
  90     /*! Saved session data to apply to this client */
  91     struct _ObSessionState *session;
  92
  93     /*! Whether or not the client is a transient window. This is guaranteed to
  94       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
  95       transient_for == NULL. */
  96     gboolean transient;
  97     /*! The client which this client is a transient (child) for.
  98       A value of TRAN_GROUP signifies that the window is a transient for all
  99       members of its ObGroup, and is not a valid pointer to be followed in this
 100       case.
 101      */
 102     ObClient *transient_for;
 103     /*! The clients which are transients (children) of this client */
 104     GSList *transients;
 105     /*! The desktop on which the window resides (0xffffffff for all
 106       desktops) */
 107     guint desktop;
 108
 109     /*! The startup id for the startup-notification protocol. This will be
 110       NULL if a startup id is not set. */
 111     gchar *startup_id;
 112
 113     /*! Normal window title */
 114     gchar *title;
 115     /*! The count for the title. When another window with the same title
 116       exists, a count will be appended to it. */
 117     guint title_count;
 118     /*! Window title when iconified */
 119     gchar *icon_title;
 120
 121     /*! The application that created the window */
 122     gchar *name;
 123     /*! The class of the window, can used for grouping */
 124     gchar *class;
 125     /*! The specified role of the window, used for identification */
 126     gchar *role;
 127     /*! The session client id for the window. *This can be NULL!* */
 128     gchar *sm_client_id;
 129
 130     /*! The type of window (what its function is) */
 131     ObClientType type;
 132
 133     /*! Position and size of the window
 134       This will not always be the actual position of the window on screen, it
 135       is, rather, the position requested by the client, to which the window's
 136       gravity is applied.
 137     */
 138     Rect area;
 139
 140     /*! The window's strut
 141       The strut defines areas of the screen that are marked off-bounds for
 142       window placement. In theory, where this window exists.
 143     */
 144     StrutPartial strut;
 145
 146     /*! The logical size of the window
 147       The "logical" size of the window is refers to the user's perception of
 148       the size of the window, and is the value that should be displayed to the
 149       user. For example, with xterms, this value it the number of characters
 150       being displayed in the terminal, instead of the number of pixels.
 151     */
 152     Size logical_size;
 153
 154     /*! Width of the border on the window.
 155       The window manager will set this to 0 while the window is being managed,
 156       but needs to restore it afterwards, so it is saved here.
 157     */
 158     guint border_width;
 159
 160     /*! The minimum aspect ratio the client window can be sized to.
 161       A value of 0 means this is ignored.
 162     */
 163     float min_ratio;
 164     /*! The maximum aspect ratio the client window can be sized to.
 165       A value of 0 means this is ignored.
 166     */
 167     float max_ratio;
 168
 169     /*! The minimum size of the client window
 170       If the min is > the max, then the window is not resizable
 171     */
 172     Size min_size;
 173     /*! The maximum size of the client window
 174       If the min is > the max, then the window is not resizable
 175     */
 176     Size max_size;
 177     /*! The size of increments to resize the client window by */
 178     Size size_inc;
 179     /*! The base size of the client window
 180       This value should be subtracted from the window's actual size when
 181       displaying its size to the user, or working with its min/max size
 182     */
 183     Size base_size;
 184
 185     /*! Window decoration and functionality hints */
 186     ObMwmHints mwmhints;
 187
 188     /*! Where to place the decorated window in relation to the undecorated
 189       window */
 190     int gravity;
 191
 192     /*! The state of the window, one of WithdrawnState, IconicState, or
 193       NormalState */
 194     long wmstate;
 195
 196     /*! True if the client supports the delete_window protocol */
 197     gboolean delete_window;
 198
 199     /*! Was the window's position requested by the application? if not, we
 200       should place the window ourselves when it first appears */
 201     gboolean positioned;
 202
 203     /*! Can the window receive input focus? */
 204     gboolean can_focus;
 205     /*! Urgency flag */
 206     gboolean urgent;
 207     /*! Notify the window when it receives focus? */
 208     gboolean focus_notify;
 209
 210     /*! The window uses shape extension to be non-rectangular? */
 211     gboolean shaped;
 212
 213     /*! The window is modal, so it must be processed before any windows it is
 214       related to can be focused */
 215     gboolean modal;
 216     /*! Only the window's titlebar is displayed */
 217     gboolean shaded;
 218     /*! The window is iconified */
 219     gboolean iconic;
 220     /*! The window is maximized to fill the screen vertically */
 221     gboolean max_vert;
 222     /*! The window is maximized to fill the screen horizontally */
 223     gboolean max_horz;
 224     /*! The window should not be displayed by pagers */
 225     gboolean skip_pager;
 226     /*! The window should not be displayed by taskbars */
 227     gboolean skip_taskbar;
 228     /*! The window is a 'fullscreen' window, and should be on top of all
 229       others */
 230     gboolean fullscreen;
 231     /*! The window should be on top of other windows of the same type.
 232       above takes priority over below. */
 233     gboolean above;
 234     /*! The window should be underneath other windows of the same type.
 235       above takes priority over below. */
 236     gboolean below;
 237
 238     /*! The layer in which the window will be stacked, windows in lower layers
 239       are always below windows in higher layers. */
 240     ObStackingLayer layer;
 241
 242     /*! A bitmask of values in the ObFrameDecorations enum
 243       The values in the variable are the decorations that the client wants to
 244       be displayed around it.
 245     */
 246     guint decorations;
 247
 248     /*! A user option. When this is set to FALSE the client will not ever
 249       be decorated.
 250     */
 251     gboolean decorate;
 252
 253     /*! A bitmask of values in the ObFunctions enum
 254       The values in the variable specify the ways in which the user is allowed
 255       to modify this window.
 256     */
 257     guint functions;
 258
 259     /*! Icons for the client as specified on the client window */
 260     ObClientIcon *icons;
 261     /*! The number of icons in icons */
 262     guint nicons;
 263 };
 264
 265 extern GList *client_list;
 266
 267 void client_startup(gboolean reconfig);
 268 void client_shutdown(gboolean reconfig);
 269
 270 void client_add_destructor(GDestroyNotify func);
 271 void client_remove_destructor(GDestroyNotify func);
 272
 273 /*! Manages all existing windows */
 274 void client_manage_all();
 275 /*! Manages a given window */
 276 void client_manage(Window win);
 277 /*! Unmanages all managed windows */
 278 void client_unmanage_all();
 279 /*! Unmanages a given client */
 280 void client_unmanage(ObClient *client);
 281
 282 /*! Sets the client list on the root window from the client_list */
 283 void client_set_list();
 284
 285 /*! Determines if the client should be shown or hidden currently.
 286   @return TRUE if it should be visible; otherwise, FALSE.
 287 */
 288 gboolean client_should_show(ObClient *self);
 289
 290 /*! Returns if the window should be treated as a normal window.
 291   Some windows (desktops, docks, splash screens) have special rules applied
 292   to them in a number of places regarding focus or user interaction. */
 293 gboolean client_normal(ObClient *self);
 294
 295 /* Returns if the window is focused */
 296 gboolean client_focused(ObClient *self);
 297
 298 #define client_move(self, x, y) \
 299   client_configure(self, OB_CORNER_TOPLEFT, x, y, \
 300                    self->area.width, self->area.height, \
 301                    TRUE, TRUE)
 302 #define client_resize(self, w, h) \
 303   client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
 304                    w, h, TRUE, TRUE)
 305 #define client_move_resize(self, x, y, w, h) \
 306   client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
 307
 308 #define client_configure(self, anchor, x, y, w, h, user, final) \
 309   client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
 310
 311 /*! Move and/or resize the window.
 312   This also maintains things like the client's minsize, and size increments.
 313   @param anchor The corner to keep in the same position when resizing.
 314   @param x The x coordiante of the new position for the client.
 315   @param y The y coordiante of the new position for the client.
 316   @param w The width component of the new size for the client.
 317   @param h The height component of the new size for the client.
 318   @param user Specifies whether this is a user-requested change or a
 319               program requested change. For program requested changes, the
 320               constraints are not checked.
 321   @param final If user is true, then this should specify if this is a final
 322                configuration. e.g. Final should be FALSE if doing an
 323                interactive move/resize, and then be TRUE for the last call
 324                only.
 325   @param force_reply Send a ConfigureNotify to the client regardless of if
 326                      the position changed.
 327 */
 328 void client_configure_full(ObClient *self, ObCorner anchor,
 329                            int x, int y, int w, int h,
 330                            gboolean user, gboolean final,
 331                            gboolean force_reply);
 332
 333 void client_reconfigure(ObClient *self);
 334
 335 /*! Finds coordinates to keep a client on the screen.
 336   @param self The client
 337   @param x The x coord of the client, may be changed.
 338   @param y The y coord of the client, may be changed.
 339   @param w The width of the client.
 340   @param w The height of the client.
 341   @param rude Be rude about it. If false, it is only moved if it is entirely
 342               not visible. If true, then make sure the window is inside the
 343               struts if possible.
 344   @return true if the client was moved to be on-screen; false if not.
 345 */
 346 gboolean client_find_onscreen(ObClient *self, int *x, int *y, int w, int h,
 347                               gboolean rude);
 348
 349 /*! Moves a client so that it is on screen if it is entirely out of the
 350   viewable screen.
 351   @param self The client to move
 352   @param rude Be rude about it. If false, it is only moved if it is entirely
 353               not visible. If true, then make sure the window is inside the
 354               struts if possible.
 355 */
 356 void client_move_onscreen(ObClient *self, gboolean rude);
 357
 358 /*! Fullscreen's or unfullscreen's the client window
 359   @param fs true if the window should be made fullscreen; false if it should
 360             be returned to normal state.
 361   @param savearea true to have the client's current size and position saved;
 362                   otherwise, they are not. You should not save when mapping a
 363                   new window that is set to fullscreen. This has no effect
 364                   when restoring a window from fullscreen.
 365 */
 366 void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
 367
 368 /*! Iconifies or uniconifies the client window
 369   @param iconic true if the window should be iconified; false if it should be
 370                 restored.
 371   @param curdesk If iconic is FALSE, then this determines if the window will
 372                  be uniconified to the current viewable desktop (true) or to
 373                  its previous desktop (false)
 374 */
 375 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
 376
 377 /*! Maximize or unmaximize the client window
 378   @param max true if the window should be maximized; false if it should be
 379              returned to normal size.
 380   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
 381   @param savearea true to have the client's current size and position saved;
 382                   otherwise, they are not. You should not save when mapping a
 383                   new window that is set to fullscreen. This has no effect
 384                   when unmaximizing a window.
 385 */
 386 void client_maximize(ObClient *self, gboolean max, int dir,
 387                      gboolean savearea);
 388
 389 /*! Shades or unshades the client window
 390   @param shade true if the window should be shaded; false if it should be
 391                unshaded.
 392 */
 393 void client_shade(ObClient *self, gboolean shade);
 394
 395 /*! Request the client to close its window */
 396 void client_close(ObClient *self);
 397
 398 /*! Kill the client off violently */
 399 void client_kill(ObClient *self);
 400
 401 /*! Sends the window to the specified desktop
 402   @param donthide If TRUE, the window will not be shown/hidden after its
 403          desktop has been changed. Generally this should be FALSE. */
 404 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
 405
 406 /*! Validate client, by making sure no Destroy or Unmap events exist in
 407   the event queue for the window.
 408   @return true if the client is valid; false if the client has already
 409           been unmapped/destroyed, and so is invalid.
 410 */
 411 gboolean client_validate(ObClient *self);
 412
 413 /*! Sets the wm_state to the specified value */
 414 void client_set_wm_state(ObClient *self, long state);
 415
 416 /*! Adjusts the window's net_state
 417   This should not be called as part of the window mapping process! It is for
 418   use when updating the state post-mapping.<br>
 419   client_apply_startup_state is used to do the same things during the mapping
 420   process.
 421 */
 422 void client_set_state(ObClient *self, Atom action, long data1, long data2);
 423
 424 /* Given a ObClient, find the client that focus would actually be sent to if
 425    you wanted to give focus to the specified ObClient. Will return the same
 426    ObClient passed to it or another ObClient if appropriate. */
 427 ObClient *client_focus_target(ObClient *self);
 428
 429 /*! Returns what client_focus would return if passed the same client, but
 430   without focusing it or modifying the focus order lists. */
 431 gboolean client_can_focus(ObClient *self);
 432
 433 /*! Attempt to focus the client window */
 434 gboolean client_focus(ObClient *self);
 435
 436 /*! Remove focus from the client window */
 437 void client_unfocus(ObClient *self);
 438
 439 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
 440   when the user deliberately selects a window for use.
 441   @param here If true, then the client is brought to the current desktop;
 442               otherwise, the desktop is changed to where the client lives.
 443 */
 444 void client_activate(ObClient *self, gboolean here);
 445
 446 /*! Calculates the stacking layer for the client window */
 447 void client_calc_layer(ObClient *self);
 448
 449 /*! Updates the window's transient status, and any parents of it */
 450 void client_update_transient_for(ObClient *self);
 451 /*! Update the protocols that the window supports and adjusts things if they
 452   change */
 453 void client_update_protocols(ObClient *self);
 454 /*! Updates the WMNormalHints and adjusts things if they change */
 455 void client_update_normal_hints(ObClient *self);
 456
 457 /*! Updates the WMHints and adjusts things if they change
 458   @param initstate Whether to read the initial_state property from the
 459                    WMHints. This should only be used during the mapping
 460                    process.
 461 */
 462 void client_update_wmhints(ObClient *self);
 463 /*! Updates the window's title and icon title */
 464 void client_update_title(ObClient *self);
 465 /*! Updates the window's application name and class */
 466 void client_update_class(ObClient *self);
 467 /*! Updates the strut for the client */
 468 void client_update_strut(ObClient *self);
 469 /*! Updates the window's icons */
 470 void client_update_icons(ObClient *self);
 471
 472 /*! Set up what decor should be shown on the window and what functions should
 473   be allowed (ObClient::decorations and ObClient::functions).
 474   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 475 */
 476 void client_setup_decor_and_functions(ObClient *self);
 477
 478 /*! Retrieves the window's type and sets ObClient->type */
 479 void client_get_type(ObClient *self);
 480
 481 ObClientIcon *client_icon(ObClient *self, int w, int h);
 482
 483 /*! Searches a client's transients for a focused window. The function does not
 484   check for the passed client, only for its transients.
 485   If no focused transient is found, NULL is returned.
 486 */
 487 ObClient *client_search_focus_tree(ObClient *self);
 488
 489 /*! Searches a client's transient tree for a focused window. The function
 490   searches up the tree and down other branches as well as the passed client's.
 491   If no focused client is found, NULL is returned.
 492 */
 493 ObClient *client_search_focus_tree_full(ObClient *self);
 494
 495 /*! Return a modal child of the client window that can be focused.
 496     @return A modal child of the client window that can be focused, or 0 if
 497             none was found.
 498 */
 499 ObClient *client_search_modal_child(ObClient *self);
 500
 501 ObClient *client_search_top_transient(ObClient *self);
 502
 503 ObClient *client_search_transient(ObClient *self, ObClient *search);
 504
 505 /*! Return the "closest" client in the given direction */
 506 ObClient *client_find_directional(ObClient *c, ObDirection dir);
 507
 508 /*! Return the closest edge in the given direction */
 509 int client_directional_edge_search(ObClient *c, ObDirection dir);
 510
 511 /*! Set a client window to be above/below other clients.
 512   @layer < 0 indicates the client should be placed below other clients.<br>
 513          = 0 indicates the client should be placed with other clients.<br>
 514          > 0 indicates the client should be placed above other clients.
 515 */
 516 void client_set_layer(ObClient *self, int layer);
 517
 518 guint client_monitor(ObClient *self);
 519
 520 void client_update_sm_client_id(ObClient *self);
 521
 522 #endif