]>
Dogcows Code - chaz/openbox/blob - openbox/client.h
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)
16 /*! Holds an icon in ARGB format */
18 unsigned long width
, height
;
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
27 typedef struct MwmHints
{
28 /*! A bitmask of Client::MwmFlags values */
30 /*! A bitmask of Client::MwmFunctions values */
31 unsigned long functions
;
32 /*! A bitmask of Client::MwmDecorations values */
33 unsigned long decorations
;
35 /*! The number of elements in the Client::MwmHints struct */
36 #define MWM_ELEMENTS 3
38 /*! Possible flags for MWM Hints (defined by Motif 2.0) */
40 MwmFlag_Functions
= 1 << 0, /*!< The MMW Hints define funcs */
41 MwmFlag_Decorations
= 1 << 1 /*!< The MWM Hints define decor */
44 /*! Possible functions for MWM Hints (defined by Motif 2.0) */
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 */
54 /*! Possible decorations for MWM Hints (defined by Motif 2.0) */
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 */
65 /*! Corners of the client window, used for anchor positions */
73 /*! Possible window types */
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 */
85 /*! The things the user can do to the client window */
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 */
96 /*! The decorations the client window wants to be displayed on it */
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
106 Decor_AllDesktops
= 1 << 6,
107 Decor_Shade
= 1 << 7, /*!< Displays a shade button */
108 Decor_Close
= 1 << 8 /*!< Display a close button */
112 typedef struct Client
{
115 /*! The window's decorations. NULL while the window is being managed! */
118 /*! The number of unmap events to ignore on the window */
121 /*! The id of the group the window belongs to */
123 /*! Whether or not the client is a transient window. This is guaranteed to
124 be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
125 transient_for == NULL. */
127 /*! The client which this client is a transient (child) for.
128 A value of TRAN_GROUP signifies that the window is a transient for all
129 members of its Group, and is not a valid pointer to be followed in this
132 struct Client
*transient_for
;
133 /*! The clients which are transients (children) of this client */
135 /*! The desktop on which the window resides (0xffffffff for all
139 /*! Normal window title */
141 /*! The count for the title. When another window with the same title
142 exists, a count will be appended to it. */
144 /*! Window title when iconified */
147 /*! The application that created the window */
149 /*! The class of the window, can used for grouping */
151 /*! The specified role of the window, used for identification */
154 /*! The type of window (what its function is) */
157 /*! Position and size of the window
158 This will not always be the actual position of the window on screen, it
159 is, rather, the position requested by the client, to which the window's
164 /*! The window's strut
165 The strut defines areas of the screen that are marked off-bounds for
166 window placement. In theory, where this window exists.
170 /*! The logical size of the window
171 The "logical" size of the window is refers to the user's perception of
172 the size of the window, and is the value that should be displayed to the
173 user. For example, with xterms, this value it the number of characters
174 being displayed in the terminal, instead of the number of pixels.
178 /*! Width of the border on the window.
179 The window manager will set this to 0 while the window is being managed,
180 but needs to restore it afterwards, so it is saved here.
184 /*! The minimum aspect ratio the client window can be sized to.
185 A value of 0 means this is ignored.
188 /*! The maximum aspect ratio the client window can be sized to.
189 A value of 0 means this is ignored.
193 /*! The minimum size of the client window
194 If the min is > the max, then the window is not resizable
197 /*! The maximum size of the client window
198 If the min is > the max, then the window is not resizable
201 /*! The size of increments to resize the client window by */
203 /*! The base size of the client window
204 This value should be subtracted from the window's actual size when
205 displaying its size to the user, or working with its min/max size
209 /*! Window decoration and functionality hints */
212 /*! Where to place the decorated window in relation to the undecorated
216 /*! The state of the window, one of WithdrawnState, IconicState, or
220 /*! True if the client supports the delete_window protocol */
221 gboolean delete_window
;
223 /*! Was the window's position requested by the application? if not, we
224 should place the window ourselves when it first appears */
227 /*! Can the window receive input focus? */
231 /*! Notify the window when it receives focus? */
232 gboolean focus_notify
;
234 /*! The window uses shape extension to be non-rectangular? */
237 /*! The window is modal, so it must be processed before any windows it is
238 related to can be focused */
240 /*! Only the window's titlebar is displayed */
242 /*! The window is iconified */
244 /*! The window is maximized to fill the screen vertically */
246 /*! The window is maximized to fill the screen horizontally */
248 /*! The window should not be displayed by pagers */
250 /*! The window should not be displayed by taskbars */
251 gboolean skip_taskbar
;
252 /*! The window is a 'fullscreen' window, and should be on top of all
255 /*! The window should be on top of other windows of the same type.
256 above takes priority over below. */
258 /*! The window should be underneath other windows of the same type.
259 above takes priority over below. */
262 /*! The layer in which the window will be stacked, windows in lower layers
263 are always below windows in higher layers. */
266 /*! A bitmask of values in the Decoration enum
267 The values in the variable are the decorations that the client wants to
268 be displayed around it.
272 /*! A bitmask of values in the Decoration enum.
273 Specifies the decorations that should NOT be displayed on the client.
275 int disabled_decorations
;
277 /*! A bitmask of values in the Function enum
278 The values in the variable specify the ways in which the user is allowed
279 to modify this window.
283 /*! Icons for the client as specified on the client window */
285 /*! The number of icons in icons */
288 /*! The icon for the client specified in the WMHints or the KWM hints */
290 /*! The mask for the pixmap_icon, or None if its not masked */
291 Pixmap pixmap_icon_mask
;
294 extern GList
*client_list
;
295 extern GHashTable
*client_map
;
297 void client_startup();
298 void client_shutdown();
300 /*! Manages all existing windows */
301 void client_manage_all();
302 /*! Manages a given window */
303 void client_manage(Window win
);
304 /*! Unmanages all managed windows */
305 void client_unmanage_all();
306 /*! Unmanages a given client */
307 void client_unmanage(Client
*client
);
309 /*! Sets the client list on the root window from the client_list */
310 void client_set_list();
312 /*! Reapplies the maximized state to the window
313 Use this to make the window readjust its maximized size to new
314 surroundings (struts, etc). */
315 void client_remaximize(Client
*self
);
317 /*! Determines if the client should be shown or hidden currently.
318 @return TRUE if it should be visible; otherwise, FALSE.
320 gboolean
client_should_show(Client
*self
);
322 /*! Returns if the window should be treated as a normal window.
323 Some windows (desktops, docks, splash screens) have special rules applied
324 to them in a number of places regarding focus or user interaction. */
325 gboolean
client_normal(Client
*self
);
327 /* Returns if the window is focused */
328 gboolean
client_focused(Client
*self
);
330 /*! Move and/or resize the window.
331 This also maintains things like the client's minsize, and size increments.
332 @param anchor The corner to keep in the same position when resizing.
333 @param x The x coordiante of the new position for the client.
334 @param y The y coordiante of the new position for the client.
335 @param w The width component of the new size for the client.
336 @param h The height component of the new size for the client.
337 @param user Specifies whether this is a user-requested change or a
338 program requested change. For program requested changes, the
339 constraints are not checked.
340 @param final If user is true, then this should specify if this is a final
341 configuration. e.g. Final should be FALSE if doing an
342 interactive move/resize, and then be TRUE for the last call
345 void client_configure(Client
*self
, Corner anchor
, int x
, int y
, int w
, int h
,
346 gboolean user
, gboolean final
);
348 /*! Moves a client so that it is on screen if it is entirely out of the
351 void client_move_onscreen(Client
*self
);
353 /*! Fullscreen's or unfullscreen's the client window
354 @param fs true if the window should be made fullscreen; false if it should
355 be returned to normal state.
356 @param savearea true to have the client's current size and position saved;
357 otherwise, they are not. You should not save when mapping a
358 new window that is set to fullscreen. This has no effect
359 when restoring a window from fullscreen.
361 void client_fullscreen(Client
*self
, gboolean fs
, gboolean savearea
);
363 /*! Iconifies or uniconifies the client window
364 @param iconic true if the window should be iconified; false if it should be
366 @param curdesk If iconic is FALSE, then this determines if the window will
367 be uniconified to the current viewable desktop (true) or to
368 its previous desktop (false)
370 void client_iconify(Client
*self
, gboolean iconic
, gboolean curdesk
);
372 /*! Maximize or unmaximize the client window
373 @param max true if the window should be maximized; false if it should be
374 returned to normal size.
375 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
376 @param savearea true to have the client's current size and position saved;
377 otherwise, they are not. You should not save when mapping a
378 new window that is set to fullscreen. This has no effect
379 when unmaximizing a window.
381 void client_maximize(Client
*self
, gboolean max
, int dir
,
384 /*! Shades or unshades the client window
385 @param shade true if the window should be shaded; false if it should be
388 void client_shade(Client
*self
, gboolean shade
);
390 /*! Request the client to close its window */
391 void client_close(Client
*self
);
393 /*! Kill the client off violently */
394 void client_kill(Client
*self
);
396 /*! Sends the window to the specified desktop
397 @param donthide If TRUE, the window will not be shown/hidden after its
398 desktop has been changed. Generally this should be FALSE. */
399 void client_set_desktop(Client
*self
, guint target
, gboolean donthide
);
401 /*! Validate client, by making sure no Destroy or Unmap events exist in
402 the event queue for the window.
403 @return true if the client is valid; false if the client has already
404 been unmapped/destroyed, and so is invalid.
406 gboolean
client_validate(Client
*self
);
408 /*! Sets the wm_state to the specified value */
409 void client_set_wm_state(Client
*self
, long state
);
411 /*! Adjusts the window's net_state
412 This should not be called as part of the window mapping process! It is for
413 use when updating the state post-mapping.<br>
414 client_apply_startup_state is used to do the same things during the mapping
417 void client_set_state(Client
*self
, Atom action
, long data1
, long data2
);
419 /* Given a Client, find the client that focus would actually be sent to if
420 you wanted to give focus to the specified Client. Will return the same
421 Client passed to it or another Client if appropriate. */
422 Client
*client_focus_target(Client
*self
);
424 /*! Attempt to focus the client window */
425 gboolean
client_focus(Client
*self
);
427 /*! Remove focus from the client window */
428 void client_unfocus(Client
*self
);
430 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
431 when the user deliberately selects a window for use. */
432 void client_activate(Client
*self
);
434 /*! Calculates the stacking layer for the client window */
435 void client_calc_layer(Client
*self
);
437 /*! Updates the window's transient status, and any parents of it */
438 void client_update_transient_for(Client
*self
);
439 /*! Update the protocols that the window supports and adjusts things if they
441 void client_update_protocols(Client
*self
);
442 /*! Updates the WMNormalHints and adjusts things if they change */
443 void client_update_normal_hints(Client
*self
);
445 /*! Updates the WMHints and adjusts things if they change
446 @param initstate Whether to read the initial_state property from the
447 WMHints. This should only be used during the mapping
450 void client_update_wmhints(Client
*self
);
451 /*! Updates the window's title and icon title */
452 void client_update_title(Client
*self
);
453 /*! Updates the window's application name and class */
454 void client_update_class(Client
*self
);
455 /*! Updates the strut for the client */
456 void client_update_strut(Client
*self
);
457 /*! Updates the window's icons */
458 void client_update_icons(Client
*self
);
459 /*! Updates the window's kwm icon */
460 void client_update_kwm_icon(Client
*self
);
462 /*! Set up what decor should be shown on the window and what functions should
463 be allowed (Client::decorations and Client::functions).
464 This also updates the NET_WM_ALLOWED_ACTIONS hint.
466 void client_setup_decor_and_functions(Client
*self
);
468 /*! Retrieves the window's type and sets Client->type */
469 void client_get_type(Client
*self
);
471 Icon
*client_icon(Client
*self
, int w
, int h
);
473 /*! Searches a client's transients for a focused window. The function does not
474 check for the passed client, only for its transients.
475 If no focused transient is found, NULL is returned.
477 Client
*client_search_focus_tree(Client
*self
);
479 /*! Searches a client's transient tree for a focused window. The function
480 searches up the tree and down other branches as well as the passed client's.
481 If no focused client is found, NULL is returned.
483 Client
*client_search_focus_tree_full(Client
*self
);
485 /*! Return a modal child of the client window
486 @return A modal child of the client window, or 0 if none was found.
488 Client
*client_search_modal_child(Client
*self
);
This page took 0.058599 seconds and 4 git commands to generate.