openbox/client.h

   1 #ifndef __client_h
   2 #define __client_h
   3
   4 #include "geom.h"
   5 #include "stacking.h"
   6 #include "render/color.h"
   7
   8 #include <glib.h>
   9 #include <X11/Xlib.h>
  10
  11 struct Frame;
  12 struct Group;
  13
  14 /* The value in client.transient_for indicating it is a transient for its
  15    group instead of for a single window */
  16 #define TRAN_GROUP ((void*)~0l)
  17
  18 /*! Holds an icon in ARGB format */
  19 typedef struct Icon {
  20     int width, height;
  21     pixel32 *data;
  22 } Icon;
  23
  24 /*! The MWM Hints as retrieved from the window property
  25   This structure only contains 3 elements, even though the Motif 2.0
  26   structure contains 5. We only use the first 3, so that is all gets
  27   defined.
  28 */
  29 typedef struct MwmHints {
  30     /*! A bitmask of Client::MwmFlags values */
  31     unsigned long flags;
  32     /*! A bitmask of Client::MwmFunctions values */
  33     unsigned long functions;
  34     /*! A bitmask of Client::MwmDecorations values */
  35     unsigned long decorations;
  36 } MwmHints;
  37 /*! The number of elements in the Client::MwmHints struct */
  38 #define MWM_ELEMENTS 3
  39
  40 /*! Possible flags for MWM Hints (defined by Motif 2.0) */
  41 typedef enum {
  42     MwmFlag_Functions   = 1 << 0, /*!< The MMW Hints define funcs */
  43     MwmFlag_Decorations = 1 << 1  /*!< The MWM Hints define decor */
  44 } MwmFlags;
  45
  46 /*! Possible functions for MWM Hints (defined by Motif 2.0) */
  47 typedef enum {
  48     MwmFunc_All      = 1 << 0, /*!< All functions */
  49     MwmFunc_Resize   = 1 << 1, /*!< Allow resizing */
  50     MwmFunc_Move     = 1 << 2, /*!< Allow moving */
  51     MwmFunc_Iconify  = 1 << 3, /*!< Allow to be iconfied */
  52     MwmFunc_Maximize = 1 << 4  /*!< Allow to be maximized */
  53     /*MwmFunc_Close    = 1 << 5 /!< Allow to be closed */
  54 } MwmFunctions;
  55
  56 /*! Possible decorations for MWM Hints (defined by Motif 2.0) */
  57 typedef enum {
  58     MwmDecor_All      = 1 << 0, /*!< All decorations */
  59     MwmDecor_Border   = 1 << 1, /*!< Show a border */
  60     MwmDecor_Handle   = 1 << 2, /*!< Show a handle (bottom) */
  61     MwmDecor_Title    = 1 << 3, /*!< Show a titlebar */
  62     /*MwmDecor_Menu     = 1 << 4, /!< Show a menu */
  63     MwmDecor_Iconify  = 1 << 5, /*!< Show an iconify button */
  64     MwmDecor_Maximize = 1 << 6  /*!< Show a maximize button */
  65 } MemDecorations;
  66
  67 /*! Corners of the client window, used for anchor positions */
  68 typedef enum {
  69     Corner_TopLeft,
  70     Corner_TopRight,
  71     Corner_BottomLeft,
  72     Corner_BottomRight
  73 } Corner;
  74
  75 /*! Possible window types */
  76 typedef enum {
  77     Type_Desktop, /*!< A desktop (bottom-most window) */
  78     Type_Dock,    /*!< A dock bar/panel window */
  79     Type_Toolbar, /*!< A toolbar window, pulled off an app */
  80     Type_Menu,    /*!< An unpinned menu from an app */
  81     Type_Utility, /*!< A small utility window such as a palette */
  82     Type_Splash,  /*!< A splash screen window */
  83     Type_Dialog,  /*!< A dialog window */
  84     Type_Normal   /*!< A normal application window */
  85 } WindowType;
  86
  87 /*! The things the user can do to the client window */
  88 typedef enum {
  89     Func_Resize     = 1 << 0, /*!< Allow resizing */
  90     Func_Move       = 1 << 1, /*!< Allow moving */
  91     Func_Iconify    = 1 << 2, /*!< Allow to be iconified */
  92     Func_Maximize   = 1 << 3, /*!< Allow to be maximized */
  93     Func_Shade      = 1 << 4, /*!< Allow to be shaded */
  94     Func_Fullscreen = 1 << 5, /*!< Allow to be made fullscreen */
  95     Func_Close      = 1 << 6  /*!< Allow to be closed */
  96 } Function;
  97
  98 /*! The decorations the client window wants to be displayed on it */
  99 typedef enum {
 100     Decor_Titlebar    = 1 << 0, /*!< Display a titlebar */
 101     Decor_Handle      = 1 << 1, /*!< Display a handle (bottom) */
 102     Decor_Border      = 1 << 2, /*!< Display a border */
 103     Decor_Icon        = 1 << 3, /*!< Display the window's icon */
 104     Decor_Iconify     = 1 << 4, /*!< Display an iconify button */
 105     Decor_Maximize    = 1 << 5, /*!< Display a maximize button */
 106     /*! Display a button to toggle the window's placement on
 107       all desktops */
 108     Decor_AllDesktops = 1 << 6,
 109     Decor_Shade       = 1 << 7, /*!< Displays a shade button */
 110     Decor_Close       = 1 << 8  /*!< Display a close button */
 111 } Decoration;
 112
 113
 114 typedef struct Client {
 115     ObWindow obwin;
 116
 117     Window  window;
 118
 119     /*! The window's decorations. NULL while the window is being managed! */
 120     struct Frame *frame;
 121
 122     /*! The number of unmap events to ignore on the window */
 123     int ignore_unmaps;
 124
 125     /*! The id of the group the window belongs to */
 126     struct Group *group;
 127     /*! Whether or not the client is a transient window. This is guaranteed to
 128       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
 129       transient_for == NULL. */
 130     gboolean transient;
 131     /*! The client which this client is a transient (child) for.
 132       A value of TRAN_GROUP signifies that the window is a transient for all
 133       members of its Group, and is not a valid pointer to be followed in this
 134       case.
 135      */
 136     struct Client *transient_for;
 137     /*! The clients which are transients (children) of this client */
 138     GSList *transients;
 139     /*! The desktop on which the window resides (0xffffffff for all
 140       desktops) */
 141     guint desktop;
 142
 143     /*! Normal window title */
 144     gchar *title;
 145     /*! The count for the title. When another window with the same title
 146       exists, a count will be appended to it. */
 147     guint title_count;
 148     /*! Window title when iconified */
 149     gchar *icon_title;
 150
 151     /*! The application that created the window */
 152     gchar *name;
 153     /*! The class of the window, can used for grouping */
 154     gchar *class;
 155     /*! The specified role of the window, used for identification */
 156     gchar *role;
 157
 158     /*! The type of window (what its function is) */
 159     WindowType type;
 160
 161     /*! Position and size of the window
 162       This will not always be the actual position of the window on screen, it
 163       is, rather, the position requested by the client, to which the window's
 164       gravity is applied.
 165     */
 166     Rect    area;
 167
 168     /*! The window's strut
 169       The strut defines areas of the screen that are marked off-bounds for
 170       window placement. In theory, where this window exists.
 171     */
 172     Strut   strut;
 173
 174     /*! The logical size of the window
 175       The "logical" size of the window is refers to the user's perception of
 176       the size of the window, and is the value that should be displayed to the
 177       user. For example, with xterms, this value it the number of characters
 178       being displayed in the terminal, instead of the number of pixels.
 179     */
 180     Size   logical_size;
 181
 182     /*! Width of the border on the window.
 183       The window manager will set this to 0 while the window is being managed,
 184       but needs to restore it afterwards, so it is saved here.
 185     */
 186     guint border_width;
 187
 188     /*! The minimum aspect ratio the client window can be sized to.
 189       A value of 0 means this is ignored.
 190     */
 191     float min_ratio;
 192     /*! The maximum aspect ratio the client window can be sized to.
 193       A value of 0 means this is ignored.
 194     */
 195     float max_ratio;
 196
 197     /*! The minimum size of the client window
 198       If the min is > the max, then the window is not resizable
 199     */
 200     Size min_size;
 201     /*! The maximum size of the client window
 202       If the min is > the max, then the window is not resizable
 203     */
 204     Size max_size;
 205     /*! The size of increments to resize the client window by */
 206     Size size_inc;
 207     /*! The base size of the client window
 208       This value should be subtracted from the window's actual size when
 209       displaying its size to the user, or working with its min/max size
 210     */
 211     Size base_size;
 212
 213     /*! Window decoration and functionality hints */
 214     MwmHints mwmhints;
 215
 216     /*! Where to place the decorated window in relation to the undecorated
 217       window */
 218     int gravity;
 219
 220     /*! The state of the window, one of WithdrawnState, IconicState, or
 221       NormalState */
 222     long wmstate;
 223
 224     /*! True if the client supports the delete_window protocol */
 225     gboolean delete_window;
 226
 227     /*! Was the window's position requested by the application? if not, we
 228       should place the window ourselves when it first appears */
 229     gboolean positioned;
 230
 231     /*! Can the window receive input focus? */
 232     gboolean can_focus;
 233     /*! Urgency flag */
 234     gboolean urgent;
 235     /*! Notify the window when it receives focus? */
 236     gboolean focus_notify;
 237
 238     /*! The window uses shape extension to be non-rectangular? */
 239     gboolean shaped;
 240
 241     /*! The window is modal, so it must be processed before any windows it is
 242       related to can be focused */
 243     gboolean modal;
 244     /*! Only the window's titlebar is displayed */
 245     gboolean shaded;
 246     /*! The window is iconified */
 247     gboolean iconic;
 248     /*! The window is maximized to fill the screen vertically */
 249     gboolean max_vert;
 250     /*! The window is maximized to fill the screen horizontally */
 251     gboolean max_horz;
 252     /*! The window should not be displayed by pagers */
 253     gboolean skip_pager;
 254     /*! The window should not be displayed by taskbars */
 255     gboolean skip_taskbar;
 256     /*! The window is a 'fullscreen' window, and should be on top of all
 257       others */
 258     gboolean fullscreen;
 259     /*! The window should be on top of other windows of the same type.
 260       above takes priority over below. */
 261     gboolean above;
 262     /*! The window should be underneath other windows of the same type.
 263       above takes priority over below. */
 264     gboolean below;
 265
 266     /*! The layer in which the window will be stacked, windows in lower layers
 267       are always below windows in higher layers. */
 268     StackLayer layer;
 269
 270     /*! A bitmask of values in the Decoration enum
 271       The values in the variable are the decorations that the client wants to
 272       be displayed around it.
 273     */
 274     int decorations;
 275
 276     /*! A bitmask of values in the Decoration enum.
 277       Specifies the decorations that should NOT be displayed on the client.
 278     */
 279     int disabled_decorations;
 280
 281     /*! A bitmask of values in the Function enum
 282       The values in the variable specify the ways in which the user is allowed
 283       to modify this window.
 284     */
 285     int functions;
 286
 287     /*! Icons for the client as specified on the client window */
 288     Icon *icons;
 289     /*! The number of icons in icons */
 290     int nicons;
 291 } Client;
 292
 293 extern GList *client_list;
 294
 295 void client_startup();
 296 void client_shutdown();
 297
 298 /*! Manages all existing windows */
 299 void client_manage_all();
 300 /*! Manages a given window */
 301 void client_manage(Window win);
 302 /*! Unmanages all managed windows */
 303 void client_unmanage_all();
 304 /*! Unmanages a given client */
 305 void client_unmanage(Client *client);
 306
 307 /*! Sets the client list on the root window from the client_list */
 308 void client_set_list();
 309
 310 /*! Reapplies the maximized state to the window
 311   Use this to make the window readjust its maximized size to new
 312   surroundings (struts, etc). */
 313 void client_remaximize(Client *self);
 314
 315 /*! Determines if the client should be shown or hidden currently.
 316   @return TRUE if it should be visible; otherwise, FALSE.
 317 */
 318 gboolean client_should_show(Client *self);
 319
 320 /*! Returns if the window should be treated as a normal window.
 321   Some windows (desktops, docks, splash screens) have special rules applied
 322   to them in a number of places regarding focus or user interaction. */
 323 gboolean client_normal(Client *self);
 324
 325 /* Returns if the window is focused */
 326 gboolean client_focused(Client *self);
 327
 328 /*! Move and/or resize the window.
 329   This also maintains things like the client's minsize, and size increments.
 330   @param anchor The corner to keep in the same position when resizing.
 331   @param x The x coordiante of the new position for the client.
 332   @param y The y coordiante of the new position for the client.
 333   @param w The width component of the new size for the client.
 334   @param h The height component of the new size for the client.
 335   @param user Specifies whether this is a user-requested change or a
 336               program requested change. For program requested changes, the
 337               constraints are not checked.
 338   @param final If user is true, then this should specify if this is a final
 339                configuration. e.g. Final should be FALSE if doing an
 340                interactive move/resize, and then be TRUE for the last call
 341                only.
 342 */
 343 void client_configure(Client *self, Corner anchor, int x, int y, int w, int h,
 344                       gboolean user, gboolean final);
 345
 346 /*! Moves a client so that it is on screen if it is entirely out of the
 347   viewable screen.
 348 */
 349 void client_move_onscreen(Client *self);
 350
 351 /*! Fullscreen's or unfullscreen's the client window
 352   @param fs true if the window should be made fullscreen; false if it should
 353             be returned to normal state.
 354   @param savearea true to have the client's current size and position saved;
 355                   otherwise, they are not. You should not save when mapping a
 356                   new window that is set to fullscreen. This has no effect
 357                   when restoring a window from fullscreen.
 358 */
 359 void client_fullscreen(Client *self, gboolean fs, gboolean savearea);
 360
 361 /*! Iconifies or uniconifies the client window
 362   @param iconic true if the window should be iconified; false if it should be
 363                 restored.
 364   @param curdesk If iconic is FALSE, then this determines if the window will
 365                  be uniconified to the current viewable desktop (true) or to
 366                  its previous desktop (false)
 367 */
 368 void client_iconify(Client *self, gboolean iconic, gboolean curdesk);
 369
 370 /*! Maximize or unmaximize the client window
 371   @param max true if the window should be maximized; false if it should be
 372              returned to normal size.
 373   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
 374   @param savearea true to have the client's current size and position saved;
 375                   otherwise, they are not. You should not save when mapping a
 376                   new window that is set to fullscreen. This has no effect
 377                   when unmaximizing a window.
 378 */
 379 void client_maximize(Client *self, gboolean max, int dir,
 380                      gboolean savearea);
 381
 382 /*! Shades or unshades the client window
 383   @param shade true if the window should be shaded; false if it should be
 384                unshaded.
 385 */
 386 void client_shade(Client *self, gboolean shade);
 387
 388 /*! Request the client to close its window */
 389 void client_close(Client *self);
 390
 391 /*! Kill the client off violently */
 392 void client_kill(Client *self);
 393
 394 /*! Sends the window to the specified desktop
 395   @param donthide If TRUE, the window will not be shown/hidden after its
 396          desktop has been changed. Generally this should be FALSE. */
 397 void client_set_desktop(Client *self, guint target, gboolean donthide);
 398
 399 /*! Validate client, by making sure no Destroy or Unmap events exist in
 400   the event queue for the window.
 401   @return true if the client is valid; false if the client has already
 402           been unmapped/destroyed, and so is invalid.
 403 */
 404 gboolean client_validate(Client *self);
 405
 406 /*! Sets the wm_state to the specified value */
 407 void client_set_wm_state(Client *self, long state);
 408
 409 /*! Adjusts the window's net_state
 410   This should not be called as part of the window mapping process! It is for
 411   use when updating the state post-mapping.<br>
 412   client_apply_startup_state is used to do the same things during the mapping
 413   process.
 414 */
 415 void client_set_state(Client *self, Atom action, long data1, long data2);
 416
 417 /* Given a Client, find the client that focus would actually be sent to if
 418    you wanted to give focus to the specified Client. Will return the same
 419    Client passed to it or another Client if appropriate. */
 420 Client *client_focus_target(Client *self);
 421
 422 /*! Attempt to focus the client window */
 423 gboolean client_focus(Client *self);
 424
 425 /*! Remove focus from the client window */
 426 void client_unfocus(Client *self);
 427
 428 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
 429   when the user deliberately selects a window for use. */
 430 void client_activate(Client *self);
 431
 432 /*! Calculates the stacking layer for the client window */
 433 void client_calc_layer(Client *self);
 434
 435 /*! Updates the window's transient status, and any parents of it */
 436 void client_update_transient_for(Client *self);
 437 /*! Update the protocols that the window supports and adjusts things if they
 438   change */
 439 void client_update_protocols(Client *self);
 440 /*! Updates the WMNormalHints and adjusts things if they change */
 441 void client_update_normal_hints(Client *self);
 442
 443 /*! Updates the WMHints and adjusts things if they change
 444   @param initstate Whether to read the initial_state property from the
 445                    WMHints. This should only be used during the mapping
 446                    process.
 447 */
 448 void client_update_wmhints(Client *self);
 449 /*! Updates the window's title and icon title */
 450 void client_update_title(Client *self);
 451 /*! Updates the window's application name and class */
 452 void client_update_class(Client *self);
 453 /*! Updates the strut for the client */
 454 void client_update_strut(Client *self);
 455 /*! Updates the window's icons */
 456 void client_update_icons(Client *self);
 457
 458 /*! Set up what decor should be shown on the window and what functions should
 459   be allowed (Client::decorations and Client::functions).
 460   This also updates the NET_WM_ALLOWED_ACTIONS hint.
 461 */
 462 void client_setup_decor_and_functions(Client *self);
 463
 464 /*! Retrieves the window's type and sets Client->type */
 465 void client_get_type(Client *self);
 466
 467 Icon *client_icon(Client *self, int w, int h);
 468
 469 /*! Searches a client's transients for a focused window. The function does not
 470   check for the passed client, only for its transients.
 471   If no focused transient is found, NULL is returned.
 472 */
 473 Client *client_search_focus_tree(Client *self);
 474
 475 /*! Searches a client's transient tree for a focused window. The function
 476   searches up the tree and down other branches as well as the passed client's.
 477   If no focused client is found, NULL is returned.
 478 */
 479 Client *client_search_focus_tree_full(Client *self);
 480
 481 /*! Return a modal child of the client window
 482     @return A modal child of the client window, or 0 if none was found.
 483 */
 484 Client *client_search_modal_child(Client *self);
 485
 486 #endif