save windows' colormaps rather than querying them from the server every time you...
[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     /*! The window uses shape extension to be non-rectangular? */
223     gboolean shaped;
224
225     /*! The window is modal, so it must be processed before any windows it is
226       related to can be focused */
227     gboolean modal;
228     /*! Only the window's titlebar is displayed */
229     gboolean shaded;
230     /*! The window is iconified */
231     gboolean iconic;
232     /*! The window is maximized to fill the screen vertically */
233     gboolean max_vert;
234     /*! The window is maximized to fill the screen horizontally */
235     gboolean max_horz;
236     /*! The window should not be displayed by pagers */
237     gboolean skip_pager;
238     /*! The window should not be displayed by taskbars */
239     gboolean skip_taskbar;
240     /*! The window is a 'fullscreen' window, and should be on top of all
241       others */
242     gboolean fullscreen;
243     /*! The window should be on top of other windows of the same type.
244       above takes priority over below. */
245     gboolean above;
246     /*! The window should be underneath other windows of the same type.
247       above takes priority over below. */
248     gboolean below;
249     /*! Demands attention flag */
250     gboolean demands_attention;
251
252     /*! The layer in which the window will be stacked, windows in lower layers
253       are always below windows in higher layers. */
254     ObStackingLayer layer;
255
256     /*! A bitmask of values in the ObFrameDecorations enum
257       The values in the variable are the decorations that the client wants to
258       be displayed around it.
259     */
260     guint decorations;
261
262     /*! A user option. When this is set to TRUE the client will not ever
263       be decorated.
264     */
265     gboolean undecorated;
266
267     /*! A bitmask of values in the ObFunctions enum
268       The values in the variable specify the ways in which the user is allowed
269       to modify this window.
270     */
271     guint functions;
272
273     /*! Icons for the client as specified on the client window */
274     ObClientIcon *icons;
275     /*! The number of icons in icons */
276     guint nicons;
277
278     guint32 user_time;
279 };
280
281 struct _ObAppSettings
282 {
283     gchar *class;
284     gchar *name;
285     gchar *role;
286
287     Point position;
288     gboolean center_x;
289     gboolean center_y;
290     gboolean pos_given;
291
292     guint desktop;
293     gint shade;
294     gint decor;
295     gint focus;
296     gint head;
297     gint iconic;
298     gint skip_pager;
299     gint skip_taskbar;
300     gint max_horz;
301     gint max_vert;
302     gint fullscreen;
303
304     gint layer;
305 };
306
307 extern GList *client_list;
308
309 void client_startup(gboolean reconfig);
310 void client_shutdown(gboolean reconfig);
311
312 typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
313
314 void client_add_destructor(ObClientDestructor func, gpointer data);
315 void client_remove_destructor(ObClientDestructor func);
316
317 /*! Manages all existing windows */
318 void client_manage_all();
319 /*! Manages a given window */
320 void client_manage(Window win);
321 /*! Unmanages all managed windows */
322 void client_unmanage_all();
323 /*! Unmanages a given client */
324 void client_unmanage(ObClient *client);
325
326 /*! Sets the client list on the root window from the client_list */
327 void client_set_list();
328
329 /*! Determines if the client should be shown or hidden currently.
330   @return TRUE if it should be visible; otherwise, FALSE.
331 */
332 gboolean client_should_show(ObClient *self);
333
334 /*! Returns if the window should be treated as a normal window.
335   Some windows (desktops, docks, splash screens) have special rules applied
336   to them in a number of places regarding focus or user interaction. */
337 gboolean client_normal(ObClient *self);
338
339 /* Returns if the window is focused */
340 gboolean client_focused(ObClient *self);
341
342 #define client_move(self, x, y) \
343   client_configure(self, OB_CORNER_TOPLEFT, x, y, \
344                    self->area.width, self->area.height, \
345                    TRUE, TRUE)
346 #define client_resize(self, w, h) \
347   client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
348                    w, h, TRUE, TRUE)
349 #define client_move_resize(self, x, y, w, h) \
350   client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
351
352 #define client_configure(self, anchor, x, y, w, h, user, final) \
353   client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
354
355 /*! Figure out where a window will end up and what size it will be if you
356   told it to move/resize to these coordinates.
357
358   These values are what client_configure_full will give the window.
359
360   @param anchor The corner to keep in the same position when resizing.
361   @param x The x coordiante of the new position for the client.
362   @param y The y coordiante of the new position for the client.
363   @param w The width component of the new size for the client.
364   @param h The height component of the new size for the client.
365   @param logicalw Returns the width component of the new logical width.
366                   This value is only returned when the new w or h calculated
367                   differ from the ones passed in.
368   @param logicalh Returns the height component of the new logical height.
369                   This value is only returned when the new w or h calculated
370                   differ from the ones passed in.
371   @param user Specifies whether this is a user-requested change or a
372               program requested change. For program requested changes, the
373               constraints are not checked.
374 */
375 void client_try_configure(ObClient *self, ObCorner anchor,
376                           gint *x, gint *y, gint *w, gint *h,
377                           gint *logicalw, gint *logicalh,
378                           gboolean user);
379
380 /*! Move and/or resize the window.
381   This also maintains things like the client's minsize, and size increments.
382   @param anchor The corner to keep in the same position when resizing.
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 user Specifies whether this is a user-requested change or a
388               program requested change. For program requested changes, the
389               constraints are not checked.
390   @param final If user is true, then this should specify if this is a final
391                configuration. e.g. Final should be FALSE if doing an
392                interactive move/resize, and then be TRUE for the last call
393                only.
394   @param force_reply Send a ConfigureNotify to the client regardless of if
395                      the position changed.
396 */
397 void client_configure_full(ObClient *self, ObCorner anchor,
398                            gint x, gint y, gint w, gint h,
399                            gboolean user, gboolean final,
400                            gboolean force_reply);
401
402 void client_reconfigure(ObClient *self);
403
404 /*! Finds coordinates to keep a client on the screen.
405   @param self The client
406   @param x The x coord of the client, may be changed.
407   @param y The y coord of the client, may be changed.
408   @param w The width of the client.
409   @param w The height of the client.
410   @param rude Be rude about it. If false, it is only moved if it is entirely
411               not visible. If true, then make sure the window is inside the
412               struts if possible.
413   @return true if the client was moved to be on-screen; false if not.
414 */
415 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
416                               gboolean rude);
417
418 /*! Moves a client so that it is on screen if it is entirely out of the
419   viewable screen.
420   @param self The client to move
421   @param rude Be rude about it. If false, it is only moved if it is entirely
422               not visible. If true, then make sure the window is inside the
423               struts if possible.
424 */
425 void client_move_onscreen(ObClient *self, gboolean rude);
426
427 /*! Fullscreen's or unfullscreen's the client window
428   @param fs true if the window should be made fullscreen; false if it should
429             be returned to normal state.
430 */
431 void client_fullscreen(ObClient *self, gboolean fs);
432
433 /*! Iconifies or uniconifies the client window
434   @param iconic true if the window should be iconified; false if it should be
435                 restored.
436   @param curdesk If iconic is FALSE, then this determines if the window will
437                  be uniconified to the current viewable desktop (true) or to
438                  its previous desktop (false)
439 */
440 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
441
442 /*! Maximize or unmaximize the client window
443   @param max true if the window should be maximized; false if it should be
444              returned to normal size.
445   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
446 */
447 void client_maximize(ObClient *self, gboolean max, gint dir);
448
449 /*! Shades or unshades the client window
450   @param shade true if the window should be shaded; false if it should be
451                unshaded.
452 */
453 void client_shade(ObClient *self, gboolean shade);
454
455 /*! Hilite the window to make the user notice it */
456 void client_hilite(ObClient *self, gboolean hilite);
457
458 /*! Request the client to close its window */
459 void client_close(ObClient *self);
460
461 /*! Kill the client off violently */
462 void client_kill(ObClient *self);
463
464 /*! Sends the window to the specified desktop
465   @param donthide If TRUE, the window will not be shown/hidden after its
466          desktop has been changed. Generally this should be FALSE. */
467 void client_set_desktop(ObClient *self, guint target, gboolean donthide);
468
469 /*! Show the client if it should be shown. */
470 void client_show(ObClient *self);
471
472 /*! Show the client if it should be shown. */
473 void client_hide(ObClient *self);
474
475 /*! Show the client if it should be shown, and hide it if it should be
476   hidden. This is for example, when switching desktops.
477 */
478 void client_showhide(ObClient *self);
479
480 /*! Validate client, by making sure no Destroy or Unmap events exist in
481   the event queue for the window.
482   @return true if the client is valid; false if the client has already
483           been unmapped/destroyed, and so is invalid.
484 */
485 gboolean client_validate(ObClient *self);
486
487 /*! Sets the wm_state to the specified value */
488 void client_set_wm_state(ObClient *self, glong state);
489
490 /*! Adjusts the window's net_state
491   This should not be called as part of the window mapping process! It is for
492   use when updating the state post-mapping.<br>
493   client_apply_startup_state is used to do the same things during the mapping
494   process.
495 */
496 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
497
498 /* Given a ObClient, find the client that focus would actually be sent to if
499    you wanted to give focus to the specified ObClient. Will return the same
500    ObClient passed to it or another ObClient if appropriate. */
501 ObClient *client_focus_target(ObClient *self);
502
503 /*! Returns what client_focus would return if passed the same client, but
504   without focusing it or modifying the focus order lists. */
505 gboolean client_can_focus(ObClient *self);
506
507 /*! Attempt to focus the client window
508   NOTE: You should validate the client before calling this !! (client_validate)
509 */
510 gboolean client_focus(ObClient *self);
511
512 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
513   when the user deliberately selects a window for use.
514   @param here If true, then the client is brought to the current desktop;
515               otherwise, the desktop is changed to where the client lives.
516   @param user If true, then a user action is what requested the activation;
517               otherwise, it means an application requested it on its own
518 */
519 void client_activate(ObClient *self, gboolean here, gboolean user);
520
521 /*! Calculates the stacking layer for the client window */
522 void client_calc_layer(ObClient *self);
523
524 /*! Raises the client to the top of its stacking layer
525   Normally actions call to the client_* functions to make stuff go, but this
526   one is an exception. It just fires off an action, which will be queued.
527   This is because stacking order rules can be changed by focus state, and so
528   any time focus changes you have to wait for it to complete before you can
529   properly restart windows. As such, this only queues an action for later
530   execution, once the focus change has gone through.
531 */
532 void client_raise(ObClient *self);
533
534 /*! Lowers the client to the bottom of its stacking layer
535   Normally actions call to the client_* functions to make stuff go, but this
536   one is an exception. It just fires off an action, which will be queued.
537   This is because stacking order rules can be changed by focus state, and so
538   any time focus changes you have to wait for it to complete before you can
539   properly restart windows. As such, this only queues an action for later
540   execution, once the focus change has gone through.
541 */
542 void client_lower(ObClient *self);
543
544 /*! Updates the window's transient status, and any parents of it */
545 void client_update_transient_for(ObClient *self);
546 /*! Update the protocols that the window supports and adjusts things if they
547   change */
548 void client_update_protocols(ObClient *self);
549 /*! Updates the window's colormap */
550 void client_update_colormap(ObClient *self, Colormap colormap);
551 /*! Updates the WMNormalHints and adjusts things if they change */
552 void client_update_normal_hints(ObClient *self);
553
554 /*! Updates the WMHints and adjusts things if they change
555   @param initstate Whether to read the initial_state property from the
556                    WMHints. This should only be used during the mapping
557                    process.
558 */
559 void client_update_wmhints(ObClient *self);
560 /*! Updates the window's title and icon title */
561 void client_update_title(ObClient *self);
562 /*! Updates the window's application name and class */
563 void client_update_class(ObClient *self);
564 /*! Updates the strut for the client */
565 void client_update_strut(ObClient *self);
566 /*! Updates the window's icons */
567 void client_update_icons(ObClient *self);
568 /*! Updates the window's user time */
569 void client_update_user_time(ObClient *self);
570
571 /*! Set up what decor should be shown on the window and what functions should
572   be allowed (ObClient::decorations and ObClient::functions).
573   This also updates the NET_WM_ALLOWED_ACTIONS hint.
574 */
575 void client_setup_decor_and_functions(ObClient *self);
576
577 /*! Retrieves the window's type and sets ObClient->type */
578 void client_get_type(ObClient *self);
579
580 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
581
582 /*! Searches a client's direct parents for a focused window. The function does
583   not check for the passed client, only for *ONE LEVEL* of its parents.
584   If no focused parentt is found, NULL is returned.
585 */
586 ObClient *client_search_focus_parent(ObClient *self);
587
588 /*! Searches a client's transients for a focused window. The function does not
589   check for the passed client, only for its transients.
590   If no focused transient is found, NULL is returned.
591 */
592 ObClient *client_search_focus_tree(ObClient *self);
593
594 /*! Searches a client's transient tree for a focused window. The function
595   searches up the tree and down other branches as well as the passed client's.
596   If no focused client is found, NULL is returned.
597 */
598 ObClient *client_search_focus_tree_full(ObClient *self);
599
600 /*! Return a modal child of the client window that can be focused.
601     @return A modal child of the client window that can be focused, or 0 if
602             none was found.
603 */
604 ObClient *client_search_modal_child(ObClient *self);
605
606 /*! Returns a list of top-level windows which this is a transient for.
607   It will only contain more than 1 element if the client is transient for its
608   group.
609 */
610 GSList *client_search_all_top_parents(ObClient *self);
611
612 /*! Returns a window's top level parent. This only counts direct parents,
613   not groups if it is transient for its group.
614 */
615 ObClient *client_search_top_parent(ObClient *self);
616
617 /*! Is one client a direct child of another (i.e. not through the group.) */
618 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
619
620 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
621   returns the searched for parent if it is a parent, or NULL if not. */
622 ObClient *client_search_parent(ObClient *self, ObClient *search);
623
624 /*! Search for a transient of a client. The transient is returned if it is one,
625   NULL is returned if the given search is not a transient of the client. */
626 ObClient *client_search_transient(ObClient *self, ObClient *search);
627
628 /*! Return the closest edge in the given direction */
629 gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
630
631 /*! Set a client window to be above/below other clients.
632   @layer < 0 indicates the client should be placed below other clients.<br>
633          = 0 indicates the client should be placed with other clients.<br>
634          > 0 indicates the client should be placed above other clients.
635 */
636 void client_set_layer(ObClient *self, gint layer);
637
638 /*! Set a client window to have decorations or not */
639 void client_set_undecorated(ObClient *self, gboolean undecorated);
640
641 guint client_monitor(ObClient *self);
642
643 void client_update_sm_client_id(ObClient *self);
644
645 ObClient* client_under_pointer();
646
647 gboolean client_has_group_siblings(ObClient *self);
648
649 #endif