provide function to tell if a client has any group siblings
[dana/openbox.git] / openbox / client.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    client.h for the Openbox window manager
4    Copyright (c) 2003        Ben Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef __client_h
20 #define __client_h
21
22 #include "misc.h"
23 #include "mwm.h"
24 #include "geom.h"
25 #include "stacking.h"
26 #include "render/color.h"
27
28 #include <glib.h>
29 #include <X11/Xlib.h>
30
31 struct _ObFrame;
32 struct _ObGroup;
33 struct _ObSessionState;
34
35 typedef struct _ObClient     ObClient;
36 typedef struct _ObClientIcon ObClientIcon;
37
38 /* The value in client.transient_for indicating it is a transient for its
39    group instead of for a single window */
40 #define OB_TRAN_GROUP ((void*)~0l)
41
42 /*! Holds an icon in ARGB format */
43 struct _ObClientIcon
44 {
45     gint width;
46     gint height;
47     RrPixel32 *data;
48 };
49      
50 /*! Possible window types */
51 typedef enum
52 {
53     OB_CLIENT_TYPE_DESKTOP, /*!< A desktop (bottom-most window) */
54     OB_CLIENT_TYPE_DOCK,    /*!< A dock bar/panel window */
55     OB_CLIENT_TYPE_TOOLBAR, /*!< A toolbar window, pulled off an app */
56     OB_CLIENT_TYPE_MENU,    /*!< An unpinned menu from an app */
57     OB_CLIENT_TYPE_UTILITY, /*!< A small utility window such as a palette */
58     OB_CLIENT_TYPE_SPLASH,  /*!< A splash screen window */
59     OB_CLIENT_TYPE_DIALOG,  /*!< A dialog window */
60     OB_CLIENT_TYPE_NORMAL   /*!< A normal application window */
61 } ObClientType;
62
63 /*! The things the user can do to the client window */
64 typedef enum
65 {
66     OB_CLIENT_FUNC_RESIZE     = 1 << 0, /*!< Allow user resizing */
67     OB_CLIENT_FUNC_MOVE       = 1 << 1, /*!< Allow user moving */
68     OB_CLIENT_FUNC_ICONIFY    = 1 << 2, /*!< Allow to be iconified */
69     OB_CLIENT_FUNC_MAXIMIZE   = 1 << 3, /*!< Allow to be maximized */
70     OB_CLIENT_FUNC_SHADE      = 1 << 4, /*!< Allow to be shaded */
71     OB_CLIENT_FUNC_FULLSCREEN = 1 << 5, /*!< Allow to be made fullscreen */
72     OB_CLIENT_FUNC_CLOSE      = 1 << 6  /*!< Allow to be closed */
73 } ObFunctions;
74
75 struct _ObClient
76 {
77     ObWindow obwin;
78
79     Window  window;
80
81     /*! The window's decorations. NULL while the window is being managed! */
82     struct _ObFrame *frame;
83
84     /*! The number of unmap events to ignore on the window */
85     int ignore_unmaps;
86
87     /*! The id of the group the window belongs to */
88     struct _ObGroup *group;
89
90     /*! Saved session data to apply to this client */
91     struct _ObSessionState *session;
92
93     /*! Whether or not the client is a transient window. This is guaranteed to 
94       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
95       transient_for == NULL. */
96     gboolean transient;
97     /*! The client which this client is a transient (child) for.
98       A value of TRAN_GROUP signifies that the window is a transient for all
99       members of its ObGroup, and is not a valid pointer to be followed in this
100       case.
101      */
102     ObClient *transient_for;
103     /*! The clients which are transients (children) of this client */
104     GSList *transients;
105     /*! The desktop on which the window resides (0xffffffff for all
106       desktops) */
107     guint desktop;
108
109     /*! The startup id for the startup-notification protocol. This will be
110       NULL if a startup id is not set. */
111     gchar *startup_id;
112
113     /*! Normal window title */
114     gchar *title;
115     /*! The count for the title. When another window with the same title
116       exists, a count will be appended to it. */
117     guint title_count;
118     /*! Window title when iconified */
119     gchar *icon_title;
120
121     /*! The application that created the window */
122     gchar *name;
123     /*! The class of the window, can used for grouping */
124     gchar *class;
125     /*! The specified role of the window, used for identification */
126     gchar *role;
127     /*! The session client id for the window. *This can be NULL!* */
128     gchar *sm_client_id;
129
130     /*! The type of window (what its function is) */
131     ObClientType type;
132
133     /*! Position and size of the window
134       This will not always be the actual position of the window on screen, it
135       is, rather, the position requested by the client, to which the window's
136       gravity is applied.
137     */
138     Rect area;
139
140     /*! Position and size of the window prior to being maximized */
141     Rect pre_max_area;
142     /*! Position and size of the window prior to being fullscreened */
143     Rect pre_fullscreen_area;
144
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.
148     */
149     StrutPartial strut;
150      
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.
156     */
157     Size logical_size;
158
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.
162     */
163     guint border_width;
164
165     /*! The minimum aspect ratio the client window can be sized to.
166       A value of 0 means this is ignored.
167     */
168     float min_ratio;
169     /*! The maximum aspect ratio the client window can be sized to.
170       A value of 0 means this is ignored.
171     */
172     float max_ratio;
173   
174     /*! The minimum size of the client window
175       If the min is > the max, then the window is not resizable
176     */
177     Size min_size;
178     /*! The maximum size of the client window
179       If the min is > the max, then the window is not resizable
180     */
181     Size max_size;
182     /*! The size of increments to resize the client window by */
183     Size size_inc;
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
187     */
188     Size base_size;
189
190     /*! Window decoration and functionality hints */
191     ObMwmHints mwmhints;
192   
193     /*! Where to place the decorated window in relation to the undecorated
194       window */
195     int gravity;
196
197     /*! The state of the window, one of WithdrawnState, IconicState, or
198       NormalState */
199     long wmstate;
200
201     /*! True if the client supports the delete_window protocol */
202     gboolean delete_window;
203   
204     /*! Was the window's position requested by the application? if not, we
205       should place the window ourselves when it first appears */
206     gboolean positioned;
207   
208     /*! Can the window receive input focus? */
209     gboolean can_focus;
210     /*! Urgency flag */
211     gboolean urgent;
212     /*! Notify the window when it receives focus? */
213     gboolean focus_notify;
214
215     /*! The window uses shape extension to be non-rectangular? */
216     gboolean shaped;
217
218     /*! The window is modal, so it must be processed before any windows it is
219       related to can be focused */
220     gboolean modal;
221     /*! Only the window's titlebar is displayed */
222     gboolean shaded;
223     /*! The window is iconified */
224     gboolean iconic;
225     /*! The window is maximized to fill the screen vertically */
226     gboolean max_vert;
227     /*! The window is maximized to fill the screen horizontally */
228     gboolean max_horz;
229     /*! The window should not be displayed by pagers */
230     gboolean skip_pager;
231     /*! The window should not be displayed by taskbars */
232     gboolean skip_taskbar;
233     /*! The window is a 'fullscreen' window, and should be on top of all
234       others */
235     gboolean fullscreen;
236     /*! The window should be on top of other windows of the same type.
237       above takes priority over below. */
238     gboolean above;
239     /*! The window should be underneath other windows of the same type.
240       above takes priority over below. */
241     gboolean below;
242
243     /*! The layer in which the window will be stacked, windows in lower layers
244       are always below windows in higher layers. */
245     ObStackingLayer layer;
246
247     /*! A bitmask of values in the ObFrameDecorations enum
248       The values in the variable are the decorations that the client wants to
249       be displayed around it.
250     */
251     guint decorations;
252
253     /*! A user option. When this is set to TRUE the client will not ever
254       be decorated.
255     */
256     gboolean undecorated;
257
258     /*! A bitmask of values in the ObFunctions enum
259       The values in the variable specify the ways in which the user is allowed
260       to modify this window.
261     */
262     guint functions;
263
264     /*! Icons for the client as specified on the client window */
265     ObClientIcon *icons;
266     /*! The number of icons in icons */
267     guint nicons;
268 };
269
270 extern GList *client_list;
271
272 void client_startup(gboolean reconfig);
273 void client_shutdown(gboolean reconfig);
274
275 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
276
277 void client_add_destructor(ObClientDestructor func, gpointer data);
278 void client_remove_destructor(ObClientDestructor func);
279
280 /*! Manages all existing windows */
281 void client_manage_all();
282 /*! Manages a given window */
283 void client_manage(Window win);
284 /*! Unmanages all managed windows */
285 void client_unmanage_all();
286 /*! Unmanages a given client */
287 void client_unmanage(ObClient *client);
288
289 /*! Sets the client list on the root window from the client_list */
290 void client_set_list();
291
292 /*! Determines if the client should be shown or hidden currently.
293   @return TRUE if it should be visible; otherwise, FALSE.
294 */
295 gboolean client_should_show(ObClient *self);
296
297 /*! Returns if the window should be treated as a normal window.
298   Some windows (desktops, docks, splash screens) have special rules applied
299   to them in a number of places regarding focus or user interaction. */
300 gboolean client_normal(ObClient *self);
301
302 /* Returns if the window is focused */
303 gboolean client_focused(ObClient *self);
304
305 #define client_move(self, x, y) \
306   client_configure(self, OB_CORNER_TOPLEFT, x, y, \
307                    self->area.width, self->area.height, \
308                    TRUE, TRUE)
309 #define client_resize(self, w, h) \
310   client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
311                    w, h, TRUE, TRUE)
312 #define client_move_resize(self, x, y, w, h) \
313   client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
314
315 #define client_configure(self, anchor, x, y, w, h, user, final) \
316   client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
317
318 /*! Move and/or resize the window.
319   This also maintains things like the client's minsize, and size increments.
320   @param anchor The corner to keep in the same position when resizing.
321   @param x The x coordiante of the new position for the client.
322   @param y The y coordiante of the new position for the client.
323   @param w The width component of the new size for the client.
324   @param h The height component of the new size for the client.
325   @param user Specifies whether this is a user-requested change or a
326               program requested change. For program requested changes, the
327               constraints are not checked.
328   @param final If user is true, then this should specify if this is a final
329                configuration. e.g. Final should be FALSE if doing an
330                interactive move/resize, and then be TRUE for the last call
331                only.
332   @param force_reply Send a ConfigureNotify to the client regardless of if
333                      the position changed.
334 */
335 void client_configure_full(ObClient *self, ObCorner anchor,
336                            int x, int y, int w, int h,
337                            gboolean user, gboolean final,
338                            gboolean force_reply);
339
340 void client_reconfigure(ObClient *self);
341
342 /*! Finds coordinates to keep a client on the screen.
343   @param self The client
344   @param x The x coord of the client, may be changed.
345   @param y The y coord of the client, may be changed.
346   @param w The width of the client.
347   @param w The height of the client.
348   @param rude Be rude about it. If false, it is only moved if it is entirely
349               not visible. If true, then make sure the window is inside the
350               struts if possible.
351   @return true if the client was moved to be on-screen; false if not.
352 */
353 gboolean client_find_onscreen(ObClient *self, int *x, int *y, int w, int h,
354                               gboolean rude);
355
356 /*! Moves a client so that it is on screen if it is entirely out of the
357   viewable screen.
358   @param self The client to move
359   @param rude Be rude about it. If false, it is only moved if it is entirely
360               not visible. If true, then make sure the window is inside the
361               struts if possible.
362 */
363 void client_move_onscreen(ObClient *self, gboolean rude);
364
365 /*! Fullscreen's or unfullscreen's the client window
366   @param fs true if the window should be made fullscreen; false if it should
367             be returned to normal state.
368   @param savearea true to have the client's current size and position saved;
369                   otherwise, they are not. You should not save when mapping a
370                   new window that is set to fullscreen. This has no effect
371                   when restoring a window from fullscreen.
372 */
373 void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
374
375 /*! Iconifies or uniconifies the client window
376   @param iconic true if the window should be iconified; false if it should be
377                 restored.
378   @param curdesk If iconic is FALSE, then this determines if the window will
379                  be uniconified to the current viewable desktop (true) or to
380                  its previous desktop (false)
381 */
382 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
383
384 /*! Maximize or unmaximize the client window
385   @param max true if the window should be maximized; false if it should be
386              returned to normal size.
387   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
388   @param savearea true to have the client's current size and position saved;
389                   otherwise, they are not. You should not save when mapping a
390                   new window that is set to fullscreen. This has no effect
391                   when unmaximizing a window.
392 */
393 void client_maximize(ObClient *self, gboolean max, int dir,
394                      gboolean savearea);
395
396 /*! Shades or unshades the client window
397   @param shade true if the window should be shaded; false if it should be
398                unshaded.
399 */
400 void client_shade(ObClient *self, gboolean shade);
401
402 /*! Request the client to close its window */
403 void client_close(ObClient *self);
404
405 /*! Kill the client off violently */
406 void client_kill(ObClient *self);
407
408 /*! Sends the window to the specified desktop
409   @param donthide If TRUE, the window will not be shown/hidden after its
410          desktop has been changed. Generally this should be FALSE. */
411 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
412
413 /*! Validate client, by making sure no Destroy or Unmap events exist in
414   the event queue for the window.
415   @return true if the client is valid; false if the client has already
416           been unmapped/destroyed, and so is invalid.
417 */
418 gboolean client_validate(ObClient *self);
419
420 /*! Sets the wm_state to the specified value */
421 void client_set_wm_state(ObClient *self, long state);
422
423 /*! Adjusts the window's net_state
424   This should not be called as part of the window mapping process! It is for
425   use when updating the state post-mapping.<br>
426   client_apply_startup_state is used to do the same things during the mapping
427   process.
428 */
429 void client_set_state(ObClient *self, Atom action, long data1, long data2);
430
431 /* Given a ObClient, find the client that focus would actually be sent to if
432    you wanted to give focus to the specified ObClient. Will return the same
433    ObClient passed to it or another ObClient if appropriate. */
434 ObClient *client_focus_target(ObClient *self);
435
436 /*! Returns what client_focus would return if passed the same client, but
437   without focusing it or modifying the focus order lists. */
438 gboolean client_can_focus(ObClient *self);
439
440 /*! Attempt to focus the client window */
441 gboolean client_focus(ObClient *self);
442
443 /*! Remove focus from the client window */
444 void client_unfocus(ObClient *self);
445
446 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
447   when the user deliberately selects a window for use.
448   @param here If true, then the client is brought to the current desktop;
449               otherwise, the desktop is changed to where the client lives.
450 */
451 void client_activate(ObClient *self, gboolean here);
452
453 /*! Calculates the stacking layer for the client window */
454 void client_calc_layer(ObClient *self);
455
456 /*! Raises the client to the top of its stacking layer
457   Normally actions call to the client_* functions to make stuff go, but this
458   one is an exception. It just fires off an action, which will be queued.
459   This is because stacking order rules can be changed by focus state, and so
460   any time focus changes you have to wait for it to complete before you can
461   properly restart windows. As such, this only queues an action for later
462   execution, once the focus change has gone through.
463 */
464 void client_raise(ObClient *self);
465
466 /*! Lowers the client to the bottom of its stacking layer
467   Normally actions call to the client_* functions to make stuff go, but this
468   one is an exception. It just fires off an action, which will be queued.
469   This is because stacking order rules can be changed by focus state, and so
470   any time focus changes you have to wait for it to complete before you can
471   properly restart windows. As such, this only queues an action for later
472   execution, once the focus change has gone through.
473 */
474 void client_lower(ObClient *self);
475
476 /*! Updates the window's transient status, and any parents of it */
477 void client_update_transient_for(ObClient *self);
478 /*! Update the protocols that the window supports and adjusts things if they
479   change */
480 void client_update_protocols(ObClient *self);
481 /*! Updates the WMNormalHints and adjusts things if they change */
482 void client_update_normal_hints(ObClient *self);
483
484 /*! Updates the WMHints and adjusts things if they change
485   @param initstate Whether to read the initial_state property from the
486                    WMHints. This should only be used during the mapping
487                    process.
488 */
489 void client_update_wmhints(ObClient *self);
490 /*! Updates the window's title and icon title */
491 void client_update_title(ObClient *self);
492 /*! Updates the window's application name and class */
493 void client_update_class(ObClient *self);
494 /*! Updates the strut for the client */
495 void client_update_strut(ObClient *self);
496 /*! Updates the window's icons */
497 void client_update_icons(ObClient *self);
498
499 /*! Set up what decor should be shown on the window and what functions should
500   be allowed (ObClient::decorations and ObClient::functions).
501   This also updates the NET_WM_ALLOWED_ACTIONS hint.
502 */
503 void client_setup_decor_and_functions(ObClient *self);
504
505 /*! Retrieves the window's type and sets ObClient->type */
506 void client_get_type(ObClient *self);
507
508 const ObClientIcon *client_icon(ObClient *self, int w, int h);
509
510 /*! Searches a client's direct parents for a focused window. The function does
511   not check for the passed client, only for *ONE LEVEL* of its parents.
512   If no focused parentt is found, NULL is returned.
513 */
514 ObClient *client_search_focus_parent(ObClient *self);
515
516 /*! Searches a client's transients for a focused window. The function does not
517   check for the passed client, only for its transients.
518   If no focused transient is found, NULL is returned.
519 */
520 ObClient *client_search_focus_tree(ObClient *self);
521
522 /*! Searches a client's transient tree for a focused window. The function
523   searches up the tree and down other branches as well as the passed client's.
524   If no focused client is found, NULL is returned.
525 */
526 ObClient *client_search_focus_tree_full(ObClient *self);
527
528 /*! Return a modal child of the client window that can be focused.
529     @return A modal child of the client window that can be focused, or 0 if
530             none was found.
531 */
532 ObClient *client_search_modal_child(ObClient *self);
533
534 ObClient *client_search_top_transient(ObClient *self);
535
536 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
537   returns the searched for parent if it is a parent, or NULL if not. */
538 ObClient *client_search_parent(ObClient *self, ObClient *search);
539
540 /*! Search for a transient of a client. The transient is returned if it is one,
541   NULL is returned if the given search is not a transient of the client. */
542 ObClient *client_search_transient(ObClient *self, ObClient *search);
543
544 /*! Return the "closest" client in the given direction */
545 ObClient *client_find_directional(ObClient *c, ObDirection dir);
546
547 /*! Return the closest edge in the given direction */
548 int client_directional_edge_search(ObClient *c, ObDirection dir);
549
550 /*! Set a client window to be above/below other clients.
551   @layer < 0 indicates the client should be placed below other clients.<br>
552          = 0 indicates the client should be placed with other clients.<br>
553          > 0 indicates the client should be placed above other clients.
554 */
555 void client_set_layer(ObClient *self, int layer);
556
557 /*! Set a client window to have decorations or not */
558 void client_set_undecorated(ObClient *self, gboolean undecorated);
559
560 guint client_monitor(ObClient *self);
561
562 void client_update_sm_client_id(ObClient *self);
563
564 ObClient* client_under_pointer();
565
566 gboolean client_has_group_siblings(ObClient *self);
567
568 #endif