]>
Dogcows Code - chaz/openbox/blob - openbox/client.h
12 /*! Holds an icon in ARGB format */
14 unsigned long width
, height
;
18 /*! The MWM Hints as retrieved from the window property
19 This structure only contains 3 elements, even though the Motif 2.0
20 structure contains 5. We only use the first 3, so that is all gets
23 typedef struct MwmHints
{
24 /*! A bitmask of Client::MwmFlags values */
26 /*! A bitmask of Client::MwmFunctions values */
27 unsigned long functions
;
28 /*! A bitmask of Client::MwmDecorations values */
29 unsigned long decorations
;
31 /*! The number of elements in the Client::MwmHints struct */
32 #define MWM_ELEMENTS 3
34 /*! Possible flags for MWM Hints (defined by Motif 2.0) */
36 MwmFlag_Functions
= 1 << 0, /*!< The MMW Hints define funcs */
37 MwmFlag_Decorations
= 1 << 1 /*!< The MWM Hints define decor */
40 /*! Possible functions for MWM Hints (defined by Motif 2.0) */
42 MwmFunc_All
= 1 << 0, /*!< All functions */
43 MwmFunc_Resize
= 1 << 1, /*!< Allow resizing */
44 MwmFunc_Move
= 1 << 2, /*!< Allow moving */
45 MwmFunc_Iconify
= 1 << 3, /*!< Allow to be iconfied */
46 MwmFunc_Maximize
= 1 << 4 /*!< Allow to be maximized */
47 /*MwmFunc_Close = 1 << 5 /!< Allow to be closed */
50 /*! Possible decorations for MWM Hints (defined by Motif 2.0) */
52 MwmDecor_All
= 1 << 0, /*!< All decorations */
53 MwmDecor_Border
= 1 << 1, /*!< Show a border */
54 MwmDecor_Handle
= 1 << 2, /*!< Show a handle (bottom) */
55 MwmDecor_Title
= 1 << 3, /*!< Show a titlebar */
56 /*MwmDecor_Menu = 1 << 4, /!< Show a menu */
57 MwmDecor_Iconify
= 1 << 5, /*!< Show an iconify button */
58 MwmDecor_Maximize
= 1 << 6 /*!< Show a maximize button */
61 /*! Corners of the client window, used for anchor positions */
69 /*! Possible window types */
71 Type_Desktop
, /*!< A desktop (bottom-most window) */
72 Type_Dock
, /*!< A dock bar/panel window */
73 Type_Toolbar
, /*!< A toolbar window, pulled off an app */
74 Type_Menu
, /*!< An unpinned menu from an app */
75 Type_Utility
, /*!< A small utility window such as a palette */
76 Type_Splash
, /*!< A splash screen window */
77 Type_Dialog
, /*!< A dialog window */
78 Type_Normal
/*!< A normal application window */
81 /*! The things the user can do to the client window */
83 Func_Resize
= 1 << 0, /*!< Allow resizing */
84 Func_Move
= 1 << 1, /*!< Allow moving */
85 Func_Iconify
= 1 << 2, /*!< Allow to be iconified */
86 Func_Maximize
= 1 << 3, /*!< Allow to be maximized */
87 Func_Shade
= 1 << 4, /*!< Allow to be shaded */
88 Func_Fullscreen
= 1 << 5, /*!< Allow to be made fullscreen */
89 Func_Close
= 1 << 6 /*!< Allow to be closed */
92 /*! The decorations the client window wants to be displayed on it */
94 Decor_Titlebar
= 1 << 0, /*!< Display a titlebar */
95 Decor_Handle
= 1 << 1, /*!< Display a handle (bottom) */
96 Decor_Border
= 1 << 2, /*!< Display a border */
97 Decor_Icon
= 1 << 3, /*!< Display the window's icon */
98 Decor_Iconify
= 1 << 4, /*!< Display an iconify button */
99 Decor_Maximize
= 1 << 5, /*!< Display a maximize button */
100 /*! Display a button to toggle the window's placement on
102 Decor_AllDesktops
= 1 << 6,
103 Decor_Close
= 1 << 7 /*!< Display a close button */
107 typedef struct Client
{
112 /*! The number of unmap events to ignore on the window */
115 /*! The id of the group the window belongs to */
117 /*! Whether or not the client is a transient window. This is guaranteed to
118 be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
119 transient_for == NULL. */
121 /*! The client which this client is a transient (child) for */
122 struct Client
*transient_for
;
123 /*! The clients which are transients (children) of this client */
125 /*! The desktop on which the window resides (0xffffffff for all
127 unsigned int desktop
;
129 /*! Normal window title */
131 /*! Window title when iconified */
134 /*! The application that created the window */
136 /*! The class of the window, can used for grouping */
138 /*! The specified role of the window, used for identification */
141 /*! The type of window (what its function is) */
144 /*! Position and size of the window
145 This will not always be the actual position of the window on screen, it
146 is, rather, the position requested by the client, to which the window's
151 /*! The window's strut
152 The strut defines areas of the screen that are marked off-bounds for
153 window placement. In theory, where this window exists.
157 /*! The logical size of the window
158 The "logical" size of the window is refers to the user's perception of
159 the size of the window, and is the value that should be displayed to the
160 user. For example, with xterms, this value it the number of characters
161 being displayed in the terminal, instead of the number of pixels.
165 /*! Width of the border on the window.
166 The window manager will set this to 0 while the window is being managed,
167 but needs to restore it afterwards, so it is saved here.
171 /*! The minimum aspect ratio the client window can be sized to.
172 A value of 0 means this is ignored.
175 /*! The maximum aspect ratio the client window can be sized to.
176 A value of 0 means this is ignored.
180 /*! The minimum size of the client window
181 If the min is > the max, then the window is not resizable
184 /*! The maximum size of the client window
185 If the min is > the max, then the window is not resizable
188 /*! The size of increments to resize the client window by */
190 /*! The base size of the client window
191 This value should be subtracted from the window's actual size when
192 displaying its size to the user, or working with its min/max size
196 /*! Window decoration and functionality hints */
199 /*! Where to place the decorated window in relation to the undecorated
203 /*! The state of the window, one of WithdrawnState, IconicState, or
207 /*! True if the client supports the delete_window protocol */
208 gboolean delete_window
;
210 /*! Was the window's position requested by the application? if not, we
211 should place the window ourselves when it first appears */
214 /*! Can the window receive input focus? */
218 /*! Notify the window when it receives focus? */
219 gboolean focus_notify
;
221 /*! The window uses shape extension to be non-rectangular? */
224 /*! The window is modal, so it must be processed before any windows it is
225 related to can be focused */
227 /*! Only the window's titlebar is displayed */
229 /*! The window is iconified */
231 /*! The window is maximized to fill the screen vertically */
233 /*! The window is maximized to fill the screen horizontally */
235 /*! The window should not be displayed by pagers */
237 /*! The window should not be displayed by taskbars */
238 gboolean skip_taskbar
;
239 /*! The window is a 'fullscreen' window, and should be on top of all
242 /*! The window should be on top of other windows of the same type.
243 above takes priority over below. */
245 /*! The window should be underneath other windows of the same type.
246 above takes priority over below. */
249 /*! The layer in which the window will be stacked, windows in lower layers
250 are always below windows in higher layers. */
253 /*! A bitmask of values in the Decoration enum
254 The values in the variable are the decorations that the client wants to
255 be displayed around it.
259 /*! A bitmask of values in the Decoration enum.
260 Specifies the decorations that should NOT be displayed on the client.
262 int disabled_decorations
;
264 /*! A bitmask of values in the Function enum
265 The values in the variable specify the ways in which the user is allowed
266 to modify this window.
270 /*! Saved decorations from before becoming fullscreen */
273 /*! Saved functions from before becoming fullscreen */
276 /*! Icons for the client as specified on the client window */
278 /*! The number of icons in icons */
281 /*! The icon for the client specified in the WMHints or the KWM hints */
283 /*! The mask for the pixmap_icon, or None if its not masked */
284 Pixmap pixmap_icon_mask
;
287 extern GSList
*client_list
;
288 extern GHashTable
*client_map
;
290 void client_startup();
291 void client_shutdown();
293 /*! Manages all existing windows */
294 void client_manage_all();
295 /*! Manages a given window */
296 void client_manage(Window win
);
297 /*! Unmanages all managed windows */
298 void client_unmanage_all();
299 /*! Unmanages a given client */
300 void client_unmanage(Client
*client
);
302 /*! Sets the client list on the root window from the client_list */
303 void client_set_list();
305 /*! Reapplies the maximized state to the window
306 Use this to make the window readjust its maximized size to new
307 surroundings (struts, etc). */
308 void client_remaximize(Client
*self
);
310 /*! Determines if the client should be shown or hidden currently.
311 @return TRUE if it should be visible; otherwise, FALSE.
313 gboolean
client_should_show(Client
*self
);
315 /*! Returns if the window should be treated as a normal window.
316 Some windows (desktops, docks, splash screens) have special rules applied
317 to them in a number of places regarding focus or user interaction. */
318 gboolean
client_normal(Client
*self
);
320 /* Returns if the window is focused */
321 gboolean
client_focused(Client
*self
);
323 /*! Sets the client to a focused or unfocused state. This does not actually
324 change the input focus, but rather is used once focus has been moved to tell
325 the client that it is so. */
326 void client_set_focused(Client
*self
, gboolean focused
);
328 /*! Move and/or resize the window.
329 This also maintains things like the client's minsize, and size increments.
330 @param anchor The corner to keep in the same position when resizing.
331 @param x The x coordiante of the new position for the client.
332 @param y The y coordiante of the new position for the client.
333 @param w The width component of the new size for the client.
334 @param h The height component of the new size for the client.
335 @param user Specifies whether this is a user-requested change or a
336 program requested change. For program requested changes, the
337 constraints are not checked.
338 @param final If user is true, then this should specify if this is a final
339 configuration. e.g. Final should be FALSE if doing an
340 interactive move/resize, and then be TRUE for the last call
343 void client_configure(Client
*self
, Corner anchor
, int x
, int y
, int w
, int h
,
344 gboolean user
, gboolean final
);
346 /*! Fullscreen's or unfullscreen's the client window
347 @param fs true if the window should be made fullscreen; false if it should
348 be returned to normal state.
349 @param savearea true to have the client's current size and position saved;
350 otherwise, they are not. You should not save when mapping a
351 new window that is set to fullscreen. This has no effect
352 when restoring a window from fullscreen.
354 void client_fullscreen(Client
*self
, gboolean fs
, gboolean savearea
);
356 /*! Iconifies or uniconifies the client window
357 @param iconic true if the window should be iconified; false if it should be
359 @param curdesk If iconic is FALSE, then this determines if the window will
360 be uniconified to the current viewable desktop (true) or to
361 its previous desktop (false)
363 void client_iconify(Client
*self
, gboolean iconic
, gboolean curdesk
);
365 /*! Maximize or unmaximize the client window
366 @param max true if the window should be maximized; false if it should be
367 returned to normal size.
368 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
369 @param savearea true to have the client's current size and position saved;
370 otherwise, they are not. You should not save when mapping a
371 new window that is set to fullscreen. This has no effect
372 when unmaximizing a window.
374 void client_maximize(Client
*self
, gboolean max
, int dir
,
377 /*! Shades or unshades the client window
378 @param shade true if the window should be shaded; false if it should be
381 void client_shade(Client
*self
, gboolean shade
);
383 /*! Request the client to close its window */
384 void client_close(Client
*self
);
386 /*! Kill the client off violently */
387 void client_kill(Client
*self
);
389 /*! Sends the window to the specified desktop */
390 void client_set_desktop(Client
*self
, guint target
);
392 /*! Return a modal child of the client window
393 @return A modal child of the client window, or 0 if none was found.
395 Client
*client_find_modal_child(Client
*self
);
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.
402 gboolean
client_validate(Client
*self
);
404 /*! Sets the wm_state to the specified value */
405 void client_set_wm_state(Client
*self
, long state
);
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
413 void client_set_state(Client
*self
, Atom action
, long data1
, long data2
);
415 /*! Attempt to focus the client window */
416 gboolean
client_focus(Client
*self
);
418 /*! Remove focus from the client window */
419 void client_unfocus(Client
*self
);
421 /*! Calculates the stacking layer for the client window */
422 void client_calc_layer(Client
*self
);
424 /*! Updates the window's transient status, and any parents of it */
425 void client_update_transient_for(Client
*self
);
426 /*! Update the protocols that the window supports and adjusts things if they
428 void client_update_protocols(Client
*self
);
429 /*! Updates the WMNormalHints and adjusts things if they change */
430 void client_update_normal_hints(Client
*self
);
432 /*! Updates the WMHints and adjusts things if they change
433 @param initstate Whether to read the initial_state property from the
434 WMHints. This should only be used during the mapping
437 void client_update_wmhints(Client
*self
);
438 /*! Updates the window's title */
439 void client_update_title(Client
*self
);
440 /*! Updates the window's icon title */
441 void client_update_icon_title(Client
*self
);
442 /*! Updates the window's application name and class */
443 void client_update_class(Client
*self
);
444 /*! Updates the strut for the client */
445 void client_update_strut(Client
*self
);
446 /*! Updates the window's icons */
447 void client_update_icons(Client
*self
);
448 /*! Updates the window's kwm icon */
449 void client_update_kwm_icon(Client
*self
);
451 /*! Set up what decor should be shown on the window and what functions should
452 be allowed (Client::decorations and Client::functions).
453 This also updates the NET_WM_ALLOWED_ACTIONS hint.
455 void client_setup_decor_and_functions(Client
*self
);
457 /*! Retrieves the window's type and sets Client->type */
458 void client_get_type(Client
*self
);
460 Icon
*client_icon(Client
*self
, int w
, int h
);
This page took 0.052366 seconds and 4 git commands to generate.