8 #include "render/color.h"
15 struct _ObSessionState
;
17 typedef struct _ObClient ObClient
;
18 typedef struct _ObClientIcon ObClientIcon
;
20 /* The value in client.transient_for indicating it is a transient for its
21 group instead of for a single window */
22 #define OB_TRAN_GROUP ((void*)~0l)
24 /*! Holds an icon in ARGB format */
32 /*! Possible window types */
35 OB_CLIENT_TYPE_DESKTOP
, /*!< A desktop (bottom-most window) */
36 OB_CLIENT_TYPE_DOCK
, /*!< A dock bar/panel window */
37 OB_CLIENT_TYPE_TOOLBAR
, /*!< A toolbar window, pulled off an app */
38 OB_CLIENT_TYPE_MENU
, /*!< An unpinned menu from an app */
39 OB_CLIENT_TYPE_UTILITY
, /*!< A small utility window such as a palette */
40 OB_CLIENT_TYPE_SPLASH
, /*!< A splash screen window */
41 OB_CLIENT_TYPE_DIALOG
, /*!< A dialog window */
42 OB_CLIENT_TYPE_NORMAL
/*!< A normal application window */
45 /*! The things the user can do to the client window */
48 OB_CLIENT_FUNC_RESIZE
= 1 << 0, /*!< Allow user resizing */
49 OB_CLIENT_FUNC_MOVE
= 1 << 1, /*!< Allow user moving */
50 OB_CLIENT_FUNC_ICONIFY
= 1 << 2, /*!< Allow to be iconified */
51 OB_CLIENT_FUNC_MAXIMIZE
= 1 << 3, /*!< Allow to be maximized */
52 OB_CLIENT_FUNC_SHADE
= 1 << 4, /*!< Allow to be shaded */
53 OB_CLIENT_FUNC_FULLSCREEN
= 1 << 5, /*!< Allow to be made fullscreen */
54 OB_CLIENT_FUNC_CLOSE
= 1 << 6 /*!< Allow to be closed */
63 /*! The window's decorations. NULL while the window is being managed! */
64 struct _ObFrame
*frame
;
66 /*! The number of unmap events to ignore on the window */
69 /*! The id of the group the window belongs to */
70 struct _ObGroup
*group
;
72 /*! Saved session data to apply to this client */
73 struct _ObSessionState
*session
;
75 /*! Whether or not the client is a transient window. This is guaranteed to
76 be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
77 transient_for == NULL. */
79 /*! The client which this client is a transient (child) for.
80 A value of TRAN_GROUP signifies that the window is a transient for all
81 members of its ObGroup, and is not a valid pointer to be followed in this
84 ObClient
*transient_for
;
85 /*! The clients which are transients (children) of this client */
87 /*! The desktop on which the window resides (0xffffffff for all
91 /*! Normal window title */
93 /*! The count for the title. When another window with the same title
94 exists, a count will be appended to it. */
96 /*! Window title when iconified */
99 /*! The application that created the window */
101 /*! The class of the window, can used for grouping */
103 /*! The specified role of the window, used for identification */
106 /*! The type of window (what its function is) */
109 /*! Position and size of the window
110 This will not always be the actual position of the window on screen, it
111 is, rather, the position requested by the client, to which the window's
116 /*! The window's strut
117 The strut defines areas of the screen that are marked off-bounds for
118 window placement. In theory, where this window exists.
122 /*! The logical size of the window
123 The "logical" size of the window is refers to the user's perception of
124 the size of the window, and is the value that should be displayed to the
125 user. For example, with xterms, this value it the number of characters
126 being displayed in the terminal, instead of the number of pixels.
130 /*! Width of the border on the window.
131 The window manager will set this to 0 while the window is being managed,
132 but needs to restore it afterwards, so it is saved here.
136 /*! The minimum aspect ratio the client window can be sized to.
137 A value of 0 means this is ignored.
140 /*! The maximum aspect ratio the client window can be sized to.
141 A value of 0 means this is ignored.
145 /*! The minimum size of the client window
146 If the min is > the max, then the window is not resizable
149 /*! The maximum size of the client window
150 If the min is > the max, then the window is not resizable
153 /*! The size of increments to resize the client window by */
155 /*! The base size of the client window
156 This value should be subtracted from the window's actual size when
157 displaying its size to the user, or working with its min/max size
161 /*! Window decoration and functionality hints */
164 /*! Where to place the decorated window in relation to the undecorated
168 /*! The state of the window, one of WithdrawnState, IconicState, or
172 /*! True if the client supports the delete_window protocol */
173 gboolean delete_window
;
175 /*! Was the window's position requested by the application? if not, we
176 should place the window ourselves when it first appears */
179 /*! Can the window receive input focus? */
183 /*! Notify the window when it receives focus? */
184 gboolean focus_notify
;
186 /*! The window uses shape extension to be non-rectangular? */
189 /*! The window is modal, so it must be processed before any windows it is
190 related to can be focused */
192 /*! Only the window's titlebar is displayed */
194 /*! The window is iconified */
196 /*! The window is maximized to fill the screen vertically */
198 /*! The window is maximized to fill the screen horizontally */
200 /*! The window should not be displayed by pagers */
202 /*! The window should not be displayed by taskbars */
203 gboolean skip_taskbar
;
204 /*! The window is a 'fullscreen' window, and should be on top of all
207 /*! The window should be on top of other windows of the same type.
208 above takes priority over below. */
210 /*! The window should be underneath other windows of the same type.
211 above takes priority over below. */
214 /*! The layer in which the window will be stacked, windows in lower layers
215 are always below windows in higher layers. */
216 ObStackingLayer layer
;
218 /*! A bitmask of values in the ObFrameDecorations enum
219 The values in the variable are the decorations that the client wants to
220 be displayed around it.
224 /*! A user option. When this is set to FALSE the client will not ever
229 /*! A bitmask of values in the ObFunctions enum
230 The values in the variable specify the ways in which the user is allowed
231 to modify this window.
235 /*! Icons for the client as specified on the client window */
237 /*! The number of icons in icons */
241 extern GList
*client_list
;
243 void client_startup();
244 void client_shutdown();
246 void client_add_destructor(GDestroyNotify func
);
247 void client_remove_destructor(GDestroyNotify func
);
249 /*! Manages all existing windows */
250 void client_manage_all();
251 /*! Manages a given window */
252 void client_manage(Window win
);
253 /*! Unmanages all managed windows */
254 void client_unmanage_all();
255 /*! Unmanages a given client */
256 void client_unmanage(ObClient
*client
);
258 /*! Sets the client list on the root window from the client_list */
259 void client_set_list();
261 /*! Determines if the client should be shown or hidden currently.
262 @return TRUE if it should be visible; otherwise, FALSE.
264 gboolean
client_should_show(ObClient
*self
);
266 /*! Returns if the window should be treated as a normal window.
267 Some windows (desktops, docks, splash screens) have special rules applied
268 to them in a number of places regarding focus or user interaction. */
269 gboolean
client_normal(ObClient
*self
);
271 /* Returns if the window is focused */
272 gboolean
client_focused(ObClient
*self
);
274 #define client_move(self, x, y) \
275 client_configure(self, OB_CORNER_TOPLEFT, x, y, \
276 self->area.width, self->area.height, \
278 #define client_resize(self, w, h) \
279 client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
281 #define client_move_resize(self, x, y, w, h) \
282 client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
284 #define client_configure(self, anchor, x, y, w, h, user, final) \
285 client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
287 /*! Move and/or resize the window.
288 This also maintains things like the client's minsize, and size increments.
289 @param anchor The corner to keep in the same position when resizing.
290 @param x The x coordiante of the new position for the client.
291 @param y The y coordiante of the new position for the client.
292 @param w The width component of the new size for the client.
293 @param h The height component of the new size for the client.
294 @param user Specifies whether this is a user-requested change or a
295 program requested change. For program requested changes, the
296 constraints are not checked.
297 @param final If user is true, then this should specify if this is a final
298 configuration. e.g. Final should be FALSE if doing an
299 interactive move/resize, and then be TRUE for the last call
301 @param force_reply Send a ConfigureNotify to the client regardless of if
302 the position changed.
304 void client_configure_full(ObClient
*self
, ObCorner anchor
,
305 int x
, int y
, int w
, int h
,
306 gboolean user
, gboolean final
,
307 gboolean force_reply
);
309 void client_reconfigure(ObClient
*self
);
311 /*! Finds coordinates to keep a client on the screen.
312 @param self The client
313 @param x The x coord of the client, may be changed.
314 @param y The y coord of the client, may be changed.
315 @param w The width of the client.
316 @param w The height of the client.
317 @param rude Be rude about it. If false, it is only moved if it is entirely
318 not visible. If true, then make sure the window is inside the
320 @return true if the client was moved to be on-screen; false if not.
322 gboolean
client_find_onscreen(ObClient
*self
, int *x
, int *y
, int w
, int h
,
325 /*! Moves a client so that it is on screen if it is entirely out of the
327 @param self The client to move
328 @param rude Be rude about it. If false, it is only moved if it is entirely
329 not visible. If true, then make sure the window is inside the
332 void client_move_onscreen(ObClient
*self
, gboolean rude
);
334 /*! Fullscreen's or unfullscreen's the client window
335 @param fs true if the window should be made fullscreen; false if it should
336 be returned to normal state.
337 @param savearea true to have the client's current size and position saved;
338 otherwise, they are not. You should not save when mapping a
339 new window that is set to fullscreen. This has no effect
340 when restoring a window from fullscreen.
342 void client_fullscreen(ObClient
*self
, gboolean fs
, gboolean savearea
);
344 /*! Iconifies or uniconifies the client window
345 @param iconic true if the window should be iconified; false if it should be
347 @param curdesk If iconic is FALSE, then this determines if the window will
348 be uniconified to the current viewable desktop (true) or to
349 its previous desktop (false)
351 void client_iconify(ObClient
*self
, gboolean iconic
, gboolean curdesk
);
353 /*! Maximize or unmaximize the client window
354 @param max true if the window should be maximized; false if it should be
355 returned to normal size.
356 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
357 @param savearea true to have the client's current size and position saved;
358 otherwise, they are not. You should not save when mapping a
359 new window that is set to fullscreen. This has no effect
360 when unmaximizing a window.
362 void client_maximize(ObClient
*self
, gboolean max
, int dir
,
365 /*! Shades or unshades the client window
366 @param shade true if the window should be shaded; false if it should be
369 void client_shade(ObClient
*self
, gboolean shade
);
371 /*! Request the client to close its window */
372 void client_close(ObClient
*self
);
374 /*! Kill the client off violently */
375 void client_kill(ObClient
*self
);
377 /*! Sends the window to the specified desktop
378 @param donthide If TRUE, the window will not be shown/hidden after its
379 desktop has been changed. Generally this should be FALSE. */
380 void client_set_desktop(ObClient
*self
, guint target
, gboolean donthide
);
382 /*! Validate client, by making sure no Destroy or Unmap events exist in
383 the event queue for the window.
384 @return true if the client is valid; false if the client has already
385 been unmapped/destroyed, and so is invalid.
387 gboolean
client_validate(ObClient
*self
);
389 /*! Sets the wm_state to the specified value */
390 void client_set_wm_state(ObClient
*self
, long state
);
392 /*! Adjusts the window's net_state
393 This should not be called as part of the window mapping process! It is for
394 use when updating the state post-mapping.<br>
395 client_apply_startup_state is used to do the same things during the mapping
398 void client_set_state(ObClient
*self
, Atom action
, long data1
, long data2
);
400 /* Given a ObClient, find the client that focus would actually be sent to if
401 you wanted to give focus to the specified ObClient. Will return the same
402 ObClient passed to it or another ObClient if appropriate. */
403 ObClient
*client_focus_target(ObClient
*self
);
405 /*! Returns what client_focus would return if passed the same client, but
406 without focusing it or modifying the focus order lists. */
407 gboolean
client_can_focus(ObClient
*self
);
409 /*! Attempt to focus the client window */
410 gboolean
client_focus(ObClient
*self
);
412 /*! Remove focus from the client window */
413 void client_unfocus(ObClient
*self
);
415 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
416 when the user deliberately selects a window for use.
417 @param here If true, then the client is brought to the current desktop;
418 otherwise, the desktop is changed to where the client lives.
420 void client_activate(ObClient
*self
, gboolean here
);
422 /*! Calculates the stacking layer for the client window */
423 void client_calc_layer(ObClient
*self
);
425 /*! Updates the window's transient status, and any parents of it */
426 void client_update_transient_for(ObClient
*self
);
427 /*! Update the protocols that the window supports and adjusts things if they
429 void client_update_protocols(ObClient
*self
);
430 /*! Updates the WMNormalHints and adjusts things if they change */
431 void client_update_normal_hints(ObClient
*self
);
433 /*! Updates the WMHints and adjusts things if they change
434 @param initstate Whether to read the initial_state property from the
435 WMHints. This should only be used during the mapping
438 void client_update_wmhints(ObClient
*self
);
439 /*! Updates the window's title and icon title */
440 void client_update_title(ObClient
*self
);
441 /*! Updates the window's application name and class */
442 void client_update_class(ObClient
*self
);
443 /*! Updates the strut for the client */
444 void client_update_strut(ObClient
*self
);
445 /*! Updates the window's icons */
446 void client_update_icons(ObClient
*self
);
448 /*! Set up what decor should be shown on the window and what functions should
449 be allowed (ObClient::decorations and ObClient::functions).
450 This also updates the NET_WM_ALLOWED_ACTIONS hint.
452 void client_setup_decor_and_functions(ObClient
*self
);
454 /*! Retrieves the window's type and sets ObClient->type */
455 void client_get_type(ObClient
*self
);
457 ObClientIcon
*client_icon(ObClient
*self
, int w
, int h
);
459 /*! Searches a client's transients for a focused window. The function does not
460 check for the passed client, only for its transients.
461 If no focused transient is found, NULL is returned.
463 ObClient
*client_search_focus_tree(ObClient
*self
);
465 /*! Searches a client's transient tree for a focused window. The function
466 searches up the tree and down other branches as well as the passed client's.
467 If no focused client is found, NULL is returned.
469 ObClient
*client_search_focus_tree_full(ObClient
*self
);
471 /*! Return a modal child of the client window that can be focused.
472 @return A modal child of the client window that can be focused, or 0 if
475 ObClient
*client_search_modal_child(ObClient
*self
);
477 ObClient
*client_search_top_transient(ObClient
*self
);
479 ObClient
*client_search_transient(ObClient
*self
, ObClient
*search
);
481 /*! Return the "closest" client in the given direction */
482 ObClient
*client_find_directional(ObClient
*c
, ObDirection dir
);
484 /*! Return the closest edge in the given direction */
485 int client_directional_edge_search(ObClient
*c
, ObDirection dir
);
487 /*! Set a client window to be above/below other clients.
488 @layer < 0 indicates the client should be placed below other clients.<br>
489 = 0 indicates the client should be placed with other clients.<br>
490 > 0 indicates the client should be placed above other clients.
492 void client_set_layer(ObClient
*self
, int layer
);
494 guint
client_monitor(ObClient
*self
);
496 gchar
* client_get_sm_client_id(ObClient
*self
);