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