2 in 1 deal :\
[mikachu/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     int width, height;
19     gulong *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     ObWindow obwin;
114
115     Window  window;
116
117     /*! The window's decorations. NULL while the window is being managed! */
118     struct Frame *frame;
119
120     /*! The number of unmap events to ignore on the window */
121     int ignore_unmaps;
122
123     /*! The id of the group the window belongs to */
124     struct Group *group;
125     /*! Whether or not the client is a transient window. This is guaranteed to 
126       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
127       transient_for == NULL. */
128     gboolean transient;
129     /*! The client which this client is a transient (child) for.
130       A value of TRAN_GROUP signifies that the window is a transient for all
131       members of its Group, and is not a valid pointer to be followed in this
132       case.
133      */
134     struct Client *transient_for;
135     /*! The clients which are transients (children) of this client */
136     GSList *transients;
137     /*! The desktop on which the window resides (0xffffffff for all
138       desktops) */
139     guint desktop;
140
141     /*! Normal window title */
142     gchar *title;
143     /*! The count for the title. When another window with the same title
144       exists, a count will be appended to it. */
145     guint title_count;
146     /*! Window title when iconified */
147     gchar *icon_title;
148
149     /*! The application that created the window */
150     gchar *name;
151     /*! The class of the window, can used for grouping */
152     gchar *class;
153     /*! The specified role of the window, used for identification */
154     gchar *role;
155
156     /*! The type of window (what its function is) */
157     WindowType type;
158
159     /*! Position and size of the window
160       This will not always be the actual position of the window on screen, it
161       is, rather, the position requested by the client, to which the window's
162       gravity is applied.
163     */
164     Rect    area;
165
166     /*! The window's strut
167       The strut defines areas of the screen that are marked off-bounds for
168       window placement. In theory, where this window exists.
169     */
170     Strut   strut;
171      
172     /*! The logical size of the window
173       The "logical" size of the window is refers to the user's perception of
174       the size of the window, and is the value that should be displayed to the
175       user. For example, with xterms, this value it the number of characters
176       being displayed in the terminal, instead of the number of pixels.
177     */
178     Size   logical_size;
179
180     /*! Width of the border on the window.
181       The window manager will set this to 0 while the window is being managed,
182       but needs to restore it afterwards, so it is saved here.
183     */
184     guint border_width;
185
186     /*! The minimum aspect ratio the client window can be sized to.
187       A value of 0 means this is ignored.
188     */
189     float min_ratio;
190     /*! The maximum aspect ratio the client window can be sized to.
191       A value of 0 means this is ignored.
192     */
193     float max_ratio;
194   
195     /*! The minimum size of the client window
196       If the min is > the max, then the window is not resizable
197     */
198     Size min_size;
199     /*! The maximum size of the client window
200       If the min is > the max, then the window is not resizable
201     */
202     Size max_size;
203     /*! The size of increments to resize the client window by */
204     Size size_inc;
205     /*! The base size of the client window
206       This value should be subtracted from the window's actual size when
207       displaying its size to the user, or working with its min/max size
208     */
209     Size base_size;
210
211     /*! Window decoration and functionality hints */
212     MwmHints mwmhints;
213   
214     /*! Where to place the decorated window in relation to the undecorated
215       window */
216     int gravity;
217
218     /*! The state of the window, one of WithdrawnState, IconicState, or
219       NormalState */
220     long wmstate;
221
222     /*! True if the client supports the delete_window protocol */
223     gboolean delete_window;
224   
225     /*! Was the window's position requested by the application? if not, we
226       should place the window ourselves when it first appears */
227     gboolean positioned;
228   
229     /*! Can the window receive input focus? */
230     gboolean can_focus;
231     /*! Urgency flag */
232     gboolean urgent;
233     /*! Notify the window when it receives focus? */
234     gboolean focus_notify;
235
236     /*! The window uses shape extension to be non-rectangular? */
237     gboolean shaped;
238
239     /*! The window is modal, so it must be processed before any windows it is
240       related to can be focused */
241     gboolean modal;
242     /*! Only the window's titlebar is displayed */
243     gboolean shaded;
244     /*! The window is iconified */
245     gboolean iconic;
246     /*! The window is maximized to fill the screen vertically */
247     gboolean max_vert;
248     /*! The window is maximized to fill the screen horizontally */
249     gboolean max_horz;
250     /*! The window should not be displayed by pagers */
251     gboolean skip_pager;
252     /*! The window should not be displayed by taskbars */
253     gboolean skip_taskbar;
254     /*! The window is a 'fullscreen' window, and should be on top of all
255       others */
256     gboolean fullscreen;
257     /*! The window should be on top of other windows of the same type.
258       above takes priority over below. */
259     gboolean above;
260     /*! The window should be underneath other windows of the same type.
261       above takes priority over below. */
262     gboolean below;
263
264     /*! The layer in which the window will be stacked, windows in lower layers
265       are always below windows in higher layers. */
266     StackLayer layer;
267
268     /*! A bitmask of values in the Decoration enum
269       The values in the variable are the decorations that the client wants to
270       be displayed around it.
271     */
272     int decorations;
273
274     /*! A bitmask of values in the Decoration enum.
275       Specifies the decorations that should NOT be displayed on the client.
276     */
277     int disabled_decorations;
278
279     /*! A bitmask of values in the Function enum
280       The values in the variable specify the ways in which the user is allowed
281       to modify this window.
282     */
283     int functions;
284
285     /*! Icons for the client as specified on the client window */
286     Icon *icons;
287     /*! The number of icons in icons */
288     int nicons;
289 } Client;
290
291 extern GList *client_list;
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 /*! Moves a client so that it is on screen if it is entirely out of the
345   viewable screen.
346 */
347 void client_move_onscreen(Client *self);
348
349 /*! Fullscreen's or unfullscreen's the client window
350   @param fs true if the window should be made fullscreen; false if it should
351             be returned to normal state.
352   @param savearea true to have the client's current size and position saved;
353                   otherwise, they are not. You should not save when mapping a
354                   new window that is set to fullscreen. This has no effect
355                   when restoring a window from fullscreen.
356 */
357 void client_fullscreen(Client *self, gboolean fs, gboolean savearea);
358
359 /*! Iconifies or uniconifies the client window
360   @param iconic true if the window should be iconified; false if it should be
361                 restored.
362   @param curdesk If iconic is FALSE, then this determines if the window will
363                  be uniconified to the current viewable desktop (true) or to
364                  its previous desktop (false)
365 */
366 void client_iconify(Client *self, gboolean iconic, gboolean curdesk);
367
368 /*! Maximize or unmaximize the client window
369   @param max true if the window should be maximized; false if it should be
370              returned to normal size.
371   @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
372   @param savearea true to have the client's current size and position saved;
373                   otherwise, they are not. You should not save when mapping a
374                   new window that is set to fullscreen. This has no effect
375                   when unmaximizing a window.
376 */
377 void client_maximize(Client *self, gboolean max, int dir,
378                      gboolean savearea);
379
380 /*! Shades or unshades the client window
381   @param shade true if the window should be shaded; false if it should be
382                unshaded.
383 */
384 void client_shade(Client *self, gboolean shade);
385
386 /*! Request the client to close its window */
387 void client_close(Client *self);
388
389 /*! Kill the client off violently */
390 void client_kill(Client *self);
391
392 /*! Sends the window to the specified desktop
393   @param donthide If TRUE, the window will not be shown/hidden after its
394          desktop has been changed. Generally this should be FALSE. */
395 void client_set_desktop(Client *self, guint target, gboolean donthide);
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 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
427   when the user deliberately selects a window for use. */
428 void client_activate(Client *self);
429
430 /*! Calculates the stacking layer for the client window */
431 void client_calc_layer(Client *self);
432
433 /*! Updates the window's transient status, and any parents of it */
434 void client_update_transient_for(Client *self);
435 /*! Update the protocols that the window supports and adjusts things if they
436   change */
437 void client_update_protocols(Client *self);
438 /*! Updates the WMNormalHints and adjusts things if they change */
439 void client_update_normal_hints(Client *self);
440
441 /*! Updates the WMHints and adjusts things if they change
442   @param initstate Whether to read the initial_state property from the
443                    WMHints. This should only be used during the mapping
444                    process.
445 */
446 void client_update_wmhints(Client *self);
447 /*! Updates the window's title and icon title */
448 void client_update_title(Client *self);
449 /*! Updates the window's application name and class */
450 void client_update_class(Client *self);
451 /*! Updates the strut for the client */
452 void client_update_strut(Client *self);
453 /*! Updates the window's icons */
454 void client_update_icons(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 /*! Searches a client's transients for a focused window. The function does not
468   check for the passed client, only for its transients.
469   If no focused transient is found, NULL is returned.
470 */
471 Client *client_search_focus_tree(Client *self);
472
473 /*! Searches a client's transient tree for a focused window. The function
474   searches up the tree and down other branches as well as the passed client's.
475   If no focused client is found, NULL is returned.
476 */
477 Client *client_search_focus_tree_full(Client *self);
478
479 /*! Return a modal child of the client window
480     @return A modal child of the client window, or 0 if none was found.
481 */
482 Client *client_search_modal_child(Client *self);
483
484 #endif