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) 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     gint 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     /*! Position and size of the window prior to being maximized */
 141     Rect pre_max_area;
 142     /*! Position and size of the window prior to being fullscreened */
 143     Rect pre_fullscreen_area;
 144
 145     /*! The window's strut
 146       The strut defines areas of the screen that are marked off-bounds for
 147       window placement. In theory, where this window exists.
 148     */
 149     StrutPartial strut;
 150
 151     /*! The logical size of the window
 152       The "logical" size of the window is refers to the user's perception of
 153       the size of the window, and is the value that should be displayed to the
 154       user. For example, with xterms, this value it the number of characters
 155       being displayed in the terminal, instead of the number of pixels.
 156     */
 157     Size logical_size;
 158
 159     /*! Width of the border on the window.
 160       The window manager will set this to 0 while the window is being managed,
 161       but needs to restore it afterwards, so it is saved here.
 162     */
 163     guint border_width;
 164
 165     /*! The minimum aspect ratio the client window can be sized to.
 166       A value of 0 means this is ignored.
 167     */
 168     gfloat min_ratio;
 169     /*! The maximum aspect ratio the client window can be sized to.
 170       A value of 0 means this is ignored.
 171     */
 172     gfloat max_ratio;
 173
 174     /*! The minimum size of the client window
 175       If the min is > the max, then the window is not resizable
 176     */
 177     Size min_size;
 178     /*! The maximum size of the client window
 179       If the min is > the max, then the window is not resizable
 180     */
 181     Size max_size;
 182     /*! The size of increments to resize the client window by */
 183     Size size_inc;
 184     /*! The base size of the client window
 185       This value should be subtracted from the window's actual size when
 186       displaying its size to the user, or working with its min/max size
 187     */
 188     Size base_size;
 189
 190     /*! Window decoration and functionality hints */
 191     ObMwmHints mwmhints;
 192
 193     /*! Where to place the decorated window in relation to the undecorated
 194       window */
 195     gint gravity;
 196
 197     /*! The state of the window, one of WithdrawnState, IconicState, or
 198       NormalState */
 199     glong wmstate;
 200
 201     /*! True if the client supports the delete_window protocol */
 202     gboolean delete_window;
 203
 204     /*! Was the window's position requested by the application or the user?
 205       if by the application, we force it completely onscreen, if by the user
 206       we only force it if it tries to go completely offscreen, if neither, we
 207       should place the window ourselves when it first appears */
 208     guint positioned;
 209
 210     /*! Can the window receive input focus? */
 211     gboolean can_focus;
 212     /*! Urgency flag */
 213     gboolean urgent;
 214     /*! Notify the window when it receives focus? */
 215     gboolean focus_notify;
 216
 217     /*! The window uses shape extension to be non-rectangular? */
 218     gboolean shaped;
 219
 220     /*! The window is modal, so it must be processed before any windows it is
 221       related to can be focused */
 222     gboolean modal;
 223     /*! Only the window's titlebar is displayed */
 224     gboolean shaded;
 225     /*! The window is iconified */
 226     gboolean iconic;
 227     /*! The window is maximized to fill the screen vertically */
 228     gboolean max_vert;
 229     /*! The window is maximized to fill the screen horizontally */
 230     gboolean max_horz;
 231     /*! The window should not be displayed by pagers */
 232     gboolean skip_pager;
 233     /*! The window should not be displayed by taskbars */
 234     gboolean skip_taskbar;
 235     /*! The window is a 'fullscreen' window, and should be on top of all
 236       others */
 237     gboolean fullscreen;
 238     /*! The window should be on top of other windows of the same type.
 239       above takes priority over below. */
 240     gboolean above;
 241     /*! The window should be underneath other windows of the same type.
 242       above takes priority over below. */
 243     gboolean below;
 244
 245     /*! The layer in which the window will be stacked, windows in lower layers
 246       are always below windows in higher layers. */
 247     ObStackingLayer layer;
 248
 249     /*! A bitmask of values in the ObFrameDecorations enum
 250       The values in the variable are the decorations that the client wants to
 251       be displayed around it.
 252     */
 253     guint decorations;
 254
 255     /*! A user option. When this is set to TRUE the client will not ever
 256       be decorated.
 257     */
 258     gboolean undecorated;
 259
 260     /*! A bitmask of values in the ObFunctions enum
 261       The values in the variable specify the ways in which the user is allowed
 262       to modify this window.
 263     */
 264     guint functions;
 265
 266     /*! Icons for the client as specified on the client window */
 267     ObClientIcon *icons;
 268     /*! The number of icons in icons */
 269     guint nicons;
 270 };
 271
 272 extern GList *client_list;
 273
 274 void client_startup(gboolean reconfig);
 275 void client_shutdown(gboolean reconfig);
 276
 277 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
 278
 279 void client_add_destructor(ObClientDestructor func, gpointer data);
 280 void client_remove_destructor(ObClientDestructor func);
 281
 282 /*! Manages all existing windows */
 283 void client_manage_all();
 284 /*! Manages a given window */
 285 void client_manage(Window win);
 286 /*! Unmanages all managed windows */
 287 void client_unmanage_all();
 288 /*! Unmanages a given client */
 289 void client_unmanage(ObClient *client);
 290
 291 /*! Sets the client list on the root window from the client_list */
 292 void client_set_list();
 293
 294 /*! Determines if the client should be shown or hidden currently.
 295   @return TRUE if it should be visible; otherwise, FALSE.
 296 */
 297 gboolean client_should_show(ObClient *self);
 298
 299 /*! Returns if the window should be treated as a normal window.
 300   Some windows (desktops, docks, splash screens) have special rules applied
 301   to them in a number of places regarding focus or user interaction. */
 302 gboolean client_normal(ObClient *self);
 303
 304 /* Returns if the window is focused */
 305 gboolean client_focused(ObClient *self);
 306
 307 #define client_move(self, x, y) \
 308   client_configure(self, OB_CORNER_TOPLEFT, x, y, \
 309                    self->area.width, self->area.height, \
 310                    TRUE, TRUE)
 311 #define client_resize(self, w, h) \
 312   client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
 313                    w, h, TRUE, TRUE)
 314 #define client_move_resize(self, x, y, w, h) \
 315   client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
 316
 317 #define client_configure(self, anchor, x, y, w, h, user, final) \
 318   client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
 319
 320 /*! Move and/or resize the window.
 321   This also maintains things like the client's minsize, and size increments.
 322   @param anchor The corner to keep in the same position when resizing.
 323   @param x The x coordiante of the new position for the client.
 324   @param y The y coordiante of the new position for the client.
 325   @param w The width component of the new size for the client.
 326   @param h The height component of the new size for the client.
 327   @param user Specifies whether this is a user-requested change or a
 328               program requested change. For program requested changes, the
 329               constraints are not checked.
 330   @param final If user is true, then this should specify if this is a final
 331                configuration. e.g. Final should be FALSE if doing an
 332                interactive move/resize, and then be TRUE for the last call
 333                only.
 334   @param force_reply Send a ConfigureNotify to the client regardless of if
 335                      the position changed.
 336 */
 337 void client_configure_full(ObClient *self, ObCorner anchor,
 338                            gint x, gint y, gint w, gint h,
 339                            gboolean user, gboolean final,
 340                            gboolean force_reply);
 341
 342 void client_reconfigure(ObClient *self);
 343
 344 /*! Finds coordinates to keep a client on the screen.
 345   @param self The client
 346   @param x The x coord of the client, may be changed.
 347   @param y The y coord of the client, may be changed.
 348   @param w The width of the client.
 349   @param w The height of the client.
 350   @param rude Be rude about it. If false, it is only moved if it is entirely
 351               not visible. If true, then make sure the window is inside the
 352               struts if possible.
 353   @return true if the client was moved to be on-screen; false if not.
 354 */
 355 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
 356                               gboolean rude);
 357
 358 /*! Moves a client so that it is on screen if it is entirely out of the
 359   viewable screen.
 360   @param self The client to move
 361   @param rude Be rude about it. If false, it is only moved if it is entirely
 362               not visible. If true, then make sure the window is inside the
 363               struts if possible.
 364 */
 365 void client_move_onscreen(ObClient *self, gboolean rude);
 366
 367 /*! Fullscreen's or unfullscreen's the client window
 368   @param fs true if the window should be made fullscreen; false if it should
 369             be returned to normal state.
 370   @param savearea true to have the client's current size and position saved;
 371                   otherwise, they are not. You should not save when mapping a
 372                   new window that is set to fullscreen. This has no effect
 373                   when restoring a window from fullscreen.
 374 */
 375 void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
 376
 377 /*! Iconifies or uniconifies the client window
 378   @param iconic true if the window should be iconified; false if it should be
 379                 restored.
 380   @param curdesk If iconic is FALSE, then this determines if the window will
 381                  be uniconified to the current viewable desktop (true) or to
 382                  its previous desktop (false)
 383 */
 384 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
 385
 386 /*! Maximize or unmaximize the client window
 387   @param max true if the window should be maximized; false if it should be
 388              returned to normal size.
 389   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
 390   @param savearea true to have the client's current size and position saved;
 391                   otherwise, they are not. You should not save when mapping a
 392                   new window that is set to fullscreen. This has no effect
 393                   when unmaximizing a window.
 394 */
 395 void client_maximize(ObClient *self, gboolean max, gint dir,
 396                      gboolean savearea);
 397
 398 /*! Shades or unshades the client window
 399   @param shade true if the window should be shaded; false if it should be
 400                unshaded.
 401 */
 402 void client_shade(ObClient *self, gboolean shade);
 403
 404 /*! Request the client to close its window */
 405 void client_close(ObClient *self);
 406
 407 /*! Kill the client off violently */
 408 void client_kill(ObClient *self);
 409
 410 /*! Sends the window to the specified desktop
 411   @param donthide If TRUE, the window will not be shown/hidden after its
 412          desktop has been changed. Generally this should be FALSE. */
 413 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
 414
 415 /*! Validate client, by making sure no Destroy or Unmap events exist in
 416   the event queue for the window.
 417   @return true if the client is valid; false if the client has already
 418           been unmapped/destroyed, and so is invalid.
 419 */
 420 gboolean client_validate(ObClient *self);
 421
 422 /*! Sets the wm_state to the specified value */
 423 void client_set_wm_state(ObClient *self, glong state);
 424
 425 /*! Adjusts the window's net_state
 426   This should not be called as part of the window mapping process! It is for
 427   use when updating the state post-mapping.<br>
 428   client_apply_startup_state is used to do the same things during the mapping
 429   process.
 430 */
 431 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
 432
 433 /* Given a ObClient, find the client that focus would actually be sent to if
 434    you wanted to give focus to the specified ObClient. Will return the same
 435    ObClient passed to it or another ObClient if appropriate. */
 436 ObClient *client_focus_target(ObClient *self);
 437
 438 /*! Returns what client_focus would return if passed the same client, but
 439   without focusing it or modifying the focus order lists. */
 440 gboolean client_can_focus(ObClient *self);
 441
 442 /*! Attempt to focus the client window */
 443 gboolean client_focus(ObClient *self);
 444
 445 /*! Remove focus from the client window */
 446 void client_unfocus(ObClient *self);
 447
 448 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
 449   when the user deliberately selects a window for use.
 450   @param here If true, then the client is brought to the current desktop;
 451               otherwise, the desktop is changed to where the client lives.
 452 */
 453 void client_activate(ObClient *self, gboolean here);
 454
 455 /*! Calculates the stacking layer for the client window */
 456 void client_calc_layer(ObClient *self);
 457
 458 /*! Raises the client to the top of its stacking layer
 459   Normally actions call to the client_* functions to make stuff go, but this
 460   one is an exception. It just fires off an action, which will be queued.
 461   This is because stacking order rules can be changed by focus state, and so
 462   any time focus changes you have to wait for it to complete before you can
 463   properly restart windows. As such, this only queues an action for later
 464   execution, once the focus change has gone through.
 465 */
 466 void client_raise(ObClient *self);
 467
 468 /*! Lowers the client to the bottom of its stacking layer
 469   Normally actions call to the client_* functions to make stuff go, but this
 470   one is an exception. It just fires off an action, which will be queued.
 471   This is because stacking order rules can be changed by focus state, and so
 472   any time focus changes you have to wait for it to complete before you can
 473   properly restart windows. As such, this only queues an action for later
 474   execution, once the focus change has gone through.
 475 */
 476 void client_lower(ObClient *self);
 477
 478 /*! Updates the window's transient status, and any parents of it */
 479 void client_update_transient_for(ObClient *self);
 480 /*! Update the protocols that the window supports and adjusts things if they
 481   change */
 482 void client_update_protocols(ObClient *self);
 483 /*! Updates the WMNormalHints and adjusts things if they change */
 484 void client_update_normal_hints(ObClient *self);
 485
 486 /*! Updates the WMHints and adjusts things if they change
 487   @param initstate Whether to read the initial_state property from the
 488                    WMHints. This should only be used during the mapping
 489                    process.
 490 */
 491 void client_update_wmhints(ObClient *self);
 492 /*! Updates the window's title and icon title */
 493 void client_update_title(ObClient *self);
 494 /*! Updates the window's application name and class */
 495 void client_update_class(ObClient *self);
 496 /*! Updates the strut for the client */
 497 void client_update_strut(ObClient *self);
 498 /*! Updates the window's icons */
 499 void client_update_icons(ObClient *self);
 500
 501 /*! Set up what decor should be shown on the window and what functions should
 502   be allowed (ObClient::decorations and ObClient::functions).
 503   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 504 */
 505 void client_setup_decor_and_functions(ObClient *self);
 506
 507 /*! Retrieves the window's type and sets ObClient->type */
 508 void client_get_type(ObClient *self);
 509
 510 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
 511
 512 /*! Searches a client's direct parents for a focused window. The function does
 513   not check for the passed client, only for *ONE LEVEL* of its parents.
 514   If no focused parentt is found, NULL is returned.
 515 */
 516 ObClient *client_search_focus_parent(ObClient *self);
 517
 518 /*! Searches a client's transients for a focused window. The function does not
 519   check for the passed client, only for its transients.
 520   If no focused transient is found, NULL is returned.
 521 */
 522 ObClient *client_search_focus_tree(ObClient *self);
 523
 524 /*! Searches a client's transient tree for a focused window. The function
 525   searches up the tree and down other branches as well as the passed client's.
 526   If no focused client is found, NULL is returned.
 527 */
 528 ObClient *client_search_focus_tree_full(ObClient *self);
 529
 530 /*! Return a modal child of the client window that can be focused.
 531     @return A modal child of the client window that can be focused, or 0 if
 532             none was found.
 533 */
 534 ObClient *client_search_modal_child(ObClient *self);
 535
 536 ObClient *client_search_top_transient(ObClient *self);
 537
 538 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
 539   returns the searched for parent if it is a parent, or NULL if not. */
 540 ObClient *client_search_parent(ObClient *self, ObClient *search);
 541
 542 /*! Search for a transient of a client. The transient is returned if it is one,
 543   NULL is returned if the given search is not a transient of the client. */
 544 ObClient *client_search_transient(ObClient *self, ObClient *search);
 545
 546 /*! Return the "closest" client in the given direction */
 547 ObClient *client_find_directional(ObClient *c, ObDirection dir);
 548
 549 /*! Return the closest edge in the given direction */
 550 gint client_directional_edge_search(ObClient *c, ObDirection dir);
 551
 552 /*! Set a client window to be above/below other clients.
 553   @layer < 0 indicates the client should be placed below other clients.<br>
 554          = 0 indicates the client should be placed with other clients.<br>
 555          > 0 indicates the client should be placed above other clients.
 556 */
 557 void client_set_layer(ObClient *self, gint layer);
 558
 559 /*! Set a client window to have decorations or not */
 560 void client_set_undecorated(ObClient *self, gboolean undecorated);
 561
 562 guint client_monitor(ObClient *self);
 563
 564 void client_update_sm_client_id(ObClient *self);
 565
 566 ObClient* client_under_pointer();
 567
 568 gboolean client_has_group_siblings(ObClient *self);
 569
 570 #endif