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 */
75 OB_CLIENT_FUNC_ABOVE
= 1 << 7, /*!< Allow to be put in lower layer */
76 OB_CLIENT_FUNC_BELOW
= 1 << 8 /*!< Allow to be put in higher layer */
85 /*! The window's decorations. NULL while the window is being managed! */
86 struct _ObFrame
*frame
;
88 /*! The number of unmap events to ignore on the window */
91 /*! The id of the group the window belongs to */
92 struct _ObGroup
*group
;
94 /*! Saved session data to apply to this client */
95 struct _ObSessionState
*session
;
97 /*! Whether or not the client is a transient window. This is guaranteed to
98 be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
99 transient_for == NULL. */
101 /*! The client which this client is a transient (child) for.
102 A value of TRAN_GROUP signifies that the window is a transient for all
103 members of its ObGroup, and is not a valid pointer to be followed in this
106 ObClient
*transient_for
;
107 /*! The clients which are transients (children) of this client */
109 /*! The desktop on which the window resides (0xffffffff for all
113 /*! The startup id for the startup-notification protocol. This will be
114 NULL if a startup id is not set. */
117 /*! Normal window title */
119 /*! Window title when iconified */
121 /*! Hostname of machine running the client */
122 gchar
*client_machine
;
123 /*! The command used to run the program. Pre-XSMP window identification. */
126 /*! The application that created the window */
128 /*! The class of the window, can used for grouping */
130 /*! The specified role of the window, used for identification */
132 /*! The session client id for the window. *This can be NULL!* */
135 /*! The type of window (what its function is) */
138 /*! Position and size of the window
139 This will not always be the actual position of the window on screen, it
140 is, rather, the position requested by the client, to which the window's
145 /*! Position of the client window relative to the root window */
148 /*! Position and size of the window prior to being maximized */
150 /*! Position and size of the window prior to being fullscreened */
151 Rect pre_fullscreen_area
;
153 /*! The window's strut
154 The strut defines areas of the screen that are marked off-bounds for
155 window placement. In theory, where this window exists.
159 /*! The logical size of the window
160 The "logical" size of the window is refers to the user's perception of
161 the size of the window, and is the value that should be displayed to the
162 user. For example, with xterms, this value it the number of characters
163 being displayed in the terminal, instead of the number of pixels.
167 /*! Width of the border on the window.
168 The window manager will set this to 0 while the window is being managed,
169 but needs to restore it afterwards, so it is saved here.
173 /*! The minimum aspect ratio the client window can be sized to.
174 A value of 0 means this is ignored.
177 /*! The maximum aspect ratio the client window can be sized to.
178 A value of 0 means this is ignored.
182 /*! The minimum size of the client window
183 If the min is > the max, then the window is not resizable
186 /*! The maximum size of the client window
187 If the min is > the max, then the window is not resizable
190 /*! The size of increments to resize the client window by */
192 /*! The base size of the client window
193 This value should be subtracted from the window's actual size when
194 displaying its size to the user, or working with its min/max size
198 /*! Window decoration and functionality hints */
201 /*! The client's specified colormap */
204 /*! Where to place the decorated window in relation to the undecorated
208 /*! The state of the window, one of WithdrawnState, IconicState, or
212 /*! True if the client supports the delete_window protocol */
213 gboolean delete_window
;
215 /*! Was the window's position requested by the application or the user?
216 if by the application, we force it completely onscreen, if by the user
217 we only force it if it tries to go completely offscreen, if neither, we
218 should place the window ourselves when it first appears */
221 /*! Can the window receive input focus? */
223 /*! Notify the window when it receives focus? */
224 gboolean focus_notify
;
227 /*! The client wants to sync during resizes */
228 gboolean sync_request
;
229 /*! The XSync counter used for synchronizing during resizes */
230 guint32 sync_counter
;
231 /*! The value we're waiting for the counter to reach */
232 gulong sync_counter_value
;
235 /*! The window uses shape extension to be non-rectangular? */
238 /*! The window is modal, so it must be processed before any windows it is
239 related to can be focused */
241 /*! Only the window's titlebar is displayed */
243 /*! The window is iconified */
245 /*! The window is maximized to fill the screen vertically */
247 /*! The window is maximized to fill the screen horizontally */
249 /*! The window should not be displayed by pagers */
251 /*! The window should not be displayed by taskbars */
252 gboolean skip_taskbar
;
253 /*! The window is a 'fullscreen' window, and should be on top of all
256 /*! The window should be on top of other windows of the same type.
257 above takes priority over below. */
259 /*! The window should be underneath other windows of the same type.
260 above takes priority over below. */
262 /*! Demands attention flag */
263 gboolean demands_attention
;
265 /*! The urgent flag */
268 /*! The layer in which the window will be stacked, windows in lower layers
269 are always below windows in higher layers. */
270 ObStackingLayer layer
;
272 /*! A bitmask of values in the ObFrameDecorations enum
273 The values in the variable are the decorations that the client wants to
274 be displayed around it.
278 /*! A user option. When this is set to TRUE the client will not ever
281 gboolean undecorated
;
283 /*! A bitmask of values in the ObFunctions enum
284 The values in the variable specify the ways in which the user is allowed
285 to modify this window.
289 /*! Icons for the client as specified on the client window */
291 /*! The number of icons in icons */
294 /*! Where the window should iconify to/from */
297 /*! The time when the client last received user interaction */
299 /*! A separate window for the client to update it's user_time on */
300 Window user_time_window
;
303 extern GList
*client_list
;
304 extern GHashTable
*client_user_time_window_map
;
306 void client_startup(gboolean reconfig
);
307 void client_shutdown(gboolean reconfig
);
309 typedef void (*ObClientCallback
)(ObClient
*client
, gpointer data
);
311 /* Callback functions */
313 /*! Get notified when the client is unmanaged */
314 void client_add_destroy_notify(ObClientCallback func
, gpointer data
);
315 void client_remove_destroy_notify(ObClientCallback func
);
317 /*! Manages all existing windows */
318 void client_manage_all();
319 /*! Manages a given window
321 void client_manage(Window win
);
322 /*! Unmanages all managed windows */
323 void client_unmanage_all();
324 /*! Unmanages a given client */
325 void client_unmanage(ObClient
*client
);
327 /*! This manages a window only so far as is needed to get it's decorations.
328 This is used when you want to determine a window's decorations before it
329 is mapped. Call client_fake_unmanage() with the returned client when you
331 ObClient
*client_fake_manage(Window win
);
332 /*! Free the stuff created by client_fake_manage() */
333 void client_fake_unmanage(ObClient
*self
);
335 /*! Sets the client list on the root window from the client_list */
336 void client_set_list();
338 /*! Determines if the client should be shown or hidden currently.
339 @return TRUE if it should be visible; otherwise, FALSE.
341 gboolean
client_should_show(ObClient
*self
);
343 /*! Returns if the window should be treated as a normal window.
344 Some windows (desktops, docks, splash screens) have special rules applied
345 to them in a number of places regarding focus or user interaction. */
346 gboolean
client_normal(ObClient
*self
);
348 /*! Returns if the window is one of an application's helper windows
349 (utilty, menu, etc) */
350 gboolean
client_helper(ObClient
*self
);
352 /*! Return if the client is a type which should be given focus from mouse
353 presses on the *client* window. This doesn't affect clicking on the
354 decorations. This doesn't count for focus cycling, different rules apply to
356 gboolean
client_mouse_focusable(ObClient
*self
);
358 /*! Return if the client is a type which should be given focus from the
359 mouse entering the window. This doesn't count for focus cycling, different
360 rules apply to that. */
361 gboolean
client_enter_focusable(ObClient
*self
);
363 /* Returns if the window is focused */
364 gboolean
client_focused(ObClient
*self
);
366 /*! Convery a position/size from a given gravity to the client's true gravity
368 void client_convert_gravity(ObClient
*self
, gint gravity
, gint
*x
, gint
*y
,
371 #define client_move(self, x, y) \
372 client_configure(self, x, y, self->area.width, self->area.height, \
374 #define client_resize(self, w, h) \
375 client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE)
376 #define client_move_resize(self, x, y, w, h) \
377 client_configure(self, x, y, w, h, TRUE, TRUE)
379 #define client_configure(self, x, y, w, h, user, final) \
380 client_configure_full(self, x, y, w, h, user, final)
382 /*! Figure out where a window will end up and what size it will be if you
383 told it to move/resize to these coordinates.
385 These values are what client_configure_full will give the window.
387 @param x The x coordiante of the new position for the client.
388 @param y The y coordiante of the new position for the client.
389 @param w The width component of the new size for the client.
390 @param h The height component of the new size for the client.
391 @param logicalw Returns the width component of the new logical width.
392 This value is only returned when the new w or h calculated
393 differ from the ones passed in.
394 @param logicalh Returns the height component of the new logical height.
395 This value is only returned when the new w or h calculated
396 differ from the ones passed in.
397 @param user Specifies whether this is a user-requested change or a
398 program requested change. For program requested changes, the
399 constraints are not checked.
401 void client_try_configure(ObClient
*self
, gint
*x
, gint
*y
, gint
*w
, gint
*h
,
402 gint
*logicalw
, gint
*logicalh
,
405 /*! Move and/or resize the window.
406 This also maintains things like the client's minsize, and size increments.
407 @param x The x coordiante of the new position for the client.
408 @param y The y coordiante of the new position for the client.
409 @param w The width component of the new size for the client.
410 @param h The height component of the new size for the client.
411 @param user Specifies whether this is a user-requested change or a
412 program requested change. For program requested changes, the
413 constraints are not checked.
414 @param final If user is true, then this should specify if this is a final
415 configuration. e.g. Final should be FALSE if doing an
416 interactive move/resize, and then be TRUE for the last call
418 @param force_reply Send a ConfigureNotify to the client regardless of if
419 the position changed.
421 void client_configure_full(ObClient
*self
, gint x
, gint y
, gint w
, gint h
,
422 gboolean user
, gboolean final
);
424 void client_reconfigure(ObClient
*self
);
426 /*! Finds coordinates to keep a client on the screen.
427 @param self The client
428 @param x The x coord of the client, may be changed.
429 @param y The y coord of the client, may be changed.
430 @param w The width of the client.
431 @param w The height of the client.
432 @param rude Be rude about it. If false, it is only moved if it is entirely
433 not visible. If true, then make sure the window is inside the
435 @return true if the client was moved to be on-screen; false if not.
437 gboolean
client_find_onscreen(ObClient
*self
, gint
*x
, gint
*y
, gint w
, gint h
,
440 /*! Moves a client so that it is on screen if it is entirely out of the
442 @param self The client to move
443 @param rude Be rude about it. If false, it is only moved if it is entirely
444 not visible. If true, then make sure the window is inside the
447 void client_move_onscreen(ObClient
*self
, gboolean rude
);
449 /*! Fullscreen's or unfullscreen's the client window
450 @param fs true if the window should be made fullscreen; false if it should
451 be returned to normal state.
453 void client_fullscreen(ObClient
*self
, gboolean fs
);
455 /*! Iconifies or uniconifies the client window
456 @param iconic true if the window should be iconified; false if it should be
458 @param curdesk If iconic is FALSE, then this determines if the window will
459 be uniconified to the current viewable desktop (true) or to
460 its previous desktop (false)
462 void client_iconify(ObClient
*self
, gboolean iconic
, gboolean curdesk
,
463 gboolean hide_animation
);
465 /*! Maximize or unmaximize the client window
466 @param max true if the window should be maximized; false if it should be
467 returned to normal size.
468 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
470 void client_maximize(ObClient
*self
, gboolean max
, gint dir
);
472 /*! Shades or unshades the client window
473 @param shade true if the window should be shaded; false if it should be
476 void client_shade(ObClient
*self
, gboolean shade
);
478 /*! Set a client window to have decorations or not */
479 void client_set_undecorated(ObClient
*self
, gboolean undecorated
);
481 /*! Hilite the window to make the user notice it */
482 void client_hilite(ObClient
*self
, gboolean hilite
);
484 /*! Request the client to close its window */
485 void client_close(ObClient
*self
);
487 /*! Kill the client off violently */
488 void client_kill(ObClient
*self
);
490 /*! Sends the window to the specified desktop
491 @param donthide If TRUE, the window will not be shown/hidden after its
492 desktop has been changed. Generally this should be FALSE.
494 void client_set_desktop(ObClient
*self
, guint target
, gboolean donthide
);
496 /*! Show the client if it should be shown. */
497 void client_show(ObClient
*self
);
499 /*! Show the client if it should be shown. */
500 void client_hide(ObClient
*self
);
502 /*! Show the client if it should be shown, and hide it if it should be
503 hidden. This is for example, when switching desktops.
505 void client_showhide(ObClient
*self
);
507 /*! Validate client, by making sure no Destroy or Unmap events exist in
508 the event queue for the window.
509 @return true if the client is valid; false if the client has already
510 been unmapped/destroyed, and so is invalid.
512 gboolean
client_validate(ObClient
*self
);
514 /*! Sets the wm_state to the specified value */
515 void client_set_wm_state(ObClient
*self
, glong state
);
517 /*! Adjusts the window's net_state
518 This should not be called as part of the window mapping process! It is for
519 use when updating the state post-mapping.<br>
520 client_apply_startup_state is used to do the same things during the mapping
523 void client_set_state(ObClient
*self
, Atom action
, glong data1
, glong data2
);
525 /* Given a ObClient, find the client that focus would actually be sent to if
526 you wanted to give focus to the specified ObClient. Will return the same
527 ObClient passed to it or another ObClient if appropriate. */
528 ObClient
*client_focus_target(ObClient
*self
);
530 /*! Returns what client_focus would return if passed the same client, but
531 without focusing it or modifying the focus order lists. */
532 gboolean
client_can_focus(ObClient
*self
);
534 /*! Attempt to focus the client window
535 NOTE: You should validate the client before calling this !! (client_validate)
537 gboolean
client_focus(ObClient
*self
);
539 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
540 when the user deliberately selects a window for use.
541 @param here If true, then the client is brought to the current desktop;
542 otherwise, the desktop is changed to where the client lives.
543 @param user If true, then a user action is what requested the activation;
544 otherwise, it means an application requested it on its own
546 void client_activate(ObClient
*self
, gboolean here
, gboolean user
);
548 /*! Bring all of its helper windows to its desktop. These are the utility and
550 void client_bring_helper_windows(ObClient
*self
);
552 /*! Calculates the stacking layer for the client window */
553 void client_calc_layer(ObClient
*self
);
555 /*! Updates the window's transient status, and any parents of it */
556 void client_update_transient_for(ObClient
*self
);
557 /*! Update the protocols that the window supports and adjusts things if they
559 void client_update_protocols(ObClient
*self
);
561 /*! Updates the window's sync request counter for resizes */
562 void client_update_sync_request_counter(ObClient
*self
);
564 /*! Updates the window's colormap */
565 void client_update_colormap(ObClient
*self
, Colormap colormap
);
566 /*! Updates the WMNormalHints and adjusts things if they change */
567 void client_update_normal_hints(ObClient
*self
);
569 /*! Updates the WMHints and adjusts things if they change
570 @param initstate Whether to read the initial_state property from the
571 WMHints. This should only be used during the mapping
574 void client_update_wmhints(ObClient
*self
);
575 /*! Updates the window's title and icon title */
576 void client_update_title(ObClient
*self
);
577 /*! Updates the strut for the client */
578 void client_update_strut(ObClient
*self
);
579 /*! Updates the window's icons */
580 void client_update_icons(ObClient
*self
);
581 /*! Updates the window's user time */
582 void client_update_user_time(ObClient
*self
);
583 /*! Updates the window's user time window */
584 void client_update_user_time_window(ObClient
*self
);
585 /*! Updates the window's icon geometry (where to iconify to/from) */
586 void client_update_icon_geometry(ObClient
*self
);
588 /*! Set up what decor should be shown on the window and what functions should
589 be allowed (ObClient::decorations and ObClient::functions).
590 This also updates the NET_WM_ALLOWED_ACTIONS hint.
592 void client_setup_decor_and_functions(ObClient
*self
);
594 /*! Sets the window's type and transient flag */
595 void client_get_type_and_transientness(ObClient
*self
);
597 const ObClientIcon
*client_icon(ObClient
*self
, gint w
, gint h
);
599 /*! Searches a client's direct parents for a focused window. The function does
600 not check for the passed client, only for *ONE LEVEL* of its parents.
601 If no focused parentt is found, NULL is returned.
603 ObClient
*client_search_focus_parent(ObClient
*self
);
605 /*! Searches a client's transients for a focused window. The function does not
606 check for the passed client, only for its transients.
607 If no focused transient is found, NULL is returned.
609 ObClient
*client_search_focus_tree(ObClient
*self
);
611 /*! Searches a client's transient tree for a focused window. The function
612 searches up the tree and down other branches as well as the passed client's.
613 If no focused client is found, NULL is returned.
615 ObClient
*client_search_focus_tree_full(ObClient
*self
);
617 /*! Return a modal child of the client window that can be focused.
618 @return A modal child of the client window that can be focused, or 0 if
621 ObClient
*client_search_modal_child(ObClient
*self
);
623 /*! Returns a list of top-level windows which this is a transient for.
624 It will only contain more than 1 element if the client is transient for its
627 GSList
*client_search_all_top_parents(ObClient
*self
);
629 /*! Returns a list of top-level windows which this is a transient for, and
630 which are in the same layer as this client.
631 It will only contain more than 1 element if the client is transient for its
634 GSList
*client_search_all_top_parents_layer(ObClient
*self
);
636 /*! Returns a window's top level parent. This only counts direct parents,
637 not groups if it is transient for its group.
639 ObClient
*client_search_top_normal_parent(ObClient
*self
);
641 /*! Is one client a direct child of another (i.e. not through the group.) */
642 gboolean
client_is_direct_child(ObClient
*parent
, ObClient
*child
);
644 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
645 returns the searched for parent if it is a parent, or NULL if not. */
646 ObClient
*client_search_parent(ObClient
*self
, ObClient
*search
);
648 /*! Search for a transient of a client. The transient is returned if it is one,
649 NULL is returned if the given search is not a transient of the client. */
650 ObClient
*client_search_transient(ObClient
*self
, ObClient
*search
);
652 /*! Return the closest edge in the given direction */
653 gint
client_directional_edge_search(ObClient
*c
, ObDirection dir
, gboolean hang
);
655 /*! Set a client window to be above/below other clients.
656 @layer < 0 indicates the client should be placed below other clients.<br />
657 = 0 indicates the client should be placed with other clients.<br />
658 > 0 indicates the client should be placed above other clients.
660 void client_set_layer(ObClient
*self
, gint layer
);
662 guint
client_monitor(ObClient
*self
);
664 ObClient
* client_under_pointer();
666 gboolean
client_has_group_siblings(ObClient
*self
);