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 Ben 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 and size of the window prior to being maximized */
141 /*! Position and size of the window prior to being fullscreened */
142 Rect pre_fullscreen_area
;
144 /*! The window's strut
145 The strut defines areas of the screen that are marked off-bounds for
146 window placement. In theory, where this window exists.
150 /*! The logical size of the window
151 The "logical" size of the window is refers to the user's perception of
152 the size of the window, and is the value that should be displayed to the
153 user. For example, with xterms, this value it the number of characters
154 being displayed in the terminal, instead of the number of pixels.
158 /*! Width of the border on the window.
159 The window manager will set this to 0 while the window is being managed,
160 but needs to restore it afterwards, so it is saved here.
164 /*! The minimum aspect ratio the client window can be sized to.
165 A value of 0 means this is ignored.
168 /*! The maximum aspect ratio the client window can be sized to.
169 A value of 0 means this is ignored.
173 /*! The minimum size of the client window
174 If the min is > the max, then the window is not resizable
177 /*! The maximum size of the client window
178 If the min is > the max, then the window is not resizable
181 /*! The size of increments to resize the client window by */
183 /*! The base size of the client window
184 This value should be subtracted from the window's actual size when
185 displaying its size to the user, or working with its min/max size
189 /*! Window decoration and functionality hints */
192 /*! Where to place the decorated window in relation to the undecorated
196 /*! The state of the window, one of WithdrawnState, IconicState, or
200 /*! True if the client supports the delete_window protocol */
201 gboolean delete_window
;
203 /*! Was the window's position requested by the application or the user?
204 if by the application, we force it completely onscreen, if by the user
205 we only force it if it tries to go completely offscreen, if neither, we
206 should place the window ourselves when it first appears */
209 /*! Can the window receive input focus? */
211 /*! Notify the window when it receives focus? */
212 gboolean focus_notify
;
214 /*! The window uses shape extension to be non-rectangular? */
217 /*! The window is modal, so it must be processed before any windows it is
218 related to can be focused */
220 /*! Only the window's titlebar is displayed */
222 /*! The window is iconified */
224 /*! The window is maximized to fill the screen vertically */
226 /*! The window is maximized to fill the screen horizontally */
228 /*! The window should not be displayed by pagers */
230 /*! The window should not be displayed by taskbars */
231 gboolean skip_taskbar
;
232 /*! The window is a 'fullscreen' window, and should be on top of all
235 /*! The window should be on top of other windows of the same type.
236 above takes priority over below. */
238 /*! The window should be underneath other windows of the same type.
239 above takes priority over below. */
241 /*! Demands attention flag */
242 gboolean demands_attention
;
244 /*! The layer in which the window will be stacked, windows in lower layers
245 are always below windows in higher layers. */
246 ObStackingLayer layer
;
248 /*! A bitmask of values in the ObFrameDecorations enum
249 The values in the variable are the decorations that the client wants to
250 be displayed around it.
254 /*! A user option. When this is set to TRUE the client will not ever
257 gboolean undecorated
;
259 /*! A bitmask of values in the ObFunctions enum
260 The values in the variable specify the ways in which the user is allowed
261 to modify this window.
265 /*! Icons for the client as specified on the client window */
267 /*! The number of icons in icons */
273 struct _ObAppSettings
299 extern GList
*client_list
;
301 void client_startup(gboolean reconfig
);
302 void client_shutdown(gboolean reconfig
);
304 typedef void (*ObClientDestructor
)(ObClient
*client
, gpointer data
);
306 void client_add_destructor(ObClientDestructor func
, gpointer data
);
307 void client_remove_destructor(ObClientDestructor func
);
309 /*! Manages all existing windows */
310 void client_manage_all();
311 /*! Manages a given window */
312 void client_manage(Window win
);
313 /*! Unmanages all managed windows */
314 void client_unmanage_all();
315 /*! Unmanages a given client */
316 void client_unmanage(ObClient
*client
);
318 /*! Sets the client list on the root window from the client_list */
319 void client_set_list();
321 /*! Determines if the client should be shown or hidden currently.
322 @return TRUE if it should be visible; otherwise, FALSE.
324 gboolean
client_should_show(ObClient
*self
);
326 /*! Returns if the window should be treated as a normal window.
327 Some windows (desktops, docks, splash screens) have special rules applied
328 to them in a number of places regarding focus or user interaction. */
329 gboolean
client_normal(ObClient
*self
);
331 /* Returns if the window is focused */
332 gboolean
client_focused(ObClient
*self
);
334 #define client_move(self, x, y) \
335 client_configure(self, OB_CORNER_TOPLEFT, x, y, \
336 self->area.width, self->area.height, \
338 #define client_resize(self, w, h) \
339 client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
341 #define client_move_resize(self, x, y, w, h) \
342 client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
344 #define client_configure(self, anchor, x, y, w, h, user, final) \
345 client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
347 /*! Figure out where a window will end up and what size it will be if you
348 told it to move/resize to these coordinates.
350 These values are what client_configure_full will give the window.
352 @param anchor The corner to keep in the same position when resizing.
353 @param x The x coordiante of the new position for the client.
354 @param y The y coordiante of the new position for the client.
355 @param w The width component of the new size for the client.
356 @param h The height component of the new size for the client.
357 @param logicalw Returns the width component of the new logical width.
358 This value is only returned when the new w or h calculated
359 differ from the ones passed in.
360 @param logicalh Returns the height component of the new logical height.
361 This value is only returned when the new w or h calculated
362 differ from the ones passed in.
363 @param user Specifies whether this is a user-requested change or a
364 program requested change. For program requested changes, the
365 constraints are not checked.
367 void client_try_configure(ObClient
*self
, ObCorner anchor
,
368 gint
*x
, gint
*y
, gint
*w
, gint
*h
,
369 gint
*logicalw
, gint
*logicalh
,
372 /*! Move and/or resize the window.
373 This also maintains things like the client's minsize, and size increments.
374 @param anchor The corner to keep in the same position when resizing.
375 @param x The x coordiante of the new position for the client.
376 @param y The y coordiante of the new position for the client.
377 @param w The width component of the new size for the client.
378 @param h The height component of the new size for the client.
379 @param user Specifies whether this is a user-requested change or a
380 program requested change. For program requested changes, the
381 constraints are not checked.
382 @param final If user is true, then this should specify if this is a final
383 configuration. e.g. Final should be FALSE if doing an
384 interactive move/resize, and then be TRUE for the last call
386 @param force_reply Send a ConfigureNotify to the client regardless of if
387 the position changed.
389 void client_configure_full(ObClient
*self
, ObCorner anchor
,
390 gint x
, gint y
, gint w
, gint h
,
391 gboolean user
, gboolean final
,
392 gboolean force_reply
);
394 void client_reconfigure(ObClient
*self
);
396 /*! Finds coordinates to keep a client on the screen.
397 @param self The client
398 @param x The x coord of the client, may be changed.
399 @param y The y coord of the client, may be changed.
400 @param w The width of the client.
401 @param w The height of the client.
402 @param rude Be rude about it. If false, it is only moved if it is entirely
403 not visible. If true, then make sure the window is inside the
405 @return true if the client was moved to be on-screen; false if not.
407 gboolean
client_find_onscreen(ObClient
*self
, gint
*x
, gint
*y
, gint w
, gint h
,
410 /*! Moves a client so that it is on screen if it is entirely out of the
412 @param self The client to move
413 @param rude Be rude about it. If false, it is only moved if it is entirely
414 not visible. If true, then make sure the window is inside the
417 void client_move_onscreen(ObClient
*self
, gboolean rude
);
419 /*! Fullscreen's or unfullscreen's the client window
420 @param fs true if the window should be made fullscreen; false if it should
421 be returned to normal state.
423 void client_fullscreen(ObClient
*self
, gboolean fs
);
425 /*! Iconifies or uniconifies the client window
426 @param iconic true if the window should be iconified; false if it should be
428 @param curdesk If iconic is FALSE, then this determines if the window will
429 be uniconified to the current viewable desktop (true) or to
430 its previous desktop (false)
432 void client_iconify(ObClient
*self
, gboolean iconic
, gboolean curdesk
);
434 /*! Maximize or unmaximize the client window
435 @param max true if the window should be maximized; false if it should be
436 returned to normal size.
437 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
439 void client_maximize(ObClient
*self
, gboolean max
, gint dir
);
441 /*! Shades or unshades the client window
442 @param shade true if the window should be shaded; false if it should be
445 void client_shade(ObClient
*self
, gboolean shade
);
447 /*! Hilite the window to make the user notice it */
448 void client_hilite(ObClient
*self
, gboolean hilite
);
450 /*! Request the client to close its window */
451 void client_close(ObClient
*self
);
453 /*! Kill the client off violently */
454 void client_kill(ObClient
*self
);
456 /*! Sends the window to the specified desktop
457 @param donthide If TRUE, the window will not be shown/hidden after its
458 desktop has been changed. Generally this should be FALSE. */
459 void client_set_desktop(ObClient
*self
, guint target
, gboolean donthide
);
461 /*! Show the client if it should be shown, and hide it if it should be
462 hidden. This is for example, when switching desktops.
464 void client_showhide(ObClient
*self
);
466 /*! Validate client, by making sure no Destroy or Unmap events exist in
467 the event queue for the window.
468 @return true if the client is valid; false if the client has already
469 been unmapped/destroyed, and so is invalid.
471 gboolean
client_validate(ObClient
*self
);
473 /*! Sets the wm_state to the specified value */
474 void client_set_wm_state(ObClient
*self
, glong state
);
476 /*! Adjusts the window's net_state
477 This should not be called as part of the window mapping process! It is for
478 use when updating the state post-mapping.<br>
479 client_apply_startup_state is used to do the same things during the mapping
482 void client_set_state(ObClient
*self
, Atom action
, glong data1
, glong data2
);
484 /* Given a ObClient, find the client that focus would actually be sent to if
485 you wanted to give focus to the specified ObClient. Will return the same
486 ObClient passed to it or another ObClient if appropriate. */
487 ObClient
*client_focus_target(ObClient
*self
);
489 /*! Returns what client_focus would return if passed the same client, but
490 without focusing it or modifying the focus order lists. */
491 gboolean
client_can_focus(ObClient
*self
);
493 /*! Attempt to focus the client window
494 NOTE: You should validate the client before calling this !! (client_validate)
496 gboolean
client_focus(ObClient
*self
);
498 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
499 when the user deliberately selects a window for use.
500 @param here If true, then the client is brought to the current desktop;
501 otherwise, the desktop is changed to where the client lives.
502 @param user If true, then a user action is what requested the activation;
503 otherwise, it means an application requested it on its own
505 void client_activate(ObClient
*self
, gboolean here
, gboolean user
);
507 /*! Calculates the stacking layer for the client window */
508 void client_calc_layer(ObClient
*self
);
510 /*! Raises the client to the top of its stacking layer
511 Normally actions call to the client_* functions to make stuff go, but this
512 one is an exception. It just fires off an action, which will be queued.
513 This is because stacking order rules can be changed by focus state, and so
514 any time focus changes you have to wait for it to complete before you can
515 properly restart windows. As such, this only queues an action for later
516 execution, once the focus change has gone through.
518 void client_raise(ObClient
*self
);
520 /*! Lowers the client to the bottom of its stacking layer
521 Normally actions call to the client_* functions to make stuff go, but this
522 one is an exception. It just fires off an action, which will be queued.
523 This is because stacking order rules can be changed by focus state, and so
524 any time focus changes you have to wait for it to complete before you can
525 properly restart windows. As such, this only queues an action for later
526 execution, once the focus change has gone through.
528 void client_lower(ObClient
*self
);
530 /*! Updates the window's transient status, and any parents of it */
531 void client_update_transient_for(ObClient
*self
);
532 /*! Update the protocols that the window supports and adjusts things if they
534 void client_update_protocols(ObClient
*self
);
535 /*! Updates the WMNormalHints and adjusts things if they change */
536 void client_update_normal_hints(ObClient
*self
);
538 /*! Updates the WMHints and adjusts things if they change
539 @param initstate Whether to read the initial_state property from the
540 WMHints. This should only be used during the mapping
543 void client_update_wmhints(ObClient
*self
);
544 /*! Updates the window's title and icon title */
545 void client_update_title(ObClient
*self
);
546 /*! Updates the window's application name and class */
547 void client_update_class(ObClient
*self
);
548 /*! Updates the strut for the client */
549 void client_update_strut(ObClient
*self
);
550 /*! Updates the window's icons */
551 void client_update_icons(ObClient
*self
);
552 /*! Updates the window's user time */
553 void client_update_user_time(ObClient
*self
, gboolean new_event
);
555 /*! Set up what decor should be shown on the window and what functions should
556 be allowed (ObClient::decorations and ObClient::functions).
557 This also updates the NET_WM_ALLOWED_ACTIONS hint.
559 void client_setup_decor_and_functions(ObClient
*self
);
561 /*! Retrieves the window's type and sets ObClient->type */
562 void client_get_type(ObClient
*self
);
564 const ObClientIcon
*client_icon(ObClient
*self
, gint w
, gint h
);
566 /*! Searches a client's direct parents for a focused window. The function does
567 not check for the passed client, only for *ONE LEVEL* of its parents.
568 If no focused parentt is found, NULL is returned.
570 ObClient
*client_search_focus_parent(ObClient
*self
);
572 /*! Searches a client's transients for a focused window. The function does not
573 check for the passed client, only for its transients.
574 If no focused transient is found, NULL is returned.
576 ObClient
*client_search_focus_tree(ObClient
*self
);
578 /*! Searches a client's transient tree for a focused window. The function
579 searches up the tree and down other branches as well as the passed client's.
580 If no focused client is found, NULL is returned.
582 ObClient
*client_search_focus_tree_full(ObClient
*self
);
584 /*! Return a modal child of the client window that can be focused.
585 @return A modal child of the client window that can be focused, or 0 if
588 ObClient
*client_search_modal_child(ObClient
*self
);
590 /*! Returns a list of top-level windows which this is a transient for.
591 It will only contain more than 1 element if the client is transient for its
594 GSList
*client_search_all_top_parents(ObClient
*self
);
596 /*! Returns a window's top level parent. This only counts direct parents,
597 not groups if it is transient for its group.
599 ObClient
*client_search_top_parent(ObClient
*self
);
601 /*! Is one client a direct child of another (i.e. not through the group.) */
602 gboolean
client_is_direct_child(ObClient
*parent
, ObClient
*child
);
604 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
605 returns the searched for parent if it is a parent, or NULL if not. */
606 ObClient
*client_search_parent(ObClient
*self
, ObClient
*search
);
608 /*! Search for a transient of a client. The transient is returned if it is one,
609 NULL is returned if the given search is not a transient of the client. */
610 ObClient
*client_search_transient(ObClient
*self
, ObClient
*search
);
612 /*! Return the "closest" client in the given direction */
613 ObClient
*client_find_directional(ObClient
*c
, ObDirection dir
);
615 /*! Return the closest edge in the given direction */
616 gint
client_directional_edge_search(ObClient
*c
, ObDirection dir
, gboolean hang
);
618 /*! Set a client window to be above/below other clients.
619 @layer < 0 indicates the client should be placed below other clients.<br>
620 = 0 indicates the client should be placed with other clients.<br>
621 > 0 indicates the client should be placed above other clients.
623 void client_set_layer(ObClient
*self
, gint layer
);
625 /*! Set a client window to have decorations or not */
626 void client_set_undecorated(ObClient
*self
, gboolean undecorated
);
628 guint
client_monitor(ObClient
*self
);
630 void client_update_sm_client_id(ObClient
*self
);
632 ObClient
* client_under_pointer();
634 gboolean
client_has_group_siblings(ObClient
*self
);