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 */
119 /*! Hostname of machine running the client */
120 gchar
*client_machine
;
122 /*! The application that created the window */
124 /*! The class of the window, can used for grouping */
126 /*! The specified role of the window, used for identification */
128 /*! The session client id for the window. *This can be NULL!* */
131 /*! The type of window (what its function is) */
134 /*! Position and size of the window
135 This will not always be the actual position of the window on screen, it
136 is, rather, the position requested by the client, to which the window's
141 /*! Position of the client window relative to the root window */
144 /*! Position and size of the window prior to being maximized */
146 /*! Position and size of the window prior to being fullscreened */
147 Rect pre_fullscreen_area
;
149 /*! The window's strut
150 The strut defines areas of the screen that are marked off-bounds for
151 window placement. In theory, where this window exists.
155 /*! The logical size of the window
156 The "logical" size of the window is refers to the user's perception of
157 the size of the window, and is the value that should be displayed to the
158 user. For example, with xterms, this value it the number of characters
159 being displayed in the terminal, instead of the number of pixels.
163 /*! Width of the border on the window.
164 The window manager will set this to 0 while the window is being managed,
165 but needs to restore it afterwards, so it is saved here.
169 /*! The minimum aspect ratio the client window can be sized to.
170 A value of 0 means this is ignored.
173 /*! The maximum aspect ratio the client window can be sized to.
174 A value of 0 means this is ignored.
178 /*! The minimum size of the client window
179 If the min is > the max, then the window is not resizable
182 /*! The maximum size of the client window
183 If the min is > the max, then the window is not resizable
186 /*! The size of increments to resize the client window by */
188 /*! The base size of the client window
189 This value should be subtracted from the window's actual size when
190 displaying its size to the user, or working with its min/max size
194 /*! Window decoration and functionality hints */
197 /*! The client's specified colormap */
200 /*! Where to place the decorated window in relation to the undecorated
204 /*! The state of the window, one of WithdrawnState, IconicState, or
208 /*! True if the client supports the delete_window protocol */
209 gboolean delete_window
;
211 /*! Was the window's position requested by the application or the user?
212 if by the application, we force it completely onscreen, if by the user
213 we only force it if it tries to go completely offscreen, if neither, we
214 should place the window ourselves when it first appears */
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 layer in which the window will be stacked, windows in lower layers
262 are always below windows in higher layers. */
263 ObStackingLayer layer
;
265 /*! A bitmask of values in the ObFrameDecorations enum
266 The values in the variable are the decorations that the client wants to
267 be displayed around it.
271 /*! A user option. When this is set to TRUE the client will not ever
274 gboolean undecorated
;
276 /*! A bitmask of values in the ObFunctions enum
277 The values in the variable specify the ways in which the user is allowed
278 to modify this window.
282 /*! Icons for the client as specified on the client window */
284 /*! The number of icons in icons */
290 struct _ObAppSettings
316 extern GList
*client_list
;
318 void client_startup(gboolean reconfig
);
319 void client_shutdown(gboolean reconfig
);
321 typedef void (*ObClientDestructor
)(ObClient
*client
, gpointer data
);
323 void client_add_destructor(ObClientDestructor func
, gpointer data
);
324 void client_remove_destructor(ObClientDestructor func
);
326 /*! Manages all existing windows */
327 void client_manage_all();
328 /*! Manages a given window */
329 void client_manage(Window win
);
330 /*! Unmanages all managed windows */
331 void client_unmanage_all();
332 /*! Unmanages a given client */
333 void client_unmanage(ObClient
*client
);
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 focused */
349 gboolean
client_focused(ObClient
*self
);
351 #define client_move(self, x, y) \
352 client_configure(self, OB_CORNER_TOPLEFT, x, y, \
353 self->area.width, self->area.height, \
355 #define client_resize(self, w, h) \
356 client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
358 #define client_move_resize(self, x, y, w, h) \
359 client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
361 #define client_configure(self, anchor, x, y, w, h, user, final) \
362 client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
364 /*! Figure out where a window will end up and what size it will be if you
365 told it to move/resize to these coordinates.
367 These values are what client_configure_full will give the window.
369 @param anchor The corner to keep in the same position when resizing.
370 @param x The x coordiante of the new position for the client.
371 @param y The y coordiante of the new position for the client.
372 @param w The width component of the new size for the client.
373 @param h The height component of the new size for the client.
374 @param logicalw Returns the width component of the new logical width.
375 This value is only returned when the new w or h calculated
376 differ from the ones passed in.
377 @param logicalh Returns the height component of the new logical height.
378 This value is only returned when the new w or h calculated
379 differ from the ones passed in.
380 @param user Specifies whether this is a user-requested change or a
381 program requested change. For program requested changes, the
382 constraints are not checked.
384 void client_try_configure(ObClient
*self
, ObCorner anchor
,
385 gint
*x
, gint
*y
, gint
*w
, gint
*h
,
386 gint
*logicalw
, gint
*logicalh
,
389 /*! Move and/or resize the window.
390 This also maintains things like the client's minsize, and size increments.
391 @param anchor The corner to keep in the same position when resizing.
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 user Specifies whether this is a user-requested change or a
397 program requested change. For program requested changes, the
398 constraints are not checked.
399 @param final If user is true, then this should specify if this is a final
400 configuration. e.g. Final should be FALSE if doing an
401 interactive move/resize, and then be TRUE for the last call
403 @param force_reply Send a ConfigureNotify to the client regardless of if
404 the position changed.
406 void client_configure_full(ObClient
*self
, ObCorner anchor
,
407 gint x
, gint y
, gint w
, gint h
,
408 gboolean user
, gboolean final
,
409 gboolean force_reply
);
411 void client_reconfigure(ObClient
*self
);
413 /*! Finds coordinates to keep a client on the screen.
414 @param self The client
415 @param x The x coord of the client, may be changed.
416 @param y The y coord of the client, may be changed.
417 @param w The width of the client.
418 @param w The height of the client.
419 @param rude Be rude about it. If false, it is only moved if it is entirely
420 not visible. If true, then make sure the window is inside the
422 @return true if the client was moved to be on-screen; false if not.
424 gboolean
client_find_onscreen(ObClient
*self
, gint
*x
, gint
*y
, gint w
, gint h
,
427 /*! Moves a client so that it is on screen if it is entirely out of the
429 @param self The client to move
430 @param rude Be rude about it. If false, it is only moved if it is entirely
431 not visible. If true, then make sure the window is inside the
434 void client_move_onscreen(ObClient
*self
, gboolean rude
);
436 /*! Fullscreen's or unfullscreen's the client window
437 @param fs true if the window should be made fullscreen; false if it should
438 be returned to normal state.
440 void client_fullscreen(ObClient
*self
, gboolean fs
);
442 /*! Iconifies or uniconifies the client window
443 @param iconic true if the window should be iconified; false if it should be
445 @param curdesk If iconic is FALSE, then this determines if the window will
446 be uniconified to the current viewable desktop (true) or to
447 its previous desktop (false)
449 void client_iconify(ObClient
*self
, gboolean iconic
, gboolean curdesk
);
451 /*! Maximize or unmaximize the client window
452 @param max true if the window should be maximized; false if it should be
453 returned to normal size.
454 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
456 void client_maximize(ObClient
*self
, gboolean max
, gint dir
);
458 /*! Shades or unshades the client window
459 @param shade true if the window should be shaded; false if it should be
462 void client_shade(ObClient
*self
, gboolean shade
);
464 /*! Hilite the window to make the user notice it */
465 void client_hilite(ObClient
*self
, gboolean hilite
);
467 /*! Request the client to close its window */
468 void client_close(ObClient
*self
);
470 /*! Kill the client off violently */
471 void client_kill(ObClient
*self
);
473 /*! Sends the window to the specified desktop
474 @param donthide If TRUE, the window will not be shown/hidden after its
475 desktop has been changed. Generally this should be FALSE. */
476 void client_set_desktop(ObClient
*self
, guint target
, gboolean donthide
);
478 /*! Show the client if it should be shown. */
479 void client_show(ObClient
*self
);
481 /*! Show the client if it should be shown. */
482 void client_hide(ObClient
*self
);
484 /*! Show the client if it should be shown, and hide it if it should be
485 hidden. This is for example, when switching desktops.
487 void client_showhide(ObClient
*self
);
489 /*! Validate client, by making sure no Destroy or Unmap events exist in
490 the event queue for the window.
491 @return true if the client is valid; false if the client has already
492 been unmapped/destroyed, and so is invalid.
494 gboolean
client_validate(ObClient
*self
);
496 /*! Sets the wm_state to the specified value */
497 void client_set_wm_state(ObClient
*self
, glong state
);
499 /*! Adjusts the window's net_state
500 This should not be called as part of the window mapping process! It is for
501 use when updating the state post-mapping.<br>
502 client_apply_startup_state is used to do the same things during the mapping
505 void client_set_state(ObClient
*self
, Atom action
, glong data1
, glong data2
);
507 /* Given a ObClient, find the client that focus would actually be sent to if
508 you wanted to give focus to the specified ObClient. Will return the same
509 ObClient passed to it or another ObClient if appropriate. */
510 ObClient
*client_focus_target(ObClient
*self
);
512 /*! Returns what client_focus would return if passed the same client, but
513 without focusing it or modifying the focus order lists. */
514 gboolean
client_can_focus(ObClient
*self
);
516 /*! Attempt to focus the client window
517 NOTE: You should validate the client before calling this !! (client_validate)
519 gboolean
client_focus(ObClient
*self
);
521 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
522 when the user deliberately selects a window for use.
523 @param here If true, then the client is brought to the current desktop;
524 otherwise, the desktop is changed to where the client lives.
525 @param user If true, then a user action is what requested the activation;
526 otherwise, it means an application requested it on its own
528 void client_activate(ObClient
*self
, gboolean here
, gboolean user
);
530 /*! Calculates the stacking layer for the client window */
531 void client_calc_layer(ObClient
*self
);
533 /*! Raises the client to the top of its stacking layer
534 Normally actions call to the client_* functions to make stuff go, but this
535 one is an exception. It just fires off an action, which will be queued.
536 This is because stacking order rules can be changed by focus state, and so
537 any time focus changes you have to wait for it to complete before you can
538 properly restart windows. As such, this only queues an action for later
539 execution, once the focus change has gone through.
541 void client_raise(ObClient
*self
);
543 /*! Lowers the client to the bottom of its stacking layer
544 Normally actions call to the client_* functions to make stuff go, but this
545 one is an exception. It just fires off an action, which will be queued.
546 This is because stacking order rules can be changed by focus state, and so
547 any time focus changes you have to wait for it to complete before you can
548 properly restart windows. As such, this only queues an action for later
549 execution, once the focus change has gone through.
551 void client_lower(ObClient
*self
);
553 /*! Updates the window's transient status, and any parents of it */
554 void client_update_transient_for(ObClient
*self
);
555 /*! Update the protocols that the window supports and adjusts things if they
557 void client_update_protocols(ObClient
*self
);
559 /*! Updates the window's sync request counter for resizes */
560 void client_update_sync_request_counter(ObClient
*self
);
562 /*! Updates the window's colormap */
563 void client_update_colormap(ObClient
*self
, Colormap colormap
);
564 /*! Updates the WMNormalHints and adjusts things if they change */
565 void client_update_normal_hints(ObClient
*self
);
567 /*! Updates the WMHints and adjusts things if they change
568 @param initstate Whether to read the initial_state property from the
569 WMHints. This should only be used during the mapping
572 void client_update_wmhints(ObClient
*self
);
573 /*! Updates the window's title and icon title */
574 void client_update_title(ObClient
*self
);
575 /*! Updates the window's application name and class */
576 void client_update_class(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
);
584 /*! Set up what decor should be shown on the window and what functions should
585 be allowed (ObClient::decorations and ObClient::functions).
586 This also updates the NET_WM_ALLOWED_ACTIONS hint.
588 void client_setup_decor_and_functions(ObClient
*self
);
590 /*! Retrieves the window's type and sets ObClient->type */
591 void client_get_type(ObClient
*self
);
593 const ObClientIcon
*client_icon(ObClient
*self
, gint w
, gint h
);
595 /*! Searches a client's direct parents for a focused window. The function does
596 not check for the passed client, only for *ONE LEVEL* of its parents.
597 If no focused parentt is found, NULL is returned.
599 ObClient
*client_search_focus_parent(ObClient
*self
);
601 /*! Searches a client's transients for a focused window. The function does not
602 check for the passed client, only for its transients.
603 If no focused transient is found, NULL is returned.
605 ObClient
*client_search_focus_tree(ObClient
*self
);
607 /*! Searches a client's transient tree for a focused window. The function
608 searches up the tree and down other branches as well as the passed client's.
609 If no focused client is found, NULL is returned.
611 ObClient
*client_search_focus_tree_full(ObClient
*self
);
613 /*! Return a modal child of the client window that can be focused.
614 @return A modal child of the client window that can be focused, or 0 if
617 ObClient
*client_search_modal_child(ObClient
*self
);
619 /*! Returns a list of top-level windows which this is a transient for.
620 It will only contain more than 1 element if the client is transient for its
623 GSList
*client_search_all_top_parents(ObClient
*self
);
625 /*! Returns a window's top level parent. This only counts direct parents,
626 not groups if it is transient for its group.
628 ObClient
*client_search_top_parent(ObClient
*self
);
630 /*! Is one client a direct child of another (i.e. not through the group.) */
631 gboolean
client_is_direct_child(ObClient
*parent
, ObClient
*child
);
633 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
634 returns the searched for parent if it is a parent, or NULL if not. */
635 ObClient
*client_search_parent(ObClient
*self
, ObClient
*search
);
637 /*! Search for a transient of a client. The transient is returned if it is one,
638 NULL is returned if the given search is not a transient of the client. */
639 ObClient
*client_search_transient(ObClient
*self
, ObClient
*search
);
641 /*! Return the closest edge in the given direction */
642 gint
client_directional_edge_search(ObClient
*c
, ObDirection dir
, gboolean hang
);
644 /*! Set a client window to be above/below other clients.
645 @layer < 0 indicates the client should be placed below other clients.<br>
646 = 0 indicates the client should be placed with other clients.<br>
647 > 0 indicates the client should be placed above other clients.
649 void client_set_layer(ObClient
*self
, gint layer
);
651 /*! Set a client window to have decorations or not */
652 void client_set_undecorated(ObClient
*self
, gboolean undecorated
);
654 guint
client_monitor(ObClient
*self
);
656 void client_update_sm_client_id(ObClient
*self
);
658 ObClient
* client_under_pointer();
660 gboolean
client_has_group_siblings(ObClient
*self
);