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        Ben 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 "render/color.h"
  28
  29 #include <glib.h>
  30 #include <X11/Xlib.h>
  31
  32 struct _ObFrame;
  33 struct _ObGroup;
  34 struct _ObSessionState;
  35
  36 typedef struct _ObClient      ObClient;
  37 typedef struct _ObClientIcon  ObClientIcon;
  38 typedef struct _ObAppSettings ObAppSettings;
  39
  40 /* The value in client.transient_for indicating it is a transient for its
  41    group instead of for a single window */
  42 #define OB_TRAN_GROUP ((void*)~0l)
  43
  44 /*! Holds an icon in ARGB format */
  45 struct _ObClientIcon
  46 {
  47     gint width;
  48     gint height;
  49     RrPixel32 *data;
  50 };
  51
  52 /*! Possible window types */
  53 typedef enum
  54 {
  55     OB_CLIENT_TYPE_DESKTOP, /*!< A desktop (bottom-most window) */
  56     OB_CLIENT_TYPE_DOCK,    /*!< A dock bar/panel window */
  57     OB_CLIENT_TYPE_TOOLBAR, /*!< A toolbar window, pulled off an app */
  58     OB_CLIENT_TYPE_MENU,    /*!< An unpinned menu from an app */
  59     OB_CLIENT_TYPE_UTILITY, /*!< A small utility window such as a palette */
  60     OB_CLIENT_TYPE_SPLASH,  /*!< A splash screen window */
  61     OB_CLIENT_TYPE_DIALOG,  /*!< A dialog window */
  62     OB_CLIENT_TYPE_NORMAL   /*!< A normal application window */
  63 } ObClientType;
  64
  65 /*! The things the user can do to the client window */
  66 typedef enum
  67 {
  68     OB_CLIENT_FUNC_RESIZE     = 1 << 0, /*!< Allow user resizing */
  69     OB_CLIENT_FUNC_MOVE       = 1 << 1, /*!< Allow user moving */
  70     OB_CLIENT_FUNC_ICONIFY    = 1 << 2, /*!< Allow to be iconified */
  71     OB_CLIENT_FUNC_MAXIMIZE   = 1 << 3, /*!< Allow to be maximized */
  72     OB_CLIENT_FUNC_SHADE      = 1 << 4, /*!< Allow to be shaded */
  73     OB_CLIENT_FUNC_FULLSCREEN = 1 << 5, /*!< Allow to be made fullscreen */
  74     OB_CLIENT_FUNC_CLOSE      = 1 << 6  /*!< Allow to be closed */
  75 } ObFunctions;
  76
  77 struct _ObClient
  78 {
  79     ObWindow obwin;
  80
  81     Window  window;
  82
  83     /*! The window's decorations. NULL while the window is being managed! */
  84     struct _ObFrame *frame;
  85
  86     /*! The number of unmap events to ignore on the window */
  87     gint ignore_unmaps;
  88
  89     /*! The id of the group the window belongs to */
  90     struct _ObGroup *group;
  91
  92     /*! Saved session data to apply to this client */
  93     struct _ObSessionState *session;
  94
  95     /*! Whether or not the client is a transient window. This is guaranteed to
  96       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
  97       transient_for == NULL. */
  98     gboolean transient;
  99     /*! The client which this client is a transient (child) for.
 100       A value of TRAN_GROUP signifies that the window is a transient for all
 101       members of its ObGroup, and is not a valid pointer to be followed in this
 102       case.
 103      */
 104     ObClient *transient_for;
 105     /*! The clients which are transients (children) of this client */
 106     GSList *transients;
 107     /*! The desktop on which the window resides (0xffffffff for all
 108       desktops) */
 109     guint desktop;
 110
 111     /*! The startup id for the startup-notification protocol. This will be
 112       NULL if a startup id is not set. */
 113     gchar *startup_id;
 114
 115     /*! Normal window title */
 116     gchar *title;
 117     /*! The count for the title. When another window with the same title
 118       exists, a count will be appended to it. */
 119     guint title_count;
 120     /*! Window title when iconified */
 121     gchar *icon_title;
 122
 123     /*! The application that created the window */
 124     gchar *name;
 125     /*! The class of the window, can used for grouping */
 126     gchar *class;
 127     /*! The specified role of the window, used for identification */
 128     gchar *role;
 129     /*! The session client id for the window. *This can be NULL!* */
 130     gchar *sm_client_id;
 131
 132     /*! The type of window (what its function is) */
 133     ObClientType type;
 134
 135     /*! Position and size of the window
 136       This will not always be the actual position of the window on screen, it
 137       is, rather, the position requested by the client, to which the window's
 138       gravity is applied.
 139     */
 140     Rect area;
 141
 142     /*! Position and size of the window prior to being maximized */
 143     Rect pre_max_area;
 144     /*! Position and size of the window prior to being fullscreened */
 145     Rect pre_fullscreen_area;
 146
 147     /*! The window's strut
 148       The strut defines areas of the screen that are marked off-bounds for
 149       window placement. In theory, where this window exists.
 150     */
 151     StrutPartial strut;
 152
 153     /*! The logical size of the window
 154       The "logical" size of the window is refers to the user's perception of
 155       the size of the window, and is the value that should be displayed to the
 156       user. For example, with xterms, this value it the number of characters
 157       being displayed in the terminal, instead of the number of pixels.
 158     */
 159     Size logical_size;
 160
 161     /*! Width of the border on the window.
 162       The window manager will set this to 0 while the window is being managed,
 163       but needs to restore it afterwards, so it is saved here.
 164     */
 165     guint border_width;
 166
 167     /*! The minimum aspect ratio the client window can be sized to.
 168       A value of 0 means this is ignored.
 169     */
 170     gfloat min_ratio;
 171     /*! The maximum aspect ratio the client window can be sized to.
 172       A value of 0 means this is ignored.
 173     */
 174     gfloat max_ratio;
 175
 176     /*! The minimum size of the client window
 177       If the min is > the max, then the window is not resizable
 178     */
 179     Size min_size;
 180     /*! The maximum size of the client window
 181       If the min is > the max, then the window is not resizable
 182     */
 183     Size max_size;
 184     /*! The size of increments to resize the client window by */
 185     Size size_inc;
 186     /*! The base size of the client window
 187       This value should be subtracted from the window's actual size when
 188       displaying its size to the user, or working with its min/max size
 189     */
 190     Size base_size;
 191
 192     /*! Window decoration and functionality hints */
 193     ObMwmHints mwmhints;
 194
 195     /*! Where to place the decorated window in relation to the undecorated
 196       window */
 197     gint gravity;
 198
 199     /*! The state of the window, one of WithdrawnState, IconicState, or
 200       NormalState */
 201     glong wmstate;
 202
 203     /*! True if the client supports the delete_window protocol */
 204     gboolean delete_window;
 205
 206     /*! Was the window's position requested by the application or the user?
 207       if by the application, we force it completely onscreen, if by the user
 208       we only force it if it tries to go completely offscreen, if neither, we
 209       should place the window ourselves when it first appears */
 210     guint positioned;
 211
 212     /*! Can the window receive input focus? */
 213     gboolean can_focus;
 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     /*! Demands attention flag */
 245     gboolean demands_attention;
 246
 247     /*! The layer in which the window will be stacked, windows in lower layers
 248       are always below windows in higher layers. */
 249     ObStackingLayer layer;
 250
 251     /*! A bitmask of values in the ObFrameDecorations enum
 252       The values in the variable are the decorations that the client wants to
 253       be displayed around it.
 254     */
 255     guint decorations;
 256
 257     /*! A user option. When this is set to TRUE the client will not ever
 258       be decorated.
 259     */
 260     gboolean undecorated;
 261
 262     /*! A bitmask of values in the ObFunctions enum
 263       The values in the variable specify the ways in which the user is allowed
 264       to modify this window.
 265     */
 266     guint functions;
 267
 268     /*! Icons for the client as specified on the client window */
 269     ObClientIcon *icons;
 270     /*! The number of icons in icons */
 271     guint nicons;
 272
 273     guint32 user_time;
 274 };
 275
 276 struct _ObAppSettings
 277 {
 278     gchar *class;
 279     gchar *name;
 280     gchar *role;
 281
 282     Point position;
 283     gboolean center_x;
 284     gboolean center_y;
 285     gboolean pos_given;
 286
 287     guint desktop;
 288     gint shade;
 289     gint decor;
 290     gint focus;
 291     gint head;
 292     gint iconic;
 293     gint skip_pager;
 294     gint skip_taskbar;
 295     gint max_horz;
 296     gint max_vert;
 297     gint fullscreen;
 298
 299     gint layer;
 300 };
 301
 302 extern GList *client_list;
 303
 304 void client_startup(gboolean reconfig);
 305 void client_shutdown(gboolean reconfig);
 306
 307 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
 308
 309 void client_add_destructor(ObClientDestructor func, gpointer data);
 310 void client_remove_destructor(ObClientDestructor func);
 311
 312 /*! Manages all existing windows */
 313 void client_manage_all();
 314 /*! Manages a given window */
 315 void client_manage(Window win);
 316 /*! Unmanages all managed windows */
 317 void client_unmanage_all();
 318 /*! Unmanages a given client */
 319 void client_unmanage(ObClient *client);
 320
 321 /*! Sets the client list on the root window from the client_list */
 322 void client_set_list();
 323
 324 /*! Determines if the client should be shown or hidden currently.
 325   @return TRUE if it should be visible; otherwise, FALSE.
 326 */
 327 gboolean client_should_show(ObClient *self);
 328
 329 /*! Returns if the window should be treated as a normal window.
 330   Some windows (desktops, docks, splash screens) have special rules applied
 331   to them in a number of places regarding focus or user interaction. */
 332 gboolean client_normal(ObClient *self);
 333
 334 /* Returns if the window is focused */
 335 gboolean client_focused(ObClient *self);
 336
 337 #define client_move(self, x, y) \
 338   client_configure(self, OB_CORNER_TOPLEFT, x, y, \
 339                    self->area.width, self->area.height, \
 340                    TRUE, TRUE)
 341 #define client_resize(self, w, h) \
 342   client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
 343                    w, h, TRUE, TRUE)
 344 #define client_move_resize(self, x, y, w, h) \
 345   client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
 346
 347 #define client_configure(self, anchor, x, y, w, h, user, final) \
 348   client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
 349
 350 /*! Move and/or resize the window.
 351   This also maintains things like the client's minsize, and size increments.
 352   @param anchor The corner to keep in the same position when resizing.
 353   @param x The x coordiante of the new position for the client.
 354   @param y The y coordiante of the new position for the client.
 355   @param w The width component of the new size for the client.
 356   @param h The height component of the new size for the client.
 357   @param user Specifies whether this is a user-requested change or a
 358               program requested change. For program requested changes, the
 359               constraints are not checked.
 360   @param final If user is true, then this should specify if this is a final
 361                configuration. e.g. Final should be FALSE if doing an
 362                interactive move/resize, and then be TRUE for the last call
 363                only.
 364   @param force_reply Send a ConfigureNotify to the client regardless of if
 365                      the position changed.
 366 */
 367 void client_configure_full(ObClient *self, ObCorner anchor,
 368                            gint x, gint y, gint w, gint h,
 369                            gboolean user, gboolean final,
 370                            gboolean force_reply);
 371
 372 void client_reconfigure(ObClient *self);
 373
 374 /*! Finds coordinates to keep a client on the screen.
 375   @param self The client
 376   @param x The x coord of the client, may be changed.
 377   @param y The y coord of the client, may be changed.
 378   @param w The width of the client.
 379   @param w The height of the client.
 380   @param rude Be rude about it. If false, it is only moved if it is entirely
 381               not visible. If true, then make sure the window is inside the
 382               struts if possible.
 383   @return true if the client was moved to be on-screen; false if not.
 384 */
 385 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
 386                               gboolean rude);
 387
 388 /*! Moves a client so that it is on screen if it is entirely out of the
 389   viewable screen.
 390   @param self The client to move
 391   @param rude Be rude about it. If false, it is only moved if it is entirely
 392               not visible. If true, then make sure the window is inside the
 393               struts if possible.
 394 */
 395 void client_move_onscreen(ObClient *self, gboolean rude);
 396
 397 /*! Fullscreen's or unfullscreen's the client window
 398   @param fs true if the window should be made fullscreen; false if it should
 399             be returned to normal state.
 400   @param savearea true to have the client's current size and position saved;
 401                   otherwise, they are not. You should not save when mapping a
 402                   new window that is set to fullscreen. This has no effect
 403                   when restoring a window from fullscreen.
 404 */
 405 void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
 406
 407 /*! Iconifies or uniconifies the client window
 408   @param iconic true if the window should be iconified; false if it should be
 409                 restored.
 410   @param curdesk If iconic is FALSE, then this determines if the window will
 411                  be uniconified to the current viewable desktop (true) or to
 412                  its previous desktop (false)
 413 */
 414 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
 415
 416 /*! Maximize or unmaximize the client window
 417   @param max true if the window should be maximized; false if it should be
 418              returned to normal size.
 419   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
 420   @param savearea true to have the client's current size and position saved;
 421                   otherwise, they are not. You should not save when mapping a
 422                   new window that is set to fullscreen. This has no effect
 423                   when unmaximizing a window.
 424 */
 425 void client_maximize(ObClient *self, gboolean max, gint dir,
 426                      gboolean savearea);
 427
 428 /*! Shades or unshades the client window
 429   @param shade true if the window should be shaded; false if it should be
 430                unshaded.
 431 */
 432 void client_shade(ObClient *self, gboolean shade);
 433
 434 /*! Hilite the window to make the user notice it */
 435 void client_hilite(ObClient *self, gboolean hilite);
 436
 437 /*! Request the client to close its window */
 438 void client_close(ObClient *self);
 439
 440 /*! Kill the client off violently */
 441 void client_kill(ObClient *self);
 442
 443 /*! Sends the window to the specified desktop
 444   @param donthide If TRUE, the window will not be shown/hidden after its
 445          desktop has been changed. Generally this should be FALSE. */
 446 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
 447
 448 /*! Validate client, by making sure no Destroy or Unmap events exist in
 449   the event queue for the window.
 450   @return true if the client is valid; false if the client has already
 451           been unmapped/destroyed, and so is invalid.
 452 */
 453 gboolean client_validate(ObClient *self);
 454
 455 /*! Sets the wm_state to the specified value */
 456 void client_set_wm_state(ObClient *self, glong state);
 457
 458 /*! Adjusts the window's net_state
 459   This should not be called as part of the window mapping process! It is for
 460   use when updating the state post-mapping.<br>
 461   client_apply_startup_state is used to do the same things during the mapping
 462   process.
 463 */
 464 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
 465
 466 /* Given a ObClient, find the client that focus would actually be sent to if
 467    you wanted to give focus to the specified ObClient. Will return the same
 468    ObClient passed to it or another ObClient if appropriate. */
 469 ObClient *client_focus_target(ObClient *self);
 470
 471 /*! Returns what client_focus would return if passed the same client, but
 472   without focusing it or modifying the focus order lists. */
 473 gboolean client_can_focus(ObClient *self);
 474
 475 /*! Attempt to focus the client window
 476   NOTE: You should validate the client before calling this !! (client_validate)
 477 */
 478 gboolean client_focus(ObClient *self);
 479
 480 /*! Remove focus from the client window */
 481 void client_unfocus(ObClient *self);
 482
 483 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
 484   when the user deliberately selects a window for use.
 485   @param here If true, then the client is brought to the current desktop;
 486               otherwise, the desktop is changed to where the client lives.
 487   @param user If true, then a user action is what requested the activation;
 488               otherwise, it means an application requested it on its own
 489   @param timestamp The time at which the activate was requested.
 490 */
 491 void client_activate(ObClient *self, gboolean here, gboolean user, Time time);
 492
 493 /*! Calculates the stacking layer for the client window */
 494 void client_calc_layer(ObClient *self);
 495
 496 /*! Raises the client to the top of its stacking layer
 497   Normally actions call to the client_* functions to make stuff go, but this
 498   one is an exception. It just fires off an action, which will be queued.
 499   This is because stacking order rules can be changed by focus state, and so
 500   any time focus changes you have to wait for it to complete before you can
 501   properly restart windows. As such, this only queues an action for later
 502   execution, once the focus change has gone through.
 503 */
 504 void client_raise(ObClient *self);
 505
 506 /*! Lowers the client to the bottom of its stacking layer
 507   Normally actions call to the client_* functions to make stuff go, but this
 508   one is an exception. It just fires off an action, which will be queued.
 509   This is because stacking order rules can be changed by focus state, and so
 510   any time focus changes you have to wait for it to complete before you can
 511   properly restart windows. As such, this only queues an action for later
 512   execution, once the focus change has gone through.
 513 */
 514 void client_lower(ObClient *self);
 515
 516 /*! Updates the window's transient status, and any parents of it */
 517 void client_update_transient_for(ObClient *self);
 518 /*! Update the protocols that the window supports and adjusts things if they
 519   change */
 520 void client_update_protocols(ObClient *self);
 521 /*! Updates the WMNormalHints and adjusts things if they change */
 522 void client_update_normal_hints(ObClient *self);
 523
 524 /*! Updates the WMHints and adjusts things if they change
 525   @param initstate Whether to read the initial_state property from the
 526                    WMHints. This should only be used during the mapping
 527                    process.
 528 */
 529 void client_update_wmhints(ObClient *self);
 530 /*! Updates the window's title and icon title */
 531 void client_update_title(ObClient *self);
 532 /*! Updates the window's application name and class */
 533 void client_update_class(ObClient *self);
 534 /*! Updates the strut for the client */
 535 void client_update_strut(ObClient *self);
 536 /*! Updates the window's icons */
 537 void client_update_icons(ObClient *self);
 538 /*! Updates the window's user time */
 539 void client_update_user_time(ObClient *self, gboolean new_event);
 540
 541 /*! Set up what decor should be shown on the window and what functions should
 542   be allowed (ObClient::decorations and ObClient::functions).
 543   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 544 */
 545 void client_setup_decor_and_functions(ObClient *self);
 546
 547 /*! Retrieves the window's type and sets ObClient->type */
 548 void client_get_type(ObClient *self);
 549
 550 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
 551
 552 /*! Searches a client's direct parents for a focused window. The function does
 553   not check for the passed client, only for *ONE LEVEL* of its parents.
 554   If no focused parentt is found, NULL is returned.
 555 */
 556 ObClient *client_search_focus_parent(ObClient *self);
 557
 558 /*! Searches a client's transients for a focused window. The function does not
 559   check for the passed client, only for its transients.
 560   If no focused transient is found, NULL is returned.
 561 */
 562 ObClient *client_search_focus_tree(ObClient *self);
 563
 564 /*! Searches a client's transient tree for a focused window. The function
 565   searches up the tree and down other branches as well as the passed client's.
 566   If no focused client is found, NULL is returned.
 567 */
 568 ObClient *client_search_focus_tree_full(ObClient *self);
 569
 570 /*! Return a modal child of the client window that can be focused.
 571     @return A modal child of the client window that can be focused, or 0 if
 572             none was found.
 573 */
 574 ObClient *client_search_modal_child(ObClient *self);
 575
 576 /*! Returns a list of top-level windows which this is a transient for.
 577   It will only contain more than 1 element if the client is transient for its
 578   group.
 579 */
 580 GSList *client_search_all_top_parents(ObClient *self);
 581
 582 /*! Returns a window's top level parent. This only counts direct parents,
 583   not groups if it is transient for its group.
 584 */
 585 ObClient *client_search_top_parent(ObClient *self);
 586
 587 /*! Is one client a direct child of another (i.e. not through the group.) */
 588 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
 589
 590 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
 591   returns the searched for parent if it is a parent, or NULL if not. */
 592 ObClient *client_search_parent(ObClient *self, ObClient *search);
 593
 594 /*! Search for a transient of a client. The transient is returned if it is one,
 595   NULL is returned if the given search is not a transient of the client. */
 596 ObClient *client_search_transient(ObClient *self, ObClient *search);
 597
 598 /*! Return the "closest" client in the given direction */
 599 ObClient *client_find_directional(ObClient *c, ObDirection dir);
 600
 601 /*! Return the closest edge in the given direction */
 602 gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
 603
 604 /*! Set a client window to be above/below other clients.
 605   @layer < 0 indicates the client should be placed below other clients.<br>
 606          = 0 indicates the client should be placed with other clients.<br>
 607          > 0 indicates the client should be placed above other clients.
 608 */
 609 void client_set_layer(ObClient *self, gint layer);
 610
 611 /*! Set a client window to have decorations or not */
 612 void client_set_undecorated(ObClient *self, gboolean undecorated);
 613
 614 guint client_monitor(ObClient *self);
 615
 616 void client_update_sm_client_id(ObClient *self);
 617
 618 ObClient* client_under_pointer();
 619
 620 gboolean client_has_group_siblings(ObClient *self);
 621
 622 #endif