1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 client.h for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
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.
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.
17 See the COPYING file for a copy of the GNU General Public License.
27 #include "render/color.h"
34 struct _ObSessionState;
36 typedef struct _ObClient ObClient;
37 typedef struct _ObClientIcon ObClientIcon;
38 typedef struct _ObAppSettings ObAppSettings;
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)
44 /*! Holds an icon in ARGB format */
52 /*! Possible window types */
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 */
65 /*! The things the user can do to the client window */
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 */
83 /*! The window's decorations. NULL while the window is being managed! */
84 struct _ObFrame *frame;
86 /*! The number of unmap events to ignore on the window */
89 /*! The id of the group the window belongs to */
90 struct _ObGroup *group;
92 /*! Saved session data to apply to this client */
93 struct _ObSessionState *session;
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. */
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
104 ObClient *transient_for;
105 /*! The clients which are transients (children) of this client */
107 /*! The desktop on which the window resides (0xffffffff for all
111 /*! The startup id for the startup-notification protocol. This will be
112 NULL if a startup id is not set. */
115 /*! Normal window title */
117 /*! Window title when iconified */
120 /*! The application that created the window */
122 /*! The class of the window, can used for grouping */
124 /*! The specified role of the window, used for identification */
126 /*! The session client id for the window. *This can be NULL!* */
129 /*! The type of window (what its function is) */
132 /*! Position and size of the window
133 This will not always be the actual position of the window on screen, it
134 is, rather, the position requested by the client, to which the window's
139 /*! Position of the client window relative to the root window */
142 /*! Position and size of the window prior to being maximized */
144 /*! Position and size of the window prior to being fullscreened */
145 Rect pre_fullscreen_area;
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.
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.
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.
167 /*! The minimum aspect ratio the client window can be sized to.
168 A value of 0 means this is ignored.
171 /*! The maximum aspect ratio the client window can be sized to.
172 A value of 0 means this is ignored.
176 /*! The minimum size of the client window
177 If the min is > the max, then the window is not resizable
180 /*! The maximum size of the client window
181 If the min is > the max, then the window is not resizable
184 /*! The size of increments to resize the client window by */
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
192 /*! Window decoration and functionality hints */
195 /*! Where to place the decorated window in relation to the undecorated
199 /*! The state of the window, one of WithdrawnState, IconicState, or
203 /*! True if the client supports the delete_window protocol */
204 gboolean delete_window;
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 */
212 /*! Can the window receive input focus? */
214 /*! Notify the window when it receives focus? */
215 gboolean focus_notify;
217 /*! The window uses shape extension to be non-rectangular? */
220 /*! The window is modal, so it must be processed before any windows it is
221 related to can be focused */
223 /*! Only the window's titlebar is displayed */
225 /*! The window is iconified */
227 /*! The window is maximized to fill the screen vertically */
229 /*! The window is maximized to fill the screen horizontally */
231 /*! The window should not be displayed by pagers */
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
238 /*! The window should be on top of other windows of the same type.
239 above takes priority over below. */
241 /*! The window should be underneath other windows of the same type.
242 above takes priority over below. */
244 /*! Demands attention flag */
245 gboolean demands_attention;
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;
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.
257 /*! A user option. When this is set to TRUE the client will not ever
260 gboolean undecorated;
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.
268 /*! Icons for the client as specified on the client window */
270 /*! The number of icons in icons */
276 struct _ObAppSettings
302 extern GList *client_list;
304 void client_startup(gboolean reconfig);
305 void client_shutdown(gboolean reconfig);
307 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
309 void client_add_destructor(ObClientDestructor func, gpointer data);
310 void client_remove_destructor(ObClientDestructor func);
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);
321 /*! Sets the client list on the root window from the client_list */
322 void client_set_list();
324 /*! Determines if the client should be shown or hidden currently.
325 @return TRUE if it should be visible; otherwise, FALSE.
327 gboolean client_should_show(ObClient *self);
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);
334 /* Returns if the window is focused */
335 gboolean client_focused(ObClient *self);
337 #define client_move(self, x, y) \
338 client_configure(self, OB_CORNER_TOPLEFT, x, y, \
339 self->area.width, self->area.height, \
341 #define client_resize(self, w, h) \
342 client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
344 #define client_move_resize(self, x, y, w, h) \
345 client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
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)
350 /*! Figure out where a window will end up and what size it will be if you
351 told it to move/resize to these coordinates.
353 These values are what client_configure_full will give the window.
355 @param anchor The corner to keep in the same position when resizing.
356 @param x The x coordiante of the new position for the client.
357 @param y The y coordiante of the new position for the client.
358 @param w The width component of the new size for the client.
359 @param h The height component of the new size for the client.
360 @param logicalw Returns the width component of the new logical width.
361 This value is only returned when the new w or h calculated
362 differ from the ones passed in.
363 @param logicalh Returns the height component of the new logical height.
364 This value is only returned when the new w or h calculated
365 differ from the ones passed in.
366 @param user Specifies whether this is a user-requested change or a
367 program requested change. For program requested changes, the
368 constraints are not checked.
370 void client_try_configure(ObClient *self, ObCorner anchor,
371 gint *x, gint *y, gint *w, gint *h,
372 gint *logicalw, gint *logicalh,
375 /*! Move and/or resize the window.
376 This also maintains things like the client's minsize, and size increments.
377 @param anchor The corner to keep in the same position when resizing.
378 @param x The x coordiante of the new position for the client.
379 @param y The y coordiante of the new position for the client.
380 @param w The width component of the new size for the client.
381 @param h The height component of the new size for the client.
382 @param user Specifies whether this is a user-requested change or a
383 program requested change. For program requested changes, the
384 constraints are not checked.
385 @param final If user is true, then this should specify if this is a final
386 configuration. e.g. Final should be FALSE if doing an
387 interactive move/resize, and then be TRUE for the last call
389 @param force_reply Send a ConfigureNotify to the client regardless of if
390 the position changed.
392 void client_configure_full(ObClient *self, ObCorner anchor,
393 gint x, gint y, gint w, gint h,
394 gboolean user, gboolean final,
395 gboolean force_reply);
397 void client_reconfigure(ObClient *self);
399 /*! Finds coordinates to keep a client on the screen.
400 @param self The client
401 @param x The x coord of the client, may be changed.
402 @param y The y coord of the client, may be changed.
403 @param w The width of the client.
404 @param w The height of the client.
405 @param rude Be rude about it. If false, it is only moved if it is entirely
406 not visible. If true, then make sure the window is inside the
408 @return true if the client was moved to be on-screen; false if not.
410 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
413 /*! Moves a client so that it is on screen if it is entirely out of the
415 @param self The client to move
416 @param rude Be rude about it. If false, it is only moved if it is entirely
417 not visible. If true, then make sure the window is inside the
420 void client_move_onscreen(ObClient *self, gboolean rude);
422 /*! Fullscreen's or unfullscreen's the client window
423 @param fs true if the window should be made fullscreen; false if it should
424 be returned to normal state.
426 void client_fullscreen(ObClient *self, gboolean fs);
428 /*! Iconifies or uniconifies the client window
429 @param iconic true if the window should be iconified; false if it should be
431 @param curdesk If iconic is FALSE, then this determines if the window will
432 be uniconified to the current viewable desktop (true) or to
433 its previous desktop (false)
435 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
437 /*! Maximize or unmaximize the client window
438 @param max true if the window should be maximized; false if it should be
439 returned to normal size.
440 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
442 void client_maximize(ObClient *self, gboolean max, gint dir);
444 /*! Shades or unshades the client window
445 @param shade true if the window should be shaded; false if it should be
448 void client_shade(ObClient *self, gboolean shade);
450 /*! Hilite the window to make the user notice it */
451 void client_hilite(ObClient *self, gboolean hilite);
453 /*! Request the client to close its window */
454 void client_close(ObClient *self);
456 /*! Kill the client off violently */
457 void client_kill(ObClient *self);
459 /*! Sends the window to the specified desktop
460 @param donthide If TRUE, the window will not be shown/hidden after its
461 desktop has been changed. Generally this should be FALSE. */
462 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
464 /*! Show the client if it should be shown. */
465 void client_show(ObClient *self);
467 /*! Show the client if it should be shown. */
468 void client_hide(ObClient *self);
470 /*! Show the client if it should be shown, and hide it if it should be
471 hidden. This is for example, when switching desktops.
473 void client_showhide(ObClient *self);
475 /*! Validate client, by making sure no Destroy or Unmap events exist in
476 the event queue for the window.
477 @return true if the client is valid; false if the client has already
478 been unmapped/destroyed, and so is invalid.
480 gboolean client_validate(ObClient *self);
482 /*! Sets the wm_state to the specified value */
483 void client_set_wm_state(ObClient *self, glong state);
485 /*! Adjusts the window's net_state
486 This should not be called as part of the window mapping process! It is for
487 use when updating the state post-mapping.<br>
488 client_apply_startup_state is used to do the same things during the mapping
491 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
493 /* Given a ObClient, find the client that focus would actually be sent to if
494 you wanted to give focus to the specified ObClient. Will return the same
495 ObClient passed to it or another ObClient if appropriate. */
496 ObClient *client_focus_target(ObClient *self);
498 /*! Returns what client_focus would return if passed the same client, but
499 without focusing it or modifying the focus order lists. */
500 gboolean client_can_focus(ObClient *self);
502 /*! Attempt to focus the client window
503 NOTE: You should validate the client before calling this !! (client_validate)
505 gboolean client_focus(ObClient *self);
507 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
508 when the user deliberately selects a window for use.
509 @param here If true, then the client is brought to the current desktop;
510 otherwise, the desktop is changed to where the client lives.
511 @param user If true, then a user action is what requested the activation;
512 otherwise, it means an application requested it on its own
514 void client_activate(ObClient *self, gboolean here, gboolean user);
516 /*! Calculates the stacking layer for the client window */
517 void client_calc_layer(ObClient *self);
519 /*! Raises the client to the top of its stacking layer
520 Normally actions call to the client_* functions to make stuff go, but this
521 one is an exception. It just fires off an action, which will be queued.
522 This is because stacking order rules can be changed by focus state, and so
523 any time focus changes you have to wait for it to complete before you can
524 properly restart windows. As such, this only queues an action for later
525 execution, once the focus change has gone through.
527 void client_raise(ObClient *self);
529 /*! Lowers the client to the bottom of its stacking layer
530 Normally actions call to the client_* functions to make stuff go, but this
531 one is an exception. It just fires off an action, which will be queued.
532 This is because stacking order rules can be changed by focus state, and so
533 any time focus changes you have to wait for it to complete before you can
534 properly restart windows. As such, this only queues an action for later
535 execution, once the focus change has gone through.
537 void client_lower(ObClient *self);
539 /*! Updates the window's transient status, and any parents of it */
540 void client_update_transient_for(ObClient *self);
541 /*! Update the protocols that the window supports and adjusts things if they
543 void client_update_protocols(ObClient *self);
544 /*! Updates the WMNormalHints and adjusts things if they change */
545 void client_update_normal_hints(ObClient *self);
547 /*! Updates the WMHints and adjusts things if they change
548 @param initstate Whether to read the initial_state property from the
549 WMHints. This should only be used during the mapping
552 void client_update_wmhints(ObClient *self);
553 /*! Updates the window's title and icon title */
554 void client_update_title(ObClient *self);
555 /*! Updates the window's application name and class */
556 void client_update_class(ObClient *self);
557 /*! Updates the strut for the client */
558 void client_update_strut(ObClient *self);
559 /*! Updates the window's icons */
560 void client_update_icons(ObClient *self);
561 /*! Updates the window's user time */
562 void client_update_user_time(ObClient *self);
564 /*! Set up what decor should be shown on the window and what functions should
565 be allowed (ObClient::decorations and ObClient::functions).
566 This also updates the NET_WM_ALLOWED_ACTIONS hint.
568 void client_setup_decor_and_functions(ObClient *self);
570 /*! Retrieves the window's type and sets ObClient->type */
571 void client_get_type(ObClient *self);
573 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
575 /*! Searches a client's direct parents for a focused window. The function does
576 not check for the passed client, only for *ONE LEVEL* of its parents.
577 If no focused parentt is found, NULL is returned.
579 ObClient *client_search_focus_parent(ObClient *self);
581 /*! Searches a client's transients for a focused window. The function does not
582 check for the passed client, only for its transients.
583 If no focused transient is found, NULL is returned.
585 ObClient *client_search_focus_tree(ObClient *self);
587 /*! Searches a client's transient tree for a focused window. The function
588 searches up the tree and down other branches as well as the passed client's.
589 If no focused client is found, NULL is returned.
591 ObClient *client_search_focus_tree_full(ObClient *self);
593 /*! Return a modal child of the client window that can be focused.
594 @return A modal child of the client window that can be focused, or 0 if
597 ObClient *client_search_modal_child(ObClient *self);
599 /*! Returns a list of top-level windows which this is a transient for.
600 It will only contain more than 1 element if the client is transient for its
603 GSList *client_search_all_top_parents(ObClient *self);
605 /*! Returns a window's top level parent. This only counts direct parents,
606 not groups if it is transient for its group.
608 ObClient *client_search_top_parent(ObClient *self);
610 /*! Is one client a direct child of another (i.e. not through the group.) */
611 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
613 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
614 returns the searched for parent if it is a parent, or NULL if not. */
615 ObClient *client_search_parent(ObClient *self, ObClient *search);
617 /*! Search for a transient of a client. The transient is returned if it is one,
618 NULL is returned if the given search is not a transient of the client. */
619 ObClient *client_search_transient(ObClient *self, ObClient *search);
621 /*! Return the "closest" client in the given direction */
622 ObClient *client_find_directional(ObClient *c, ObDirection dir);
624 /*! Return the closest edge in the given direction */
625 gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
627 /*! Set a client window to be above/below other clients.
628 @layer < 0 indicates the client should be placed below other clients.<br>
629 = 0 indicates the client should be placed with other clients.<br>
630 > 0 indicates the client should be placed above other clients.
632 void client_set_layer(ObClient *self, gint layer);
634 /*! Set a client window to have decorations or not */
635 void client_set_undecorated(ObClient *self, gboolean undecorated);
637 guint client_monitor(ObClient *self);
639 void client_update_sm_client_id(ObClient *self);
641 ObClient* client_under_pointer();
643 gboolean client_has_group_siblings(ObClient *self);