]>
Dogcows Code - chaz/openbox/blob - openbox/client.h
13 /*! Holds an icon in ARGB format */
19 /*! The MWM Hints as retrieved from the window property
20 This structure only contains 3 elements, even though the Motif 2.0
21 structure contains 5. We only use the first 3, so that is all gets
24 typedef struct MwmHints
{
25 /*! A bitmask of Client::MwmFlags values */
27 /*! A bitmask of Client::MwmFunctions values */
28 unsigned long functions
;
29 /*! A bitmask of Client::MwmDecorations values */
30 unsigned long decorations
;
32 /*! The number of elements in the Client::MwmHints struct */
33 #define MWM_ELEMENTS 3
35 /*! Possible flags for MWM Hints (defined by Motif 2.0) */
37 MwmFlag_Functions
= 1 << 0, /*!< The MMW Hints define funcs */
38 MwmFlag_Decorations
= 1 << 1 /*!< The MWM Hints define decor */
41 /*! Possible functions for MWM Hints (defined by Motif 2.0) */
43 MwmFunc_All
= 1 << 0, /*!< All functions */
44 MwmFunc_Resize
= 1 << 1, /*!< Allow resizing */
45 MwmFunc_Move
= 1 << 2, /*!< Allow moving */
46 MwmFunc_Iconify
= 1 << 3, /*!< Allow to be iconfied */
47 MwmFunc_Maximize
= 1 << 4 /*!< Allow to be maximized */
48 /*MwmFunc_Close = 1 << 5 /!< Allow to be closed */
51 /*! Possible decorations for MWM Hints (defined by Motif 2.0) */
53 MwmDecor_All
= 1 << 0, /*!< All decorations */
54 MwmDecor_Border
= 1 << 1, /*!< Show a border */
55 MwmDecor_Handle
= 1 << 2, /*!< Show a handle (bottom) */
56 MwmDecor_Title
= 1 << 3, /*!< Show a titlebar */
57 /*MwmDecor_Menu = 1 << 4, /!< Show a menu */
58 MwmDecor_Iconify
= 1 << 5, /*!< Show an iconify button */
59 MwmDecor_Maximize
= 1 << 6 /*!< Show a maximize button */
62 /*! Corners of the client window, used for anchor positions */
70 /*! Possible window types */
72 Type_Desktop
, /*!< A desktop (bottom-most window) */
73 Type_Dock
, /*!< A dock bar/panel window */
74 Type_Toolbar
, /*!< A toolbar window, pulled off an app */
75 Type_Menu
, /*!< An unpinned menu from an app */
76 Type_Utility
, /*!< A small utility window such as a palette */
77 Type_Splash
, /*!< A splash screen window */
78 Type_Dialog
, /*!< A dialog window */
79 Type_Normal
/*!< A normal application window */
82 /*! The things the user can do to the client window */
84 Func_Resize
= 1 << 0, /*!< Allow resizing */
85 Func_Move
= 1 << 1, /*!< Allow moving */
86 Func_Iconify
= 1 << 2, /*!< Allow to be iconified */
87 Func_Maximize
= 1 << 3, /*!< Allow to be maximized */
88 Func_Shade
= 1 << 4, /*!< Allow to be shaded */
89 Func_Fullscreen
= 1 << 5, /*!< Allow to be made fullscreen */
90 Func_Close
= 1 << 6 /*!< Allow to be closed */
93 /*! The decorations the client window wants to be displayed on it */
95 Decor_Titlebar
= 1 << 0, /*!< Display a titlebar */
96 Decor_Handle
= 1 << 1, /*!< Display a handle (bottom) */
97 Decor_Border
= 1 << 2, /*!< Display a border */
98 Decor_Icon
= 1 << 3, /*!< Display the window's icon */
99 Decor_Iconify
= 1 << 4, /*!< Display an iconify button */
100 Decor_Maximize
= 1 << 5, /*!< Display a maximize button */
101 /*! Display a button to toggle the window's placement on
103 Decor_AllDesktops
= 1 << 6,
104 Decor_Close
= 1 << 7 /*!< Display a close button */
108 typedef struct Client
{
113 /*! The number of unmap events to ignore on the window */
116 /*! The id of the group the window belongs to */
118 /*! Whether or not the client is a transient window. This is guaranteed to
119 be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
120 transient_for == NULL. */
122 /*! The client which this client is a transient (child) for */
123 struct Client
*transient_for
;
124 /*! The clients which are transients (children) of this client */
126 /*! The desktop on which the window resides (0xffffffff for all
128 unsigned int desktop
;
130 /*! Normal window title */
132 /*! Window title when iconified */
135 /*! The application that created the window */
137 /*! The class of the window, can used for grouping */
139 /*! The specified role of the window, used for identification */
142 /*! The type of window (what its function is) */
145 /*! Position and size of the window
146 This will not always be the actual position of the window on screen, it
147 is, rather, the position requested by the client, to which the window's
152 /*! The window's strut
153 The strut defines areas of the screen that are marked off-bounds for
154 window placement. In theory, where this window exists.
158 /*! The logical size of the window
159 The "logical" size of the window is refers to the user's perception of
160 the size of the window, and is the value that should be displayed to the
161 user. For example, with xterms, this value it the number of characters
162 being displayed in the terminal, instead of the number of pixels.
166 /*! Width of the border on the window.
167 The window manager will set this to 0 while the window is being managed,
168 but needs to restore it afterwards, so it is saved here.
172 /*! The minimum aspect ratio the client window can be sized to.
173 A value of 0 means this is ignored.
176 /*! The maximum aspect ratio the client window can be sized to.
177 A value of 0 means this is ignored.
181 /*! The minimum size of the client window
182 If the min is > the max, then the window is not resizable
185 /*! The maximum size of the client window
186 If the min is > the max, then the window is not resizable
189 /*! The size of increments to resize the client window by */
191 /*! The base size of the client window
192 This value should be subtracted from the window's actual size when
193 displaying its size to the user, or working with its min/max size
197 /*! Window decoration and functionality hints */
200 /*! Where to place the decorated window in relation to the undecorated
204 /*! The state of the window, one of WithdrawnState, IconicState, or
208 /*! True if the client supports the delete_window protocol */
209 gboolean delete_window
;
211 /*! Was the window's position requested by the application? if not, we
212 should place the window ourselves when it first appears */
215 /*! Can the window receive input focus? */
219 /*! Notify the window when it receives focus? */
220 gboolean focus_notify
;
221 /*! Does the client window have the input focus? */
224 /*! The window uses shape extension to be non-rectangular? */
227 /*! The window is modal, so it must be processed before any windows it is
228 related to can be focused */
230 /*! Only the window's titlebar is displayed */
232 /*! The window is iconified */
234 /*! The window is maximized to fill the screen vertically */
236 /*! The window is maximized to fill the screen horizontally */
238 /*! The window should not be displayed by pagers */
240 /*! The window should not be displayed by taskbars */
241 gboolean skip_taskbar
;
242 /*! The window is a 'fullscreen' window, and should be on top of all
245 /*! The window should be on top of other windows of the same type.
246 above takes priority over below. */
248 /*! The window should be underneath other windows of the same type.
249 above takes priority over below. */
252 /*! The layer in which the window will be stacked, windows in lower layers
253 are always below windows in higher layers. */
256 /*! A bitmask of values in the Decoration enum
257 The values in the variable are the decorations that the client wants to
258 be displayed around it.
262 /*! A bitmask of values in the Decoration enum.
263 Specifies the decorations that should NOT be displayed on the client.
265 int disabled_decorations
;
267 /*! A bitmask of values in the Function enum
268 The values in the variable specify the ways in which the user is allowed
269 to modify this window.
273 /*! Icons for the client as specified on the client window */
275 /*! The number of icons in icons */
278 /*! The icon for the client specified in the WMHints or the KWM hints */
280 /*! The mask for the pixmap_icon, or None if its not masked */
281 Pixmap pixmap_icon_mask
;
283 /* The instance of the wrapper class if one exists */
284 struct ClientWrap
*wrap
;
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 /*! Move and/or resize the window.
321 This also maintains things like the client's minsize, and size increments.
322 @param anchor The corner to keep in the same position when resizing.
323 @param x The x coordiante of the new position for the client.
324 @param y The y coordiante of the new position for the client.
325 @param w The width component of the new size for the client.
326 @param h The height component of the new size for the client.
327 @param user Specifies whether this is a user-requested change or a
328 program requested change. For program requested changes, the
329 constraints are not checked.
330 @param final If user is true, then this should specify if this is a final
331 configuration. e.g. Final should be FALSE if doing an
332 interactive move/resize, and then be TRUE for the last call
335 void client_configure(Client
*self
, Corner anchor
, int x
, int y
, int w
, int h
,
336 gboolean user
, gboolean final
);
338 /*! Fullscreen's or unfullscreen's the client window
339 @param fs true if the window should be made fullscreen; false if it should
340 be returned to normal state.
341 @param savearea true to have the client's current size and position saved;
342 otherwise, they are not. You should not save when mapping a
343 new window that is set to fullscreen. This has no effect
344 when restoring a window from fullscreen.
346 void client_fullscreen(Client
*self
, gboolean fs
, gboolean savearea
);
348 /*! Iconifies or uniconifies the client window
349 @param iconic true if the window should be iconified; false if it should be
351 @param curdesk If iconic is FALSE, then this determines if the window will
352 be uniconified to the current viewable desktop (true) or to
353 its previous desktop (false)
355 void client_iconify(Client
*self
, gboolean iconic
, gboolean curdesk
);
357 /*! Maximize or unmaximize the client window
358 @param max true if the window should be maximized; false if it should be
359 returned to normal size.
360 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
361 @param savearea true to have the client's current size and position saved;
362 otherwise, they are not. You should not save when mapping a
363 new window that is set to fullscreen. This has no effect
364 when unmaximizing a window.
366 void client_maximize(Client
*self
, gboolean max
, int dir
,
369 /*! Shades or unshades the client window
370 @param shade true if the window should be shaded; false if it should be
373 void client_shade(Client
*self
, gboolean shade
);
375 /*! Request the client to close its window. */
376 void client_close(Client
*self
);
378 /*! Sends the window to the specified desktop */
379 void client_set_desktop(Client
*self
, unsigned int target
);
381 /*! Return a modal child of the client window
382 @return A modal child of the client window, or 0 if none was found.
384 Client
*client_find_modal_child(Client
*self
);
386 /*! Validate client, by making sure no Destroy or Unmap events exist in
387 the event queue for the window.
388 @return true if the client is valid; false if the client has already
389 been unmapped/destroyed, and so is invalid.
391 gboolean
client_validate(Client
*self
);
393 /*! Sets the wm_state to the specified value */
394 void client_set_wm_state(Client
*self
, long state
);
396 /*! Adjusts the window's net_state
397 This should not be called as part of the window mapping process! It is for
398 use when updating the state post-mapping.<br>
399 client_apply_startup_state is used to do the same things during the mapping
402 void client_set_state(Client
*self
, Atom action
, long data1
, long data2
);
404 /*! Attempt to focus the client window */
405 gboolean
client_focus(Client
*self
);
407 /*! Remove focus from the client window */
408 void client_unfocus(Client
*self
);
410 /*! Calculates the stacking layer for the client window */
411 void client_calc_layer(Client
*self
);
413 /*! Updates the window's transient status, and any parents of it */
414 void client_update_transient_for(Client
*self
);
415 /*! Update the protocols that the window supports and adjusts things if they
417 void client_update_protocols(Client
*self
);
418 /*! Updates the WMNormalHints and adjusts things if they change */
419 void client_update_normal_hints(Client
*self
);
421 /*! Updates the WMHints and adjusts things if they change
422 @param initstate Whether to read the initial_state property from the
423 WMHints. This should only be used during the mapping
426 void client_update_wmhints(Client
*self
);
427 /*! Updates the window's title */
428 void client_update_title(Client
*self
);
429 /*! Updates the window's icon title */
430 void client_update_icon_title(Client
*self
);
431 /*! Updates the window's application name and class */
432 void client_update_class(Client
*self
);
433 /*! Updates the strut for the client */
434 void client_update_strut(Client
*self
);
435 /*! Updates the window's icons */
436 void client_update_icons(Client
*self
);
437 /*! Updates the window's kwm icon */
438 void client_update_kwm_icon(Client
*self
);
440 /*! Set up what decor should be shown on the window and what functions should
441 be allowed (Client::decorations and Client::functions).
442 This also updates the NET_WM_ALLOWED_ACTIONS hint.
444 void client_setup_decor_and_functions(Client
*self
);
446 /*! Retrieves the window's type and sets Client->type */
447 void client_get_type(Client
*self
);
This page took 0.057736 seconds and 4 git commands to generate.