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