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