openbox/client.h

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