add helper functions for manipulating the focus_order list.
[dana/openbox.git] / openbox / client.h
1 #ifndef __client_h
2 #define __client_h
3
4 #include "geom.h"
5 #include "stacking.h"
6 #include <glib.h>
7 #include <X11/Xlib.h>
8
9 struct Frame;
10 struct Group;
11
12 /* The value in client.transient_for indicating it is a transient for its
13    group instead of for a single window */
14 #define TRAN_GROUP ((void*)~0l)
15
16 /*! Holds an icon in ARGB format */
17 typedef struct Icon {
18     unsigned long width, height;
19     unsigned long *data;
20 } Icon;
21      
22 /*! The MWM Hints as retrieved from the window property
23   This structure only contains 3 elements, even though the Motif 2.0
24   structure contains 5. We only use the first 3, so that is all gets
25   defined.
26 */
27 typedef struct MwmHints {
28     /*! A bitmask of Client::MwmFlags values */
29     unsigned long flags;
30     /*! A bitmask of Client::MwmFunctions values */
31     unsigned long functions;
32     /*! A bitmask of Client::MwmDecorations values */
33     unsigned long decorations;
34 } MwmHints;
35 /*! The number of elements in the Client::MwmHints struct */
36 #define MWM_ELEMENTS 3
37      
38 /*! Possible flags for MWM Hints (defined by Motif 2.0) */
39 typedef enum {
40     MwmFlag_Functions   = 1 << 0, /*!< The MMW Hints define funcs */
41     MwmFlag_Decorations = 1 << 1  /*!< The MWM Hints define decor */
42 } MwmFlags;
43
44 /*! Possible functions for MWM Hints (defined by Motif 2.0) */
45 typedef enum {
46     MwmFunc_All      = 1 << 0, /*!< All functions */
47     MwmFunc_Resize   = 1 << 1, /*!< Allow resizing */
48     MwmFunc_Move     = 1 << 2, /*!< Allow moving */
49     MwmFunc_Iconify  = 1 << 3, /*!< Allow to be iconfied */
50     MwmFunc_Maximize = 1 << 4  /*!< Allow to be maximized */
51     /*MwmFunc_Close    = 1 << 5 /!< Allow to be closed */
52 } MwmFunctions;
53
54 /*! Possible decorations for MWM Hints (defined by Motif 2.0) */
55 typedef enum {
56     MwmDecor_All      = 1 << 0, /*!< All decorations */
57     MwmDecor_Border   = 1 << 1, /*!< Show a border */
58     MwmDecor_Handle   = 1 << 2, /*!< Show a handle (bottom) */
59     MwmDecor_Title    = 1 << 3, /*!< Show a titlebar */
60     /*MwmDecor_Menu     = 1 << 4, /!< Show a menu */
61     MwmDecor_Iconify  = 1 << 5, /*!< Show an iconify button */
62     MwmDecor_Maximize = 1 << 6  /*!< Show a maximize button */
63 } MemDecorations;
64
65 /*! Corners of the client window, used for anchor positions */
66 typedef enum {
67     Corner_TopLeft,
68     Corner_TopRight,
69     Corner_BottomLeft,
70     Corner_BottomRight
71 } Corner;
72
73 /*! Possible window types */
74 typedef enum {
75     Type_Desktop, /*!< A desktop (bottom-most window) */
76     Type_Dock,    /*!< A dock bar/panel window */
77     Type_Toolbar, /*!< A toolbar window, pulled off an app */
78     Type_Menu,    /*!< An unpinned menu from an app */
79     Type_Utility, /*!< A small utility window such as a palette */
80     Type_Splash,  /*!< A splash screen window */
81     Type_Dialog,  /*!< A dialog window */
82     Type_Normal   /*!< A normal application window */
83 } WindowType;
84
85 /*! The things the user can do to the client window */
86 typedef enum {
87     Func_Resize     = 1 << 0, /*!< Allow resizing */
88     Func_Move       = 1 << 1, /*!< Allow moving */
89     Func_Iconify    = 1 << 2, /*!< Allow to be iconified */
90     Func_Maximize   = 1 << 3, /*!< Allow to be maximized */
91     Func_Shade      = 1 << 4, /*!< Allow to be shaded */
92     Func_Fullscreen = 1 << 5, /*!< Allow to be made fullscreen */
93     Func_Close      = 1 << 6  /*!< Allow to be closed */
94 } Function;
95
96 /*! The decorations the client window wants to be displayed on it */
97 typedef enum {
98     Decor_Titlebar    = 1 << 0, /*!< Display a titlebar */
99     Decor_Handle      = 1 << 1, /*!< Display a handle (bottom) */
100     Decor_Border      = 1 << 2, /*!< Display a border */
101     Decor_Icon        = 1 << 3, /*!< Display the window's icon */
102     Decor_Iconify     = 1 << 4, /*!< Display an iconify button */
103     Decor_Maximize    = 1 << 5, /*!< Display a maximize button */
104     /*! Display a button to toggle the window's placement on
105       all desktops */
106     Decor_AllDesktops = 1 << 6,
107     Decor_Shade       = 1 << 7, /*!< Displays a shade button */
108     Decor_Close       = 1 << 8  /*!< Display a close button */
109 } Decoration;
110
111
112 typedef struct Client {
113     Window  window;
114
115     struct Frame *frame;
116
117     /*! The number of unmap events to ignore on the window */
118     int ignore_unmaps;
119
120     /*! The id of the group the window belongs to */
121     struct Group *group;
122     /*! Whether or not the client is a transient window. This is guaranteed to 
123       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
124       transient_for == NULL. */
125     gboolean transient;
126     /*! The client which this client is a transient (child) for.
127       A value of TRAN_GROUP signifies that the window is a transient for all
128       members of its Group, and is not a valid pointer to be followed in this
129       case.
130      */
131     struct Client *transient_for;
132     /*! The clients which are transients (children) of this client */
133     GSList *transients;
134     /*! The desktop on which the window resides (0xffffffff for all
135       desktops) */
136     unsigned int desktop;
137
138     /*! Normal window title */
139     gchar *title;
140     /*! Window title when iconified */
141     gchar *icon_title;
142
143     /*! The application that created the window */
144     gchar *name;
145     /*! The class of the window, can used for grouping */
146     gchar *class;
147     /*! The specified role of the window, used for identification */
148     gchar *role;
149
150     /*! The type of window (what its function is) */
151     WindowType type;
152
153     /*! Position and size of the window
154       This will not always be the actual position of the window on screen, it
155       is, rather, the position requested by the client, to which the window's
156       gravity is applied.
157     */
158     Rect    area;
159
160     /*! The window's strut
161       The strut defines areas of the screen that are marked off-bounds for
162       window placement. In theory, where this window exists.
163     */
164     Strut   strut;
165      
166     /*! The logical size of the window
167       The "logical" size of the window is refers to the user's perception of
168       the size of the window, and is the value that should be displayed to the
169       user. For example, with xterms, this value it the number of characters
170       being displayed in the terminal, instead of the number of pixels.
171     */
172     Size   logical_size;
173
174     /*! Width of the border on the window.
175       The window manager will set this to 0 while the window is being managed,
176       but needs to restore it afterwards, so it is saved here.
177     */
178     guint border_width;
179
180     /*! The minimum aspect ratio the client window can be sized to.
181       A value of 0 means this is ignored.
182     */
183     float min_ratio;
184     /*! The maximum aspect ratio the client window can be sized to.
185       A value of 0 means this is ignored.
186     */
187     float max_ratio;
188   
189     /*! The minimum size of the client window
190       If the min is > the max, then the window is not resizable
191     */
192     Size min_size;
193     /*! The maximum size of the client window
194       If the min is > the max, then the window is not resizable
195     */
196     Size max_size;
197     /*! The size of increments to resize the client window by */
198     Size size_inc;
199     /*! The base size of the client window
200       This value should be subtracted from the window's actual size when
201       displaying its size to the user, or working with its min/max size
202     */
203     Size base_size;
204
205     /*! Window decoration and functionality hints */
206     MwmHints mwmhints;
207   
208     /*! Where to place the decorated window in relation to the undecorated
209       window */
210     int gravity;
211
212     /*! The state of the window, one of WithdrawnState, IconicState, or
213       NormalState */
214     long wmstate;
215
216     /*! True if the client supports the delete_window protocol */
217     gboolean delete_window;
218   
219     /*! Was the window's position requested by the application? if not, we
220       should place the window ourselves when it first appears */
221     gboolean positioned;
222   
223     /*! Can the window receive input focus? */
224     gboolean can_focus;
225     /*! Urgency flag */
226     gboolean urgent;
227     /*! Notify the window when it receives focus? */
228     gboolean focus_notify;
229
230     /*! The window uses shape extension to be non-rectangular? */
231     gboolean shaped;
232
233     /*! The window is modal, so it must be processed before any windows it is
234       related to can be focused */
235     gboolean modal;
236     /*! Only the window's titlebar is displayed */
237     gboolean shaded;
238     /*! The window is iconified */
239     gboolean iconic;
240     /*! The window is maximized to fill the screen vertically */
241     gboolean max_vert;
242     /*! The window is maximized to fill the screen horizontally */
243     gboolean max_horz;
244     /*! The window should not be displayed by pagers */
245     gboolean skip_pager;
246     /*! The window should not be displayed by taskbars */
247     gboolean skip_taskbar;
248     /*! The window is a 'fullscreen' window, and should be on top of all
249       others */
250     gboolean fullscreen;
251     /*! The window should be on top of other windows of the same type.
252       above takes priority over below. */
253     gboolean above;
254     /*! The window should be underneath other windows of the same type.
255       above takes priority over below. */
256     gboolean below;
257
258     /*! The layer in which the window will be stacked, windows in lower layers
259       are always below windows in higher layers. */
260     StackLayer layer;
261
262     /*! A bitmask of values in the Decoration enum
263       The values in the variable are the decorations that the client wants to
264       be displayed around it.
265     */
266     int decorations;
267
268     /*! A bitmask of values in the Decoration enum.
269       Specifies the decorations that should NOT be displayed on the client.
270     */
271     int disabled_decorations;
272
273     /*! A bitmask of values in the Function enum
274       The values in the variable specify the ways in which the user is allowed
275       to modify this window.
276     */
277     int functions;
278
279     /*! Icons for the client as specified on the client window */
280     Icon *icons;
281     /*! The number of icons in icons */
282     int nicons;
283
284     /*! The icon for the client specified in the WMHints or the KWM hints */
285     Pixmap pixmap_icon;
286     /*! The mask for the pixmap_icon, or None if its not masked */
287     Pixmap pixmap_icon_mask;
288 } Client;
289
290 extern GList *client_list;
291 extern GHashTable *client_map;
292
293 void client_startup();
294 void client_shutdown();
295
296 /*! Manages all existing windows */
297 void client_manage_all();
298 /*! Manages a given window */
299 void client_manage(Window win);
300 /*! Unmanages all managed windows */
301 void client_unmanage_all();
302 /*! Unmanages a given client */
303 void client_unmanage(Client *client);
304
305 /*! Sets the client list on the root window from the client_list */
306 void client_set_list();
307
308 /*! Reapplies the maximized state to the window
309   Use this to make the window readjust its maximized size to new
310   surroundings (struts, etc). */
311 void client_remaximize(Client *self);
312
313 /*! Determines if the client should be shown or hidden currently.
314   @return TRUE if it should be visible; otherwise, FALSE.
315 */
316 gboolean client_should_show(Client *self);
317
318 /*! Returns if the window should be treated as a normal window.
319   Some windows (desktops, docks, splash screens) have special rules applied
320   to them in a number of places regarding focus or user interaction. */
321 gboolean client_normal(Client *self);
322
323 /* Returns if the window is focused */
324 gboolean client_focused(Client *self);
325
326 /*! Move and/or resize the window.
327   This also maintains things like the client's minsize, and size increments.
328   @param anchor The corner to keep in the same position when resizing.
329   @param x The x coordiante of the new position for the client.
330   @param y The y coordiante of the new position for the client.
331   @param w The width component of the new size for the client.
332   @param h The height component of the new size for the client.
333   @param user Specifies whether this is a user-requested change or a
334               program requested change. For program requested changes, the
335               constraints are not checked.
336   @param final If user is true, then this should specify if this is a final
337                configuration. e.g. Final should be FALSE if doing an
338                interactive move/resize, and then be TRUE for the last call
339                only.
340 */
341 void client_configure(Client *self, Corner anchor, int x, int y, int w, int h,
342                       gboolean user, gboolean final);
343
344 /*! Fullscreen's or unfullscreen's the client window
345   @param fs true if the window should be made fullscreen; false if it should
346             be returned to normal state.
347   @param savearea true to have the client's current size and position saved;
348                   otherwise, they are not. You should not save when mapping a
349                   new window that is set to fullscreen. This has no effect
350                   when restoring a window from fullscreen.
351 */
352 void client_fullscreen(Client *self, gboolean fs, gboolean savearea);
353
354 /*! Iconifies or uniconifies the client window
355   @param iconic true if the window should be iconified; false if it should be
356                 restored.
357   @param curdesk If iconic is FALSE, then this determines if the window will
358                  be uniconified to the current viewable desktop (true) or to
359                  its previous desktop (false)
360 */
361 void client_iconify(Client *self, gboolean iconic, gboolean curdesk);
362
363 /*! Maximize or unmaximize the client window
364   @param max true if the window should be maximized; false if it should be
365              returned to normal size.
366   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
367   @param savearea true to have the client's current size and position saved;
368                   otherwise, they are not. You should not save when mapping a
369                   new window that is set to fullscreen. This has no effect
370                   when unmaximizing a window.
371 */
372 void client_maximize(Client *self, gboolean max, int dir,
373                      gboolean savearea);
374
375 /*! Shades or unshades the client window
376   @param shade true if the window should be shaded; false if it should be
377                unshaded.
378 */
379 void client_shade(Client *self, gboolean shade);
380
381 /*! Request the client to close its window */
382 void client_close(Client *self);
383
384 /*! Kill the client off violently */
385 void client_kill(Client *self);
386
387 /*! Sends the window to the specified desktop
388   @param donthide If TRUE, the window will not be shown/hidden after its
389          desktop has been changed. Generally this should be FALSE. */
390 void client_set_desktop(Client *self, guint target, gboolean donthide);
391
392 /*! Return a modal child of the client window
393     @return A modal child of the client window, or 0 if none was found.
394 */
395 Client *client_find_modal_child(Client *self);
396
397 /*! Validate client, by making sure no Destroy or Unmap events exist in
398   the event queue for the window.
399   @return true if the client is valid; false if the client has already
400           been unmapped/destroyed, and so is invalid.
401 */
402 gboolean client_validate(Client *self);
403
404 /*! Sets the wm_state to the specified value */
405 void client_set_wm_state(Client *self, long state);
406
407 /*! Adjusts the window's net_state
408   This should not be called as part of the window mapping process! It is for
409   use when updating the state post-mapping.<br>
410   client_apply_startup_state is used to do the same things during the mapping
411   process.
412 */
413 void client_set_state(Client *self, Atom action, long data1, long data2);
414
415 /* Given a Client, find the client that focus would actually be sent to if
416    you wanted to give focus to the specified Client. Will return the same
417    Client passed to it or another Client if appropriate. */
418 Client *client_focus_target(Client *self);
419
420 /*! Attempt to focus the client window */
421 gboolean client_focus(Client *self);
422
423 /*! Remove focus from the client window */
424 void client_unfocus(Client *self);
425
426 /*! Calculates the stacking layer for the client window */
427 void client_calc_layer(Client *self);
428
429 /*! Updates the window's transient status, and any parents of it */
430 void client_update_transient_for(Client *self);
431 /*! Update the protocols that the window supports and adjusts things if they
432   change */
433 void client_update_protocols(Client *self);
434 /*! Updates the WMNormalHints and adjusts things if they change */
435 void client_update_normal_hints(Client *self);
436
437 /*! Updates the WMHints and adjusts things if they change
438   @param initstate Whether to read the initial_state property from the
439                    WMHints. This should only be used during the mapping
440                    process.
441 */
442 void client_update_wmhints(Client *self);
443 /*! Updates the window's title */
444 void client_update_title(Client *self);
445 /*! Updates the window's icon title */
446 void client_update_icon_title(Client *self);
447 /*! Updates the window's application name and class */
448 void client_update_class(Client *self);
449 /*! Updates the strut for the client */
450 void client_update_strut(Client *self);
451 /*! Updates the window's icons */
452 void client_update_icons(Client *self);
453 /*! Updates the window's kwm icon */
454 void client_update_kwm_icon(Client *self);
455
456 /*! Set up what decor should be shown on the window and what functions should
457   be allowed (Client::decorations and Client::functions).
458   This also updates the NET_WM_ALLOWED_ACTIONS hint.
459 */
460 void client_setup_decor_and_functions(Client *self);
461
462 /*! Retrieves the window's type and sets Client->type */
463 void client_get_type(Client *self);
464
465 Icon *client_icon(Client *self, int w, int h);
466
467 #endif