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
;
39 /*! Holds an icon in ARGB format */
47 /*! Possible window types */
50 OB_CLIENT_TYPE_DESKTOP
, /*!< A desktop (bottom-most window) */
51 OB_CLIENT_TYPE_DOCK
, /*!< A dock bar/panel window */
52 OB_CLIENT_TYPE_TOOLBAR
, /*!< A toolbar window, pulled off an app */
53 OB_CLIENT_TYPE_MENU
, /*!< An unpinned menu from an app */
54 OB_CLIENT_TYPE_UTILITY
, /*!< A small utility window such as a palette */
55 OB_CLIENT_TYPE_SPLASH
, /*!< A splash screen window */
56 OB_CLIENT_TYPE_DIALOG
, /*!< A dialog window */
57 OB_CLIENT_TYPE_NORMAL
/*!< A normal application window */
60 /*! The things the user can do to the client window */
63 OB_CLIENT_FUNC_RESIZE
= 1 << 0, /*!< Allow user resizing */
64 OB_CLIENT_FUNC_MOVE
= 1 << 1, /*!< Allow user moving */
65 OB_CLIENT_FUNC_ICONIFY
= 1 << 2, /*!< Allow to be iconified */
66 OB_CLIENT_FUNC_MAXIMIZE
= 1 << 3, /*!< Allow to be maximized */
67 OB_CLIENT_FUNC_SHADE
= 1 << 4, /*!< Allow to be shaded */
68 OB_CLIENT_FUNC_FULLSCREEN
= 1 << 5, /*!< Allow to be made fullscreen */
69 OB_CLIENT_FUNC_CLOSE
= 1 << 6, /*!< Allow to be closed */
70 OB_CLIENT_FUNC_ABOVE
= 1 << 7, /*!< Allow to be put in lower layer */
71 OB_CLIENT_FUNC_BELOW
= 1 << 8, /*!< Allow to be put in higher layer */
72 OB_CLIENT_FUNC_UNDECORATE
= 1 << 9 /*!< Allow to be undecorated */
80 /*! The window's decorations. NULL while the window is being managed! */
81 struct _ObFrame
*frame
;
83 /*! The number of unmap events to ignore on the window */
86 /*! The id of the group the window belongs to */
87 struct _ObGroup
*group
;
89 /*! Saved session data to apply to this client */
90 struct _ObSessionState
*session
;
92 /*! Whether or not the client is a transient window. It may or may not
93 have parents when this is true. */
95 /*! Whether or not the client is transient for its group */
96 gboolean transient_for_group
;
97 /*! The client which are parents of this client */
99 /*! The clients which are transients (children) of this client */
101 /*! The desktop on which the window resides (0xffffffff for all
105 /*! The startup id for the startup-notification protocol. This will be
106 NULL if a startup id is not set. */
109 /*! Normal window title */
111 /*! Window title when iconified */
113 /*! Hostname of machine running the client */
114 gchar
*client_machine
;
115 /*! The command used to run the program. Pre-XSMP window identification. */
118 /*! The application that created the window */
120 /*! The class of the window, can used for grouping */
122 /*! The specified role of the window, used for identification */
124 /*! The session client id for the window. *This can be NULL!* */
127 /*! The type of window (what its function is) */
130 /*! Position and size of the window
131 This will not always be the actual position of the window on screen, it
132 is, rather, the position requested by the client, to which the window's
137 /*! Position of the client window relative to the root window */
140 /*! Position and size of the window prior to being maximized */
142 /*! Position and size of the window prior to being fullscreened */
143 Rect pre_fullscreen_area
;
145 /*! The window's strut
146 The strut defines areas of the screen that are marked off-bounds for
147 window placement. In theory, where this window exists.
151 /*! The logical size of the window
152 The "logical" size of the window is refers to the user's perception of
153 the size of the window, and is the value that should be displayed to the
154 user. For example, with xterms, this value it the number of characters
155 being displayed in the terminal, instead of the number of pixels.
159 /*! Width of the border on the window.
160 The window manager will set this to 0 while the window is being managed,
161 but needs to restore it afterwards, so it is saved here.
165 /*! The minimum aspect ratio the client window can be sized to.
166 A value of 0 means this is ignored.
169 /*! The maximum aspect ratio the client window can be sized to.
170 A value of 0 means this is ignored.
174 /*! The minimum size of the client window
175 If the min is > the max, then the window is not resizable
178 /*! The maximum size of the client window
179 If the min is > the max, then the window is not resizable
182 /*! The size of increments to resize the client window by */
184 /*! The base size of the client window
185 This value should be subtracted from the window's actual size when
186 displaying its size to the user, or working with its min/max size
190 /*! Window decoration and functionality hints */
193 /*! The client's specified colormap */
196 /*! Where to place the decorated window in relation to the undecorated
200 /*! The state of the window, one of WithdrawnState, IconicState, or
204 /*! True if the client supports the delete_window protocol */
205 gboolean delete_window
;
207 /*! Was the window's position requested by the application or the user?
208 if by the application, we force it completely onscreen, if by the user
209 we only force it if it tries to go completely offscreen, if neither, we
210 should place the window ourselves when it first appears */
213 /*! Was the window's size requested by the application or the user?
214 If by the application we don't let it go outside the available area */
217 /*! Can the window receive input focus? */
219 /*! Notify the window when it receives focus? */
220 gboolean focus_notify
;
223 /*! The client wants to sync during resizes */
224 gboolean sync_request
;
225 /*! The XSync counter used for synchronizing during resizes */
226 guint32 sync_counter
;
227 /*! The value we're waiting for the counter to reach */
228 gulong sync_counter_value
;
231 /*! The window uses shape extension to be non-rectangular? */
234 /*! The window is modal, so it must be processed before any windows it is
235 related to can be focused */
237 /*! Only the window's titlebar is displayed */
239 /*! The window is iconified */
241 /*! The window is maximized to fill the screen vertically */
243 /*! The window is maximized to fill the screen horizontally */
245 /*! The window should not be displayed by pagers */
247 /*! The window should not be displayed by taskbars */
248 gboolean skip_taskbar
;
249 /*! The window is a 'fullscreen' window, and should be on top of all
252 /*! The window should be on top of other windows of the same type.
253 above takes priority over below. */
255 /*! The window should be underneath other windows of the same type.
256 above takes priority over below. */
258 /*! Demands attention flag */
259 gboolean demands_attention
;
261 /*! The urgent flag */
264 /*! The layer in which the window will be stacked, windows in lower layers
265 are always below windows in higher layers. */
266 ObStackingLayer layer
;
268 /*! A bitmask of values in the ObFrameDecorations enum
269 The values in the variable are the decorations that the client wants to
270 be displayed around it.
274 /*! A user option. When this is set to TRUE the client will not ever
277 gboolean undecorated
;
279 /*! A bitmask of values in the ObFunctions enum
280 The values in the variable specify the ways in which the user is allowed
281 to modify this window.
285 /*! Icons for the client as specified on the client window */
287 /*! The number of icons in icons */
290 /*! Where the window should iconify to/from */
294 extern GList
*client_list
;
296 void client_startup(gboolean reconfig
);
297 void client_shutdown(gboolean reconfig
);
299 typedef void (*ObClientCallback
)(ObClient
*client
, gpointer data
);
301 /* Callback functions */
303 /*! Get notified when the client is unmanaged */
304 void client_add_destroy_notify(ObClientCallback func
, gpointer data
);
305 void client_remove_destroy_notify(ObClientCallback func
);
307 /*! Manages all existing windows */
308 void client_manage_all();
309 /*! Manages a given window
311 void client_manage(Window win
);
312 /*! Unmanages all managed windows */
313 void client_unmanage_all();
314 /*! Unmanages a given client */
315 void client_unmanage(ObClient
*client
);
317 /*! This manages a window only so far as is needed to get it's decorations.
318 This is used when you want to determine a window's decorations before it
319 is mapped. Call client_fake_unmanage() with the returned client when you
321 ObClient
*client_fake_manage(Window win
);
322 /*! Free the stuff created by client_fake_manage() */
323 void client_fake_unmanage(ObClient
*self
);
325 /*! Sets the client list on the root window from the client_list */
326 void client_set_list();
328 /*! Determines if the client should be shown or hidden currently.
329 @return TRUE if it should be visible; otherwise, FALSE.
331 gboolean
client_should_show(ObClient
*self
);
333 /*! Returns if the window should be treated as a normal window.
334 Some windows (desktops, docks, splash screens) have special rules applied
335 to them in a number of places regarding focus or user interaction. */
336 gboolean
client_normal(ObClient
*self
);
338 /*! Returns if the window is one of an application's helper windows
339 (utilty, menu, etc) */
340 gboolean
client_helper(ObClient
*self
);
342 /*! Return if the client is a type which should be given focus from mouse
343 presses on the *client* window. This doesn't affect clicking on the
344 decorations. This doesn't count for focus cycling, different rules apply to
346 gboolean
client_mouse_focusable(ObClient
*self
);
348 /*! Return if the client is a type which should be given focus from the
349 mouse entering the window. This doesn't count for focus cycling, different
350 rules apply to that. */
351 gboolean
client_enter_focusable(ObClient
*self
);
353 /* Returns if the window is focused */
354 gboolean
client_focused(ObClient
*self
);
356 /*! When the client is resized but not moved, figure out the new position
357 for it based on its gravity:
358 http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
360 void client_gravity_resize_w(ObClient
*self
, gint
*x
, gint oldw
, gint neww
);
362 /*! When the client is resized but not moved, figure out the new position
363 for it based on its gravity:
364 http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
366 void client_gravity_resize_h(ObClient
*self
, gint
*y
, gint oldh
, gint newh
);
368 /*! Convert a position/size from a given gravity to the client's true gravity,
369 when the client is only resizing (the reference point doesn't move)
371 void client_convert_gravity_resize(ObClient
*self
, gint gravity
,
375 #define client_move(self, x, y) \
376 client_configure(self, x, y, self->area.width, self->area.height, TRUE, TRUE,\
378 #define client_resize(self, w, h) \
379 client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE, FALSE)
380 #define client_move_resize(self, x, y, w, h) \
381 client_configure(self, x, y, w, h, TRUE, TRUE, FALSE)
382 #define client_reconfigure(self, force) \
383 client_configure(self, ((ObClient*)self)->area.x, ((ObClient*)self)->area.y, \
384 ((ObClient*)self)->area.width, \
385 ((ObClient*)self)->area.height, FALSE, TRUE, force)
387 /*! Figure out where a window will end up and what size it will be if you
388 told it to move/resize to these coordinates.
390 These values are what client_configure will give the window.
392 @param x The x coordiante of the new position for the client.
393 @param y The y coordiante of the new position for the client.
394 @param w The width component of the new size for the client.
395 @param h The height component of the new size for the client.
396 @param logicalw Returns the width component of the new logical width.
397 This value is only returned when the new w or h calculated
398 differ from the ones passed in.
399 @param logicalh Returns the height component of the new logical height.
400 This value is only returned when the new w or h calculated
401 differ from the ones passed in.
402 @param user Specifies whether this is a user-requested change or a
403 program requested change. For program requested changes, the
404 constraints are not checked.
406 void client_try_configure(ObClient
*self
, gint
*x
, gint
*y
, gint
*w
, gint
*h
,
407 gint
*logicalw
, gint
*logicalh
,
410 /*! Move and/or resize the window.
411 This also maintains things like the client's minsize, and size increments.
412 @param x The x coordiante of the new position for the client.
413 @param y The y coordiante of the new position for the client.
414 @param w The width component of the new size for the client.
415 @param h The height component of the new size for the client.
416 @param user Specifies whether this is a user-requested change or a
417 program requested change. For program requested changes, the
418 constraints are not checked.
419 @param final If user is true, then this should specify if this is a final
420 configuration. e.g. Final should be FALSE if doing an
421 interactive move/resize, and then be TRUE for the last call
423 @param force_reply Send a ConfigureNotify to the client regardless of if
424 the position/size changed.
426 void client_configure(ObClient
*self
, gint x
, gint y
, gint w
, gint h
,
427 gboolean user
, gboolean final
, gboolean force_reply
);
429 /*! Finds coordinates to keep a client on the screen.
430 @param self The client
431 @param x The x coord of the client, may be changed.
432 @param y The y coord of the client, may be changed.
433 @param w The width of the client.
434 @param w The height of the client.
435 @param rude Be rude about it. If false, it is only moved if it is entirely
436 not visible. If true, then make sure the window is inside the
438 @return true if the client was moved to be on-screen; false if not.
440 gboolean
client_find_onscreen(ObClient
*self
, gint
*x
, gint
*y
, gint w
, gint h
,
443 /*! Moves a client so that it is on screen if it is entirely out of the
445 @param self The client to move
446 @param rude Be rude about it. If false, it is only moved if it is entirely
447 not visible. If true, then make sure the window is inside the
450 void client_move_onscreen(ObClient
*self
, gboolean rude
);
452 /*! dir is either North, South, East or West. It can't be, for example,
454 void client_find_edge_directional(ObClient
*self
, ObDirection dir
,
455 gint my_head
, gint my_tail
,
456 gint my_edge_start
, gint my_edge_size
,
457 gint
*dest
, gboolean
*near_edge
);
458 void client_find_move_directional(ObClient
*self
, ObDirection dir
,
460 void client_find_resize_directional(ObClient
*self
, ObDirection side
,
462 gint
*x
, gint
*y
, gint
*w
, gint
*h
);
464 /*! Fullscreen's or unfullscreen's the client window
465 @param fs true if the window should be made fullscreen; false if it should
466 be returned to normal state.
468 void client_fullscreen(ObClient
*self
, gboolean fs
);
470 /*! Iconifies or uniconifies the client window
471 @param iconic true if the window should be iconified; false if it should be
473 @param curdesk If iconic is FALSE, then this determines if the window will
474 be uniconified to the current viewable desktop (true) or to
475 its previous desktop (false)
477 void client_iconify(ObClient
*self
, gboolean iconic
, gboolean curdesk
,
478 gboolean hide_animation
);
480 /*! Maximize or unmaximize the client window
481 @param max true if the window should be maximized; false if it should be
482 returned to normal size.
483 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
485 void client_maximize(ObClient
*self
, gboolean max
, gint dir
);
487 /*! Shades or unshades the client window
488 @param shade true if the window should be shaded; false if it should be
491 void client_shade(ObClient
*self
, gboolean shade
);
493 /*! Set a client window to have decorations or not */
494 void client_set_undecorated(ObClient
*self
, gboolean undecorated
);
496 /*! Hilite the window to make the user notice it */
497 void client_hilite(ObClient
*self
, gboolean hilite
);
499 /*! Request the client to close its window */
500 void client_close(ObClient
*self
);
502 /*! Kill the client off violently */
503 void client_kill(ObClient
*self
);
505 /*! Sends the window to the specified desktop
506 @param donthide If TRUE, the window will not be shown/hidden after its
507 desktop has been changed. Generally this should be FALSE.
508 @param dontraise If TRUE, the window will not be raised. Generally this should
511 void client_set_desktop(ObClient
*self
, guint target
, gboolean donthide
,
514 /*! Show the client if it should be shown. Returns if the window is shown. */
515 gboolean
client_show(ObClient
*self
);
517 /*! Show the client if it should be shown. Returns if the window is hidden. */
518 gboolean
client_hide(ObClient
*self
);
520 /*! Show the client if it should be shown, and hide it if it should be
521 hidden. This is for example, when switching desktops.
523 void client_showhide(ObClient
*self
);
525 /*! Validate client, by making sure no Destroy or Unmap events exist in
526 the event queue for the window.
527 @return true if the client is valid; false if the client has already
528 been unmapped/destroyed, and so is invalid.
530 gboolean
client_validate(ObClient
*self
);
532 /*! Sets the wm_state to the specified value */
533 void client_set_wm_state(ObClient
*self
, glong state
);
535 /*! Adjusts the window's net_state
536 This should not be called as part of the window mapping process! It is for
537 use when updating the state post-mapping.<br>
538 client_apply_startup_state is used to do the same things during the mapping
541 void client_set_state(ObClient
*self
, Atom action
, glong data1
, glong data2
);
543 /* Given a ObClient, find the client that focus would actually be sent to if
544 you wanted to give focus to the specified ObClient. Will return the same
545 ObClient passed to it or another ObClient if appropriate. */
546 ObClient
*client_focus_target(ObClient
*self
);
548 /*! Returns what client_focus would return if passed the same client, but
549 without focusing it or modifying the focus order lists. */
550 gboolean
client_can_focus(ObClient
*self
);
552 /*! Attempt to focus the client window */
553 gboolean
client_focus(ObClient
*self
);
555 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
556 when the user deliberately selects a window for use.
557 @param here If true, then the client is brought to the current desktop;
558 otherwise, the desktop is changed to where the client lives.
559 @param raise If true, the client is brought to the front.
560 @param unshade If true, the client is unshaded (if it is shaded)
561 @param user If true, then a user action is what requested the activation;
562 otherwise, it means an application requested it on its own
564 void client_activate(ObClient
*self
, gboolean here
, gboolean raise
,
565 gboolean unshade
, gboolean user
);
567 /*! Bring all of its helper windows to its desktop. These are the utility and
569 void client_bring_helper_windows(ObClient
*self
);
571 /*! Bring all of its modal windows to its desktop. */
572 void client_bring_modal_windows(ObClient
*self
);
574 /*! Calculates the stacking layer for the client window */
575 void client_calc_layer(ObClient
*self
);
577 /*! Updates the window's transient status, and any parents of it */
578 void client_update_transient_for(ObClient
*self
);
579 /*! Update the protocols that the window supports and adjusts things if they
581 void client_update_protocols(ObClient
*self
);
583 /*! Updates the window's sync request counter for resizes */
584 void client_update_sync_request_counter(ObClient
*self
);
586 /*! Updates the window's colormap */
587 void client_update_colormap(ObClient
*self
, Colormap colormap
);
588 /*! Updates the WMNormalHints and adjusts things if they change */
589 void client_update_normal_hints(ObClient
*self
);
591 /*! Updates the WMHints and adjusts things if they change
592 @param initstate Whether to read the initial_state property from the
593 WMHints. This should only be used during the mapping
596 void client_update_wmhints(ObClient
*self
);
597 /*! Updates the window's title and icon title */
598 void client_update_title(ObClient
*self
);
599 /*! Updates the strut for the client */
600 void client_update_strut(ObClient
*self
);
601 /*! Updates the window's icons */
602 void client_update_icons(ObClient
*self
);
603 /*! Updates the window's icon geometry (where to iconify to/from) */
604 void client_update_icon_geometry(ObClient
*self
);
606 /*! Set up what decor should be shown on the window and what functions should
607 be allowed (ObClient::decorations and ObClient::functions).
608 This also updates the NET_WM_ALLOWED_ACTIONS hint.
609 @param reconfig When TRUE, the window will be reconfigured to show the
612 void client_setup_decor_and_functions(ObClient
*self
, gboolean reconfig
);
614 /*! Sets the window's type and transient flag */
615 void client_get_type_and_transientness(ObClient
*self
);
617 const ObClientIcon
*client_icon(ObClient
*self
, gint w
, gint h
);
619 /*! Return TRUE if the client is transient for some other window. Return
620 FALSE if it's not transient or there is no window for it to be
622 gboolean
client_has_parent(ObClient
*self
);
624 /*! Searches a client's direct parents for a focused window. The function does
625 not check for the passed client, only for *ONE LEVEL* of its parents.
626 If no focused parentt is found, NULL is returned.
628 ObClient
*client_search_focus_parent(ObClient
*self
);
630 /*! Searches a client's transients for a focused window. The function does not
631 check for the passed client, only for its transients.
632 If no focused transient is found, NULL is returned.
634 ObClient
*client_search_focus_tree(ObClient
*self
);
636 /*! Searches a client's transient tree for a focused window. The function
637 searches up the tree and down other branches as well as the passed client's.
638 If no focused client is found, NULL is returned.
640 ObClient
*client_search_focus_tree_full(ObClient
*self
);
642 /*! Searches a client's group and each member's transients for a focused
643 window. This doesn't go up the window's transient tree at all. If no
644 focused client is found, NULL is returned. */
645 ObClient
*client_search_focus_group_full(ObClient
*self
);
647 /*! Return a modal child of the client window that can be focused.
648 @return A modal child of the client window that can be focused, or 0 if
651 ObClient
*client_search_modal_child(ObClient
*self
);
653 /*! Returns a list of top-level windows which this is a transient for.
654 It will only contain more than 1 element if the client is transient for its
657 GSList
*client_search_all_top_parents(ObClient
*self
);
659 /*! Returns a list of top-level windows which this is a transient for, and
660 which are in the same layer as this client.
661 It will only contain more than 1 element if the client is transient for its
664 GSList
*client_search_all_top_parents_layer(ObClient
*self
);
666 /*! Returns the client's parent when it is transient for a direct window
667 rather than a group. If it has no parents, or is transient for the
668 group, this returns null */
669 ObClient
*client_direct_parent(ObClient
*self
);
671 /*! Returns a window's top level parent. This only counts direct parents,
672 not groups if it is transient for its group.
674 ObClient
*client_search_top_direct_parent(ObClient
*self
);
676 /*! Is one client a direct child of another (i.e. not through the group.) */
677 gboolean
client_is_direct_child(ObClient
*parent
, ObClient
*child
);
679 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
680 returns the searched for parent if it is a parent, or NULL if not. */
681 ObClient
*client_search_parent(ObClient
*self
, ObClient
*search
);
683 /*! Search for a transient of a client. The transient is returned if it is one,
684 NULL is returned if the given search is not a transient of the client. */
685 ObClient
*client_search_transient(ObClient
*self
, ObClient
*search
);
687 /*! Set a client window to be above/below other clients.
688 @layer < 0 indicates the client should be placed below other clients.<br />
689 = 0 indicates the client should be placed with other clients.<br />
690 > 0 indicates the client should be placed above other clients.
692 void client_set_layer(ObClient
*self
, gint layer
);
694 guint
client_monitor(ObClient
*self
);
696 ObClient
* client_under_pointer();
698 gboolean
client_has_group_siblings(ObClient
*self
);