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     /*! Urgency flag */
 215     gboolean urgent;
 216     /*! Notify the window when it receives focus? */
 217     gboolean focus_notify;
 218
 219     /*! The window uses shape extension to be non-rectangular? */
 220     gboolean shaped;
 221
 222     /*! The window is modal, so it must be processed before any windows it is
 223       related to can be focused */
 224     gboolean modal;
 225     /*! Only the window's titlebar is displayed */
 226     gboolean shaded;
 227     /*! The window is iconified */
 228     gboolean iconic;
 229     /*! The window is maximized to fill the screen vertically */
 230     gboolean max_vert;
 231     /*! The window is maximized to fill the screen horizontally */
 232     gboolean max_horz;
 233     /*! The window should not be displayed by pagers */
 234     gboolean skip_pager;
 235     /*! The window should not be displayed by taskbars */
 236     gboolean skip_taskbar;
 237     /*! The window is a 'fullscreen' window, and should be on top of all
 238       others */
 239     gboolean fullscreen;
 240     /*! The window should be on top of other windows of the same type.
 241       above takes priority over below. */
 242     gboolean above;
 243     /*! The window should be underneath other windows of the same type.
 244       above takes priority over below. */
 245     gboolean below;
 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
 274 struct _ObAppSettings
 275 {
 276     gchar *class;
 277     gchar *name;
 278     gchar *role;
 279
 280     Point position;
 281     gboolean center_x;
 282     gboolean center_y;
 283     gboolean pos_given;
 284
 285     guint desktop;
 286     gint shade;
 287     gint decor;
 288     gint focus;
 289     gint head;
 290     gint iconic;
 291     gint skip_pager;
 292     gint skip_taskbar;
 293     gint max_horz;
 294     gint max_vert;
 295     gint fullscreen;
 296
 297     gint layer;
 298 };
 299
 300 extern GList *client_list;
 301
 302 void client_startup(gboolean reconfig);
 303 void client_shutdown(gboolean reconfig);
 304
 305 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
 306
 307 void client_add_destructor(ObClientDestructor func, gpointer data);
 308 void client_remove_destructor(ObClientDestructor func);
 309
 310 /*! Manages all existing windows */
 311 void client_manage_all();
 312 /*! Manages a given window */
 313 void client_manage(Window win);
 314 /*! Unmanages all managed windows */
 315 void client_unmanage_all();
 316 /*! Unmanages a given client */
 317 void client_unmanage(ObClient *client);
 318
 319 /*! Sets the client list on the root window from the client_list */
 320 void client_set_list();
 321
 322 /*! Determines if the client should be shown or hidden currently.
 323   @return TRUE if it should be visible; otherwise, FALSE.
 324 */
 325 gboolean client_should_show(ObClient *self);
 326
 327 /*! Returns if the window should be treated as a normal window.
 328   Some windows (desktops, docks, splash screens) have special rules applied
 329   to them in a number of places regarding focus or user interaction. */
 330 gboolean client_normal(ObClient *self);
 331
 332 /* Returns if the window is focused */
 333 gboolean client_focused(ObClient *self);
 334
 335 #define client_move(self, x, y) \
 336   client_configure(self, OB_CORNER_TOPLEFT, x, y, \
 337                    self->area.width, self->area.height, \
 338                    TRUE, TRUE)
 339 #define client_resize(self, w, h) \
 340   client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
 341                    w, h, TRUE, TRUE)
 342 #define client_move_resize(self, x, y, w, h) \
 343   client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
 344
 345 #define client_configure(self, anchor, x, y, w, h, user, final) \
 346   client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
 347
 348 /*! Move and/or resize the window.
 349   This also maintains things like the client's minsize, and size increments.
 350   @param anchor The corner to keep in the same position when resizing.
 351   @param x The x coordiante of the new position for the client.
 352   @param y The y coordiante of the new position for the client.
 353   @param w The width component of the new size for the client.
 354   @param h The height component of the new size for the client.
 355   @param user Specifies whether this is a user-requested change or a
 356               program requested change. For program requested changes, the
 357               constraints are not checked.
 358   @param final If user is true, then this should specify if this is a final
 359                configuration. e.g. Final should be FALSE if doing an
 360                interactive move/resize, and then be TRUE for the last call
 361                only.
 362   @param force_reply Send a ConfigureNotify to the client regardless of if
 363                      the position changed.
 364 */
 365 void client_configure_full(ObClient *self, ObCorner anchor,
 366                            gint x, gint y, gint w, gint h,
 367                            gboolean user, gboolean final,
 368                            gboolean force_reply);
 369
 370 void client_reconfigure(ObClient *self);
 371
 372 /*! Finds coordinates to keep a client on the screen.
 373   @param self The client
 374   @param x The x coord of the client, may be changed.
 375   @param y The y coord of the client, may be changed.
 376   @param w The width of the client.
 377   @param w The height of the client.
 378   @param rude Be rude about it. If false, it is only moved if it is entirely
 379               not visible. If true, then make sure the window is inside the
 380               struts if possible.
 381   @return true if the client was moved to be on-screen; false if not.
 382 */
 383 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
 384                               gboolean rude);
 385
 386 /*! Moves a client so that it is on screen if it is entirely out of the
 387   viewable screen.
 388   @param self The client to move
 389   @param rude Be rude about it. If false, it is only moved if it is entirely
 390               not visible. If true, then make sure the window is inside the
 391               struts if possible.
 392 */
 393 void client_move_onscreen(ObClient *self, gboolean rude);
 394
 395 /*! Fullscreen's or unfullscreen's the client window
 396   @param fs true if the window should be made fullscreen; false if it should
 397             be returned to normal state.
 398   @param savearea true to have the client's current size and position saved;
 399                   otherwise, they are not. You should not save when mapping a
 400                   new window that is set to fullscreen. This has no effect
 401                   when restoring a window from fullscreen.
 402 */
 403 void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
 404
 405 /*! Iconifies or uniconifies the client window
 406   @param iconic true if the window should be iconified; false if it should be
 407                 restored.
 408   @param curdesk If iconic is FALSE, then this determines if the window will
 409                  be uniconified to the current viewable desktop (true) or to
 410                  its previous desktop (false)
 411 */
 412 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
 413
 414 /*! Maximize or unmaximize the client window
 415   @param max true if the window should be maximized; false if it should be
 416              returned to normal size.
 417   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
 418   @param savearea true to have the client's current size and position saved;
 419                   otherwise, they are not. You should not save when mapping a
 420                   new window that is set to fullscreen. This has no effect
 421                   when unmaximizing a window.
 422 */
 423 void client_maximize(ObClient *self, gboolean max, gint dir,
 424                      gboolean savearea);
 425
 426 /*! Shades or unshades the client window
 427   @param shade true if the window should be shaded; false if it should be
 428                unshaded.
 429 */
 430 void client_shade(ObClient *self, gboolean shade);
 431
 432 /*! Request the client to close its window */
 433 void client_close(ObClient *self);
 434
 435 /*! Kill the client off violently */
 436 void client_kill(ObClient *self);
 437
 438 /*! Sends the window to the specified desktop
 439   @param donthide If TRUE, the window will not be shown/hidden after its
 440          desktop has been changed. Generally this should be FALSE. */
 441 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
 442
 443 /*! Validate client, by making sure no Destroy or Unmap events exist in
 444   the event queue for the window.
 445   @return true if the client is valid; false if the client has already
 446           been unmapped/destroyed, and so is invalid.
 447 */
 448 gboolean client_validate(ObClient *self);
 449
 450 /*! Sets the wm_state to the specified value */
 451 void client_set_wm_state(ObClient *self, glong state);
 452
 453 /*! Adjusts the window's net_state
 454   This should not be called as part of the window mapping process! It is for
 455   use when updating the state post-mapping.<br>
 456   client_apply_startup_state is used to do the same things during the mapping
 457   process.
 458 */
 459 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
 460
 461 /* Given a ObClient, find the client that focus would actually be sent to if
 462    you wanted to give focus to the specified ObClient. Will return the same
 463    ObClient passed to it or another ObClient if appropriate. */
 464 ObClient *client_focus_target(ObClient *self);
 465
 466 /*! Returns what client_focus would return if passed the same client, but
 467   without focusing it or modifying the focus order lists. */
 468 gboolean client_can_focus(ObClient *self);
 469
 470 /*! Attempt to focus the client window */
 471 gboolean client_focus(ObClient *self);
 472
 473 /*! Remove focus from the client window */
 474 void client_unfocus(ObClient *self);
 475
 476 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
 477   when the user deliberately selects a window for use.
 478   @param here If true, then the client is brought to the current desktop;
 479               otherwise, the desktop is changed to where the client lives.
 480   @param user If true, then a user action is what requested the activation;
 481               otherwise, it means an application requested it on its own
 482 */
 483 void client_activate(ObClient *self, gboolean here, gboolean user);
 484
 485 /*! Calculates the stacking layer for the client window */
 486 void client_calc_layer(ObClient *self);
 487
 488 /*! Raises the client to the top of its stacking layer
 489   Normally actions call to the client_* functions to make stuff go, but this
 490   one is an exception. It just fires off an action, which will be queued.
 491   This is because stacking order rules can be changed by focus state, and so
 492   any time focus changes you have to wait for it to complete before you can
 493   properly restart windows. As such, this only queues an action for later
 494   execution, once the focus change has gone through.
 495 */
 496 void client_raise(ObClient *self);
 497
 498 /*! Lowers the client to the bottom of its stacking layer
 499   Normally actions call to the client_* functions to make stuff go, but this
 500   one is an exception. It just fires off an action, which will be queued.
 501   This is because stacking order rules can be changed by focus state, and so
 502   any time focus changes you have to wait for it to complete before you can
 503   properly restart windows. As such, this only queues an action for later
 504   execution, once the focus change has gone through.
 505 */
 506 void client_lower(ObClient *self);
 507
 508 /*! Updates the window's transient status, and any parents of it */
 509 void client_update_transient_for(ObClient *self);
 510 /*! Update the protocols that the window supports and adjusts things if they
 511   change */
 512 void client_update_protocols(ObClient *self);
 513 /*! Updates the WMNormalHints and adjusts things if they change */
 514 void client_update_normal_hints(ObClient *self);
 515
 516 /*! Updates the WMHints and adjusts things if they change
 517   @param initstate Whether to read the initial_state property from the
 518                    WMHints. This should only be used during the mapping
 519                    process.
 520 */
 521 void client_update_wmhints(ObClient *self);
 522 /*! Updates the window's title and icon title */
 523 void client_update_title(ObClient *self);
 524 /*! Updates the window's application name and class */
 525 void client_update_class(ObClient *self);
 526 /*! Updates the strut for the client */
 527 void client_update_strut(ObClient *self);
 528 /*! Updates the window's icons */
 529 void client_update_icons(ObClient *self);
 530
 531 /*! Set up what decor should be shown on the window and what functions should
 532   be allowed (ObClient::decorations and ObClient::functions).
 533   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 534 */
 535 void client_setup_decor_and_functions(ObClient *self);
 536
 537 /*! Retrieves the window's type and sets ObClient->type */
 538 void client_get_type(ObClient *self);
 539
 540 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
 541
 542 /*! Searches a client's direct parents for a focused window. The function does
 543   not check for the passed client, only for *ONE LEVEL* of its parents.
 544   If no focused parentt is found, NULL is returned.
 545 */
 546 ObClient *client_search_focus_parent(ObClient *self);
 547
 548 /*! Searches a client's transients for a focused window. The function does not
 549   check for the passed client, only for its transients.
 550   If no focused transient is found, NULL is returned.
 551 */
 552 ObClient *client_search_focus_tree(ObClient *self);
 553
 554 /*! Searches a client's transient tree for a focused window. The function
 555   searches up the tree and down other branches as well as the passed client's.
 556   If no focused client is found, NULL is returned.
 557 */
 558 ObClient *client_search_focus_tree_full(ObClient *self);
 559
 560 /*! Return a modal child of the client window that can be focused.
 561     @return A modal child of the client window that can be focused, or 0 if
 562             none was found.
 563 */
 564 ObClient *client_search_modal_child(ObClient *self);
 565
 566 ObClient *client_search_top_transient(ObClient *self);
 567
 568 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
 569   returns the searched for parent if it is a parent, or NULL if not. */
 570 ObClient *client_search_parent(ObClient *self, ObClient *search);
 571
 572 /*! Search for a transient of a client. The transient is returned if it is one,
 573   NULL is returned if the given search is not a transient of the client. */
 574 ObClient *client_search_transient(ObClient *self, ObClient *search);
 575
 576 /*! Return the "closest" client in the given direction */
 577 ObClient *client_find_directional(ObClient *c, ObDirection dir);
 578
 579 /*! Return the closest edge in the given direction */
 580 gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
 581
 582 /*! Set a client window to be above/below other clients.
 583   @layer < 0 indicates the client should be placed below other clients.<br>
 584          = 0 indicates the client should be placed with other clients.<br>
 585          > 0 indicates the client should be placed above other clients.
 586 */
 587 void client_set_layer(ObClient *self, gint layer);
 588
 589 /*! Set a client window to have decorations or not */
 590 void client_set_undecorated(ObClient *self, gboolean undecorated);
 591
 592 guint client_monitor(ObClient *self);
 593
 594 void client_update_sm_client_id(ObClient *self);
 595
 596 ObClient* client_under_pointer();
 597
 598 gboolean client_has_group_siblings(ObClient *self);
 599
 600 #endif