a whole lot of changes to the moving/resizing code. it was broken for non-northwest...
[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
122     /*! The application that created the window */
123     gchar *name;
124     /*! The class of the window, can used for grouping */
125     gchar *class;
126     /*! The specified role of the window, used for identification */
127     gchar *role;
128     /*! The session client id for the window. *This can be NULL!* */
129     gchar *sm_client_id;
130
131     /*! The type of window (what its function is) */
132     ObClientType type;
133
134     /*! Position and size of the window
135       This will not always be the actual position of the window on screen, it
136       is, rather, the position requested by the client, to which the window's
137       gravity is applied.
138     */
139     Rect area;
140
141     /*! Position of the client window relative to the root window */
142     Point root_pos;
143
144     /*! Position and size of the window prior to being maximized */
145     Rect pre_max_area;
146     /*! Position and size of the window prior to being fullscreened */
147     Rect pre_fullscreen_area;
148
149     /*! The window's strut
150       The strut defines areas of the screen that are marked off-bounds for
151       window placement. In theory, where this window exists.
152     */
153     StrutPartial strut;
154      
155     /*! The logical size of the window
156       The "logical" size of the window is refers to the user's perception of
157       the size of the window, and is the value that should be displayed to the
158       user. For example, with xterms, this value it the number of characters
159       being displayed in the terminal, instead of the number of pixels.
160     */
161     Size logical_size;
162
163     /*! Width of the border on the window.
164       The window manager will set this to 0 while the window is being managed,
165       but needs to restore it afterwards, so it is saved here.
166     */
167     guint border_width;
168
169     /*! The minimum aspect ratio the client window can be sized to.
170       A value of 0 means this is ignored.
171     */
172     gfloat min_ratio;
173     /*! The maximum aspect ratio the client window can be sized to.
174       A value of 0 means this is ignored.
175     */
176     gfloat max_ratio;
177   
178     /*! The minimum size of the client window
179       If the min is > the max, then the window is not resizable
180     */
181     Size min_size;
182     /*! The maximum size of the client window
183       If the min is > the max, then the window is not resizable
184     */
185     Size max_size;
186     /*! The size of increments to resize the client window by */
187     Size size_inc;
188     /*! The base size of the client window
189       This value should be subtracted from the window's actual size when
190       displaying its size to the user, or working with its min/max size
191     */
192     Size base_size;
193
194     /*! Window decoration and functionality hints */
195     ObMwmHints mwmhints;
196
197     /*! The client's specified colormap */
198     Colormap colormap;
199   
200     /*! Where to place the decorated window in relation to the undecorated
201       window */
202     gint gravity;
203
204     /*! The state of the window, one of WithdrawnState, IconicState, or
205       NormalState */
206     glong wmstate;
207
208     /*! True if the client supports the delete_window protocol */
209     gboolean delete_window;
210   
211     /*! Was the window's position requested by the application or the user?
212       if by the application, we force it completely onscreen, if by the user
213       we only force it if it tries to go completely offscreen, if neither, we
214       should place the window ourselves when it first appears */
215     guint positioned;
216   
217     /*! Can the window receive input focus? */
218     gboolean can_focus;
219     /*! Notify the window when it receives focus? */
220     gboolean focus_notify;
221
222 #ifdef SYNC
223     /*! The client wants to sync during resizes */
224     gboolean sync_request;
225     /*! The XSync counter used for synchronizing during resizes */
226     guint32 sync_counter;
227     /*! The value we're waiting for the counter to reach */
228     gulong sync_counter_value;
229 #endif
230
231     /*! The window uses shape extension to be non-rectangular? */
232     gboolean shaped;
233
234     /*! The window is modal, so it must be processed before any windows it is
235       related to can be focused */
236     gboolean modal;
237     /*! Only the window's titlebar is displayed */
238     gboolean shaded;
239     /*! The window is iconified */
240     gboolean iconic;
241     /*! The window is maximized to fill the screen vertically */
242     gboolean max_vert;
243     /*! The window is maximized to fill the screen horizontally */
244     gboolean max_horz;
245     /*! The window should not be displayed by pagers */
246     gboolean skip_pager;
247     /*! The window should not be displayed by taskbars */
248     gboolean skip_taskbar;
249     /*! The window is a 'fullscreen' window, and should be on top of all
250       others */
251     gboolean fullscreen;
252     /*! The window should be on top of other windows of the same type.
253       above takes priority over below. */
254     gboolean above;
255     /*! The window should be underneath other windows of the same type.
256       above takes priority over below. */
257     gboolean below;
258     /*! Demands attention flag */
259     gboolean demands_attention;
260
261     /*! The layer in which the window will be stacked, windows in lower layers
262       are always below windows in higher layers. */
263     ObStackingLayer layer;
264
265     /*! A bitmask of values in the ObFrameDecorations enum
266       The values in the variable are the decorations that the client wants to
267       be displayed around it.
268     */
269     guint decorations;
270
271     /*! A user option. When this is set to TRUE the client will not ever
272       be decorated.
273     */
274     gboolean undecorated;
275
276     /*! A bitmask of values in the ObFunctions enum
277       The values in the variable specify the ways in which the user is allowed
278       to modify this window.
279     */
280     guint functions;
281
282     /*! Icons for the client as specified on the client window */
283     ObClientIcon *icons;
284     /*! The number of icons in icons */
285     guint nicons;
286
287     guint32 user_time;
288 };
289
290 struct _ObAppSettings
291 {
292     gchar *class;
293     gchar *name;
294     gchar *role;
295
296     Point position;
297     gboolean center_x;
298     gboolean center_y;
299     gboolean pos_given;
300
301     guint desktop;
302     gint shade;
303     gint decor;
304     gint focus;
305     gint head;
306     gint iconic;
307     gint skip_pager;
308     gint skip_taskbar;
309     gint max_horz;
310     gint max_vert;
311     gint fullscreen;
312
313     gint layer;
314 };
315
316 extern GList *client_list;
317
318 void client_startup(gboolean reconfig);
319 void client_shutdown(gboolean reconfig);
320
321 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
322
323 void client_add_destructor(ObClientDestructor func, gpointer data);
324 void client_remove_destructor(ObClientDestructor func);
325
326 /*! Manages all existing windows */
327 void client_manage_all();
328 /*! Manages a given window */
329 void client_manage(Window win);
330 /*! Unmanages all managed windows */
331 void client_unmanage_all();
332 /*! Unmanages a given client */
333 void client_unmanage(ObClient *client);
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 focused */
349 gboolean client_focused(ObClient *self);
350
351 /*! Convery a position/size from a given gravity to the client's true gravity
352  */
353 void client_convert_gravity(ObClient *client, gint gravity, gint *x, gint *y,
354                             gint w, gint h);
355
356 #define client_move(self, x, y) \
357   client_configure(self, x, y, self->area.width, self->area.height, \
358                    TRUE, TRUE)
359 #define client_resize(self, w, h) \
360   client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE)
361 #define client_move_resize(self, x, y, w, h) \
362   client_configure(self, x, y, w, h, TRUE, TRUE)
363
364 #define client_configure(self, x, y, w, h, user, final) \
365   client_configure_full(self, x, y, w, h, user, final, FALSE)
366
367 /*! Figure out where a window will end up and what size it will be if you
368   told it to move/resize to these coordinates.
369
370   These values are what client_configure_full will give the window.
371
372   @param x The x coordiante of the new position for the client.
373   @param y The y coordiante of the new position for the client.
374   @param w The width component of the new size for the client.
375   @param h The height component of the new size for the client.
376   @param logicalw Returns the width component of the new logical width.
377                   This value is only returned when the new w or h calculated
378                   differ from the ones passed in.
379   @param logicalh Returns the height component of the new logical height.
380                   This value is only returned when the new w or h calculated
381                   differ from the ones passed in.
382   @param user Specifies whether this is a user-requested change or a
383               program requested change. For program requested changes, the
384               constraints are not checked.
385 */
386 void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
387                           gint *logicalw, gint *logicalh,
388                           gboolean user);
389
390 /*! Move and/or resize the window.
391   This also maintains things like the client's minsize, and size increments.
392   @param x The x coordiante of the new position for the client.
393   @param y The y coordiante of the new position for the client.
394   @param w The width component of the new size for the client.
395   @param h The height component of the new size for the client.
396   @param user Specifies whether this is a user-requested change or a
397               program requested change. For program requested changes, the
398               constraints are not checked.
399   @param final If user is true, then this should specify if this is a final
400                configuration. e.g. Final should be FALSE if doing an
401                interactive move/resize, and then be TRUE for the last call
402                only.
403   @param force_reply Send a ConfigureNotify to the client regardless of if
404                      the position changed.
405 */
406 void client_configure_full(ObClient *self, gint x, gint y, gint w, gint h,
407                            gboolean user, gboolean final,
408                            gboolean force_reply);
409
410 void client_reconfigure(ObClient *self);
411
412 /*! Finds coordinates to keep a client on the screen.
413   @param self The client
414   @param x The x coord of the client, may be changed.
415   @param y The y coord of the client, may be changed.
416   @param w The width of the client.
417   @param w The height of the client.
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   @return true if the client was moved to be on-screen; false if not.
422 */
423 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
424                               gboolean rude);
425
426 /*! Moves a client so that it is on screen if it is entirely out of the
427   viewable screen.
428   @param self The client to move
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 */
433 void client_move_onscreen(ObClient *self, gboolean rude);
434
435 /*! Fullscreen's or unfullscreen's the client window
436   @param fs true if the window should be made fullscreen; false if it should
437             be returned to normal state.
438 */
439 void client_fullscreen(ObClient *self, gboolean fs);
440
441 /*! Iconifies or uniconifies the client window
442   @param iconic true if the window should be iconified; false if it should be
443                 restored.
444   @param curdesk If iconic is FALSE, then this determines if the window will
445                  be uniconified to the current viewable desktop (true) or to
446                  its previous desktop (false)
447 */
448 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
449
450 /*! Maximize or unmaximize the client window
451   @param max true if the window should be maximized; false if it should be
452              returned to normal size.
453   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
454 */
455 void client_maximize(ObClient *self, gboolean max, gint dir);
456
457 /*! Shades or unshades the client window
458   @param shade true if the window should be shaded; false if it should be
459                unshaded.
460 */
461 void client_shade(ObClient *self, gboolean shade);
462
463 /*! Hilite the window to make the user notice it */
464 void client_hilite(ObClient *self, gboolean hilite);
465
466 /*! Request the client to close its window */
467 void client_close(ObClient *self);
468
469 /*! Kill the client off violently */
470 void client_kill(ObClient *self);
471
472 /*! Sends the window to the specified desktop
473   @param donthide If TRUE, the window will not be shown/hidden after its
474          desktop has been changed. Generally this should be FALSE. */
475 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
476
477 /*! Show the client if it should be shown. */
478 void client_show(ObClient *self);
479
480 /*! Show the client if it should be shown. */
481 void client_hide(ObClient *self);
482
483 /*! Show the client if it should be shown, and hide it if it should be
484   hidden. This is for example, when switching desktops.
485 */
486 void client_showhide(ObClient *self);
487
488 /*! Validate client, by making sure no Destroy or Unmap events exist in
489   the event queue for the window.
490   @return true if the client is valid; false if the client has already
491           been unmapped/destroyed, and so is invalid.
492 */
493 gboolean client_validate(ObClient *self);
494
495 /*! Sets the wm_state to the specified value */
496 void client_set_wm_state(ObClient *self, glong state);
497
498 /*! Adjusts the window's net_state
499   This should not be called as part of the window mapping process! It is for
500   use when updating the state post-mapping.<br>
501   client_apply_startup_state is used to do the same things during the mapping
502   process.
503 */
504 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
505
506 /* Given a ObClient, find the client that focus would actually be sent to if
507    you wanted to give focus to the specified ObClient. Will return the same
508    ObClient passed to it or another ObClient if appropriate. */
509 ObClient *client_focus_target(ObClient *self);
510
511 /*! Returns what client_focus would return if passed the same client, but
512   without focusing it or modifying the focus order lists. */
513 gboolean client_can_focus(ObClient *self);
514
515 /*! Attempt to focus the client window
516   NOTE: You should validate the client before calling this !! (client_validate)
517 */
518 gboolean client_focus(ObClient *self);
519
520 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
521   when the user deliberately selects a window for use.
522   @param here If true, then the client is brought to the current desktop;
523               otherwise, the desktop is changed to where the client lives.
524   @param user If true, then a user action is what requested the activation;
525               otherwise, it means an application requested it on its own
526 */
527 void client_activate(ObClient *self, gboolean here, gboolean user);
528
529 /*! Calculates the stacking layer for the client window */
530 void client_calc_layer(ObClient *self);
531
532 /*! Raises the client to the top of its stacking layer
533   Normally actions call to the client_* functions to make stuff go, but this
534   one is an exception. It just fires off an action, which will be queued.
535   This is because stacking order rules can be changed by focus state, and so
536   any time focus changes you have to wait for it to complete before you can
537   properly restart windows. As such, this only queues an action for later
538   execution, once the focus change has gone through.
539 */
540 void client_raise(ObClient *self);
541
542 /*! Lowers the client to the bottom of its stacking layer
543   Normally actions call to the client_* functions to make stuff go, but this
544   one is an exception. It just fires off an action, which will be queued.
545   This is because stacking order rules can be changed by focus state, and so
546   any time focus changes you have to wait for it to complete before you can
547   properly restart windows. As such, this only queues an action for later
548   execution, once the focus change has gone through.
549 */
550 void client_lower(ObClient *self);
551
552 /*! Updates the window's transient status, and any parents of it */
553 void client_update_transient_for(ObClient *self);
554 /*! Update the protocols that the window supports and adjusts things if they
555   change */
556 void client_update_protocols(ObClient *self);
557 #ifdef SYNC
558 /*! Updates the window's sync request counter for resizes */
559 void client_update_sync_request_counter(ObClient *self);
560 #endif
561 /*! Updates the window's colormap */
562 void client_update_colormap(ObClient *self, Colormap colormap);
563 /*! Updates the WMNormalHints and adjusts things if they change */
564 void client_update_normal_hints(ObClient *self);
565
566 /*! Updates the WMHints and adjusts things if they change
567   @param initstate Whether to read the initial_state property from the
568                    WMHints. This should only be used during the mapping
569                    process.
570 */
571 void client_update_wmhints(ObClient *self);
572 /*! Updates the window's title and icon title */
573 void client_update_title(ObClient *self);
574 /*! Updates the window's application name and class */
575 void client_update_class(ObClient *self);
576 /*! Updates the strut for the client */
577 void client_update_strut(ObClient *self);
578 /*! Updates the window's icons */
579 void client_update_icons(ObClient *self);
580 /*! Updates the window's user time */
581 void client_update_user_time(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 /*! Retrieves the window's type and sets ObClient->type */
590 void client_get_type(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 window's top level parent. This only counts direct parents,
625   not groups if it is transient for its group.
626 */
627 ObClient *client_search_top_parent(ObClient *self);
628
629 /*! Is one client a direct child of another (i.e. not through the group.) */
630 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
631
632 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
633   returns the searched for parent if it is a parent, or NULL if not. */
634 ObClient *client_search_parent(ObClient *self, ObClient *search);
635
636 /*! Search for a transient of a client. The transient is returned if it is one,
637   NULL is returned if the given search is not a transient of the client. */
638 ObClient *client_search_transient(ObClient *self, ObClient *search);
639
640 /*! Return the closest edge in the given direction */
641 gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
642
643 /*! Set a client window to be above/below other clients.
644   @layer < 0 indicates the client should be placed below other clients.<br>
645          = 0 indicates the client should be placed with other clients.<br>
646          > 0 indicates the client should be placed above other clients.
647 */
648 void client_set_layer(ObClient *self, gint layer);
649
650 /*! Set a client window to have decorations or not */
651 void client_set_undecorated(ObClient *self, gboolean undecorated);
652
653 guint client_monitor(ObClient *self);
654
655 void client_update_sm_client_id(ObClient *self);
656
657 ObClient* client_under_pointer();
658
659 gboolean client_has_group_siblings(ObClient *self);
660
661 #endif