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