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