]> Dogcows Code - chaz/openbox/blob - client.h
dbe93d2835dd28af87b2014b29859825ef09ade2
[chaz/openbox] / client.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3 client.h for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #ifndef __client_h
21 #define __client_h
22
23 #include "misc.h"
24 #include "mwm.h"
25 #include "geom.h"
26 #include "stacking.h"
27 #include "window.h"
28 #include "render/color.h"
29
30 #include <glib.h>
31 #include <X11/Xlib.h>
32
33 #ifdef HAVE_SYS_TYPES_H
34 # include <sys/types.h> /* for pid_t */
35 #endif
36
37 struct _ObFrame;
38 struct _ObGroup;
39 struct _ObSessionState;
40 struct _ObPrompt;
41
42 typedef struct _ObClient ObClient;
43 typedef struct _ObClientIcon ObClientIcon;
44
45 /*! Holds an icon in ARGB format */
46 struct _ObClientIcon
47 {
48 gint width;
49 gint height;
50 RrPixel32 *data;
51 };
52
53 /*! Possible window types */
54 typedef enum
55 {
56 OB_CLIENT_TYPE_DESKTOP, /*!< A desktop (bottom-most window) */
57 OB_CLIENT_TYPE_DOCK, /*!< A dock bar/panel window */
58 OB_CLIENT_TYPE_TOOLBAR, /*!< A toolbar window, pulled off an app */
59 OB_CLIENT_TYPE_MENU, /*!< An unpinned menu from an app */
60 OB_CLIENT_TYPE_UTILITY, /*!< A small utility window such as a palette */
61 OB_CLIENT_TYPE_SPLASH, /*!< A splash screen window */
62 OB_CLIENT_TYPE_DIALOG, /*!< A dialog window */
63 OB_CLIENT_TYPE_NORMAL /*!< A normal application window */
64 } ObClientType;
65
66 /*! The things the user can do to the client window */
67 typedef enum
68 {
69 OB_CLIENT_FUNC_RESIZE = 1 << 0, /*!< Allow user resizing */
70 OB_CLIENT_FUNC_MOVE = 1 << 1, /*!< Allow user moving */
71 OB_CLIENT_FUNC_ICONIFY = 1 << 2, /*!< Allow to be iconified */
72 OB_CLIENT_FUNC_MAXIMIZE = 1 << 3, /*!< Allow to be maximized */
73 OB_CLIENT_FUNC_SHADE = 1 << 4, /*!< Allow to be shaded */
74 OB_CLIENT_FUNC_FULLSCREEN = 1 << 5, /*!< Allow to be made fullscreen */
75 OB_CLIENT_FUNC_CLOSE = 1 << 6, /*!< Allow to be closed */
76 OB_CLIENT_FUNC_ABOVE = 1 << 7, /*!< Allow to be put in lower layer */
77 OB_CLIENT_FUNC_BELOW = 1 << 8, /*!< Allow to be put in higher layer */
78 OB_CLIENT_FUNC_UNDECORATE = 1 << 9 /*!< Allow to be undecorated */
79 } ObFunctions;
80
81 struct _ObClient
82 {
83 ObWindow obwin;
84 Window window;
85
86 /*! If this client is managing an ObPrompt window, then this is set to the
87 prompt */
88 struct _ObPrompt *prompt;
89
90 /*! The window's decorations. NULL while the window is being managed! */
91 struct _ObFrame *frame;
92
93 /*! The number of unmap events to ignore on the window */
94 gint ignore_unmaps;
95
96 /*! The id of the group the window belongs to */
97 struct _ObGroup *group;
98
99 /*! Saved session data to apply to this client */
100 struct _ObSessionState *session;
101
102 /*! Whether or not the client is a transient window. It may or may not
103 have parents when this is true. */
104 gboolean transient;
105 /*! Whether or not the client is transient for its group */
106 gboolean transient_for_group;
107 /*! The client which are parents of this client */
108 GSList *parents;
109 /*! The clients which are transients (children) of this client */
110 GSList *transients;
111 /*! The desktop on which the window resides (0xffffffff for all
112 desktops) */
113 guint desktop;
114
115 /*! The startup id for the startup-notification protocol. This will be
116 NULL if a startup id is not set. */
117 gchar *startup_id;
118
119 /*! Normal window title */
120 gchar *title;
121 /*! Window title when iconified */
122 gchar *icon_title;
123 /*! The title as requested by the client, without any of our own changes */
124 gchar *original_title;
125 /*! Hostname of machine running the client */
126 gchar *client_machine;
127 /*! The command used to run the program. Pre-XSMP window identification. */
128 gchar *wm_command;
129 /*! The PID of the process which owns the window */
130 pid_t pid;
131
132 /*! The application that created the window */
133 gchar *name;
134 /*! The class of the window, can used for grouping */
135 gchar *class;
136 /*! The specified role of the window, used for identification */
137 gchar *role;
138 /*! The session client id for the window. *This can be NULL!* */
139 gchar *sm_client_id;
140
141 /*! The type of window (what its function is) */
142 ObClientType type;
143
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
147 gravity is applied.
148 */
149 Rect area;
150
151 /*! Position of the client window relative to the root window */
152 Point root_pos;
153
154 /*! Position and size of the window prior to being maximized */
155 Rect pre_max_area;
156 /*! Position and size of the window prior to being fullscreened */
157 Rect pre_fullscreen_area;
158
159 /*! The window's strut
160 The strut defines areas of the screen that are marked off-bounds for
161 window placement. In theory, where this window exists.
162 */
163 StrutPartial strut;
164
165 /*! The logical size of the window
166 The "logical" size of the window is refers to the user's perception of
167 the size of the window, and is the value that should be displayed to the
168 user. For example, with xterms, this value it the number of characters
169 being displayed in the terminal, instead of the number of pixels.
170 */
171 Size logical_size;
172
173 /*! Width of the border on the window.
174 The window manager will set this to 0 while the window is being managed,
175 but needs to restore it afterwards, so it is saved here.
176 */
177 gint border_width;
178
179 /*! The minimum aspect ratio the client window can be sized to.
180 A value of 0 means this is ignored.
181 */
182 gfloat min_ratio;
183 /*! The maximum aspect ratio the client window can be sized to.
184 A value of 0 means this is ignored.
185 */
186 gfloat max_ratio;
187
188 /*! The minimum size of the client window
189 If the min is > the max, then the window is not resizable
190 */
191 Size min_size;
192 /*! The maximum size of the client window
193 If the min is > the max, then the window is not resizable
194 */
195 Size max_size;
196 /*! The size of increments to resize the client window by */
197 Size size_inc;
198 /*! The base size of the client window
199 This value should be subtracted from the window's actual size when
200 displaying its size to the user, or working with its min/max size
201 */
202 Size base_size;
203
204 /*! Window decoration and functionality hints */
205 ObMwmHints mwmhints;
206
207 /*! The client's specified colormap */
208 Colormap colormap;
209
210 /*! Where to place the decorated window in relation to the undecorated
211 window */
212 gint gravity;
213
214 /*! The state of the window, one of WithdrawnState, IconicState, or
215 NormalState */
216 glong wmstate;
217
218 /*! True if the client supports the delete_window protocol */
219 gboolean delete_window;
220
221 /*! Was the window's position requested by the application or the user?
222 if by the application, we force it completely onscreen, if by the user
223 we only force it if it tries to go completely offscreen, if neither, we
224 should place the window ourselves when it first appears */
225 guint positioned;
226
227 /*! Was the window's size requested by the application or the user?
228 If by the application we don't let it go outside the available area */
229 guint sized;
230
231 /*! Can the window receive input focus? */
232 gboolean can_focus;
233 /*! Notify the window when it receives focus? */
234 gboolean focus_notify;
235
236 /*! Will the client respond to pings? */
237 gboolean ping;
238 /*! Indicates if the client is trying to close but has stopped responding
239 to pings */
240 gboolean not_responding;
241 /*! A prompt shown when you are trying to close a client that is not
242 responding. It asks if you want to kill the client */
243 struct _ObPrompt *kill_prompt;
244 /*! We tried to close the window with a SIGTERM */
245 gint kill_level;
246
247 #ifdef SYNC
248 /*! The client wants to sync during resizes */
249 gboolean sync_request;
250 /*! The XSync counter used for synchronizing during resizes */
251 guint32 sync_counter;
252 /*! The value we're waiting for the counter to reach */
253 gulong sync_counter_value;
254 #endif
255
256 /*! The window uses shape extension to be non-rectangular? */
257 gboolean shaped;
258
259 /*! The window is modal, so it must be processed before any windows it is
260 related to can be focused */
261 gboolean modal;
262 /*! Only the window's titlebar is displayed */
263 gboolean shaded;
264 /*! The window is iconified */
265 gboolean iconic;
266 /*! The window is maximized to fill the screen vertically */
267 gboolean max_vert;
268 /*! The window is maximized to fill the screen horizontally */
269 gboolean max_horz;
270 /*! The window should not be displayed by pagers */
271 gboolean skip_pager;
272 /*! The window should not be displayed by taskbars */
273 gboolean skip_taskbar;
274 /*! The window is a 'fullscreen' window, and should be on top of all
275 others */
276 gboolean fullscreen;
277 /*! The window should be on top of other windows of the same type.
278 above takes priority over below. */
279 gboolean above;
280 /*! The window should be underneath other windows of the same type.
281 above takes priority over below. */
282 gboolean below;
283 /*! Demands attention flag */
284 gboolean demands_attention;
285
286 /*! The urgent flag */
287 gboolean urgent;
288
289 /*! The layer in which the window will be stacked, windows in lower layers
290 are always below windows in higher layers. */
291 ObStackingLayer layer;
292
293 /*! A bitmask of values in the ObFrameDecorations enum
294 The values in the variable are the decorations that the client wants to
295 be displayed around it.
296 */
297 guint decorations;
298
299 /*! A user option. When this is set to TRUE the client will not ever
300 be decorated.
301 */
302 gboolean undecorated;
303
304 /*! A bitmask of values in the ObFunctions enum
305 The values in the variable specify the ways in which the user is allowed
306 to modify this window.
307 */
308 guint functions;
309
310 /*! Icons for the client as specified on the client window */
311 ObClientIcon *icons;
312 /*! The number of icons in icons */
313 guint nicons;
314
315 /*! Where the window should iconify to/from */
316 Rect icon_geometry;
317
318 /*! A boolean used for algorithms which need to mark clients as visited */
319 gboolean visited;
320 };
321
322 extern GList *client_list;
323
324 void client_startup(gboolean reconfig);
325 void client_shutdown(gboolean reconfig);
326
327 typedef void (*ObClientCallback)(ObClient *client, gpointer data);
328
329 /* Callback functions */
330
331 /*! Get notified when the client is unmanaged */
332 void client_add_destroy_notify(ObClientCallback func, gpointer data);
333 void client_remove_destroy_notify(ObClientCallback func);
334
335 /*! Manages a given window
336 @param prompt This specifies an ObPrompt which is being managed. It is
337 possible to manage Openbox-owned windows through this.
338 */
339 void client_manage(Window win, struct _ObPrompt *prompt);
340 /*! Unmanages all managed windows */
341 void client_unmanage_all();
342 /*! Unmanages a given client */
343 void client_unmanage(ObClient *client);
344
345 /*! This manages a window only so far as is needed to get it's decorations.
346 This is used when you want to determine a window's decorations before it
347 is mapped. Call client_fake_unmanage() with the returned client when you
348 are done with it. */
349 ObClient *client_fake_manage(Window win);
350 /*! Free the stuff created by client_fake_manage() */
351 void client_fake_unmanage(ObClient *self);
352
353 /*! Sets the client list on the root window from the client_list */
354 void client_set_list();
355
356 /*! Determines if the client should be shown or hidden currently.
357 @return TRUE if it should be visible; otherwise, FALSE.
358 */
359 gboolean client_should_show(ObClient *self);
360
361 /*! Returns if the window should be treated as a normal window.
362 Some windows (desktops, docks, splash screens) have special rules applied
363 to them in a number of places regarding focus or user interaction. */
364 gboolean client_normal(ObClient *self);
365
366 /*! Returns if the window is one of an application's helper windows
367 (utilty, menu, etc) */
368 gboolean client_helper(ObClient *self);
369
370 /*! Return if the client is a type which should be given focus from mouse
371 presses on the *client* window. This doesn't affect clicking on the
372 decorations. This doesn't count for focus cycling, different rules apply to
373 that. */
374 gboolean client_mouse_focusable(ObClient *self);
375
376 /*! Return if the client is a type which should be given focus from the
377 mouse entering the window. This doesn't count for focus cycling, different
378 rules apply to that. */
379 gboolean client_enter_focusable(ObClient *self);
380
381 /* Returns if the window is focused */
382 gboolean client_focused(ObClient *self);
383
384 /*! When the client is resized but not moved, figure out the new position
385 for it based on its gravity:
386 http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
387 */
388 void client_gravity_resize_w(ObClient *self, gint *x, gint oldw, gint neww);
389
390 /*! When the client is resized but not moved, figure out the new position
391 for it based on its gravity:
392 http://standards.freedesktop.org/wm-spec/wm-spec-1.4.html#id2512541
393 */
394 void client_gravity_resize_h(ObClient *self, gint *y, gint oldh, gint newh);
395
396 /*! Convert a position/size from a given gravity to the client's true gravity,
397 when the client is only resizing (the reference point doesn't move)
398 */
399 void client_convert_gravity_resize(ObClient *self, gint gravity,
400 gint *x, gint *y,
401 gint w, gint h);
402
403 #define client_move(self, x, y) \
404 client_configure(self, x, y, self->area.width, self->area.height, TRUE, TRUE,\
405 FALSE)
406 #define client_resize(self, w, h) \
407 client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE, FALSE)
408 #define client_move_resize(self, x, y, w, h) \
409 client_configure(self, x, y, w, h, TRUE, TRUE, FALSE)
410 #define client_reconfigure(self, force) \
411 client_configure(self, ((ObClient*)self)->area.x, ((ObClient*)self)->area.y, \
412 ((ObClient*)self)->area.width, \
413 ((ObClient*)self)->area.height, FALSE, TRUE, force)
414
415 /*! Figure out where a window will end up and what size it will be if you
416 told it to move/resize to these coordinates.
417
418 These values are what client_configure will give the window.
419
420 @param x The x coordiante of the new position for the client.
421 @param y The y coordiante of the new position for the client.
422 @param w The width component of the new size for the client.
423 @param h The height component of the new size for the client.
424 @param logicalw Returns the width component of the new logical width.
425 This value is only returned when the new w or h calculated
426 differ from the ones passed in.
427 @param logicalh Returns the height component of the new logical height.
428 This value is only returned when the new w or h calculated
429 differ from the ones passed in.
430 @param user Specifies whether this is a user-requested change or a
431 program requested change. For program requested changes, the
432 constraints are not checked.
433 */
434 void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
435 gint *logicalw, gint *logicalh,
436 gboolean user);
437
438 /*! Move and/or resize the window.
439 This also maintains things like the client's minsize, and size increments.
440 @param x The x coordiante of the new position for the client.
441 @param y The y coordiante of the new position for the client.
442 @param w The width component of the new size for the client.
443 @param h The height component of the new size for the client.
444 @param user Specifies whether this is a user-requested change or a
445 program requested change. For program requested changes, the
446 constraints are not checked.
447 @param final If user is true, then this should specify if this is a final
448 configuration. e.g. Final should be FALSE if doing an
449 interactive move/resize, and then be TRUE for the last call
450 only.
451 @param force_reply Send a ConfigureNotify to the client regardless of if
452 the position/size changed.
453 */
454 void client_configure(ObClient *self, gint x, gint y, gint w, gint h,
455 gboolean user, gboolean final, gboolean force_reply);
456
457 /*! Finds coordinates to keep a client on the screen.
458 @param self The client
459 @param x The x coord of the client, may be changed.
460 @param y The y coord of the client, may be changed.
461 @param w The width of the client.
462 @param w The height of the client.
463 @param rude Be rude about it. If false, it is only moved if it is entirely
464 not visible. If true, then make sure the window is inside the
465 struts if possible.
466 @return true if the client was moved to be on-screen; false if not.
467 */
468 gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
469 gboolean rude);
470
471 /*! Moves a client so that it is on screen if it is entirely out of the
472 viewable screen.
473 @param self The client to move
474 @param rude Be rude about it. If false, it is only moved if it is entirely
475 not visible. If true, then make sure the window is inside the
476 struts if possible.
477 */
478 void client_move_onscreen(ObClient *self, gboolean rude);
479
480 /*! dir is either North, South, East or West. It can't be, for example,
481 Northwest */
482 void client_find_edge_directional(ObClient *self, ObDirection dir,
483 gint my_head, gint my_tail,
484 gint my_edge_start, gint my_edge_size,
485 gint *dest, gboolean *near_edge);
486 void client_find_move_directional(ObClient *self, ObDirection dir,
487 gint *x, gint *y);
488 void client_find_resize_directional(ObClient *self, ObDirection side,
489 gboolean grow,
490 gint *x, gint *y, gint *w, gint *h);
491
492 /*! Fullscreen's or unfullscreen's the client window
493 @param fs true if the window should be made fullscreen; false if it should
494 be returned to normal state.
495 */
496 void client_fullscreen(ObClient *self, gboolean fs);
497
498 /*! Iconifies or uniconifies the client window
499 @param iconic true if the window should be iconified; false if it should be
500 restored.
501 @param curdesk If iconic is FALSE, then this determines if the window will
502 be uniconified to the current viewable desktop (true) or to
503 its previous desktop (false)
504 */
505 void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk,
506 gboolean hide_animation);
507
508 /*! Maximize or unmaximize the client window
509 @param max true if the window should be maximized; false if it should be
510 returned to normal size.
511 @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
512 */
513 void client_maximize(ObClient *self, gboolean max, gint dir);
514
515 /*! Shades or unshades the client window
516 @param shade true if the window should be shaded; false if it should be
517 unshaded.
518 */
519 void client_shade(ObClient *self, gboolean shade);
520
521 /*! Set a client window to have decorations or not */
522 void client_set_undecorated(ObClient *self, gboolean undecorated);
523
524 /*! Hilite the window to make the user notice it */
525 void client_hilite(ObClient *self, gboolean hilite);
526
527 /*! Request the client to close its window */
528 void client_close(ObClient *self);
529
530 /*! Kill the client off violently */
531 void client_kill(ObClient *self);
532
533 /*! Sends the window to the specified desktop
534 @param donthide If TRUE, the window will not be shown/hidden after its
535 desktop has been changed. Generally this should be FALSE.
536 @param dontraise If TRUE, the window will not be raised. Generally this should
537 be FALSE.
538 */
539 void client_set_desktop(ObClient *self, guint target, gboolean donthide,
540 gboolean dontraise);
541
542 /*! Show the client if it should be shown. Returns if the window is shown. */
543 gboolean client_show(ObClient *self);
544
545 /*! Show the client if it should be shown. Returns if the window is hidden. */
546 gboolean client_hide(ObClient *self);
547
548 /*! Show the client if it should be shown, and hide it if it should be
549 hidden. This is for example, when switching desktops.
550 */
551 void client_showhide(ObClient *self);
552
553 /*! Validate client, by making sure no Destroy or Unmap events exist in
554 the event queue for the window.
555 @return true if the client is valid; false if the client has already
556 been unmapped/destroyed, and so is invalid.
557 */
558 gboolean client_validate(ObClient *self);
559
560 /*! Sets the wm_state to the specified value */
561 void client_set_wm_state(ObClient *self, glong state);
562
563 /*! Adjusts the window's net_state
564 This should not be called as part of the window mapping process! It is for
565 use when updating the state post-mapping.<br>
566 client_apply_startup_state is used to do the same things during the mapping
567 process.
568 */
569 void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
570
571 /* Given a ObClient, find the client that focus would actually be sent to if
572 you wanted to give focus to the specified ObClient. Will return the same
573 ObClient passed to it or another ObClient if appropriate. */
574 ObClient *client_focus_target(ObClient *self);
575
576 /*! Returns what client_focus would return if passed the same client, but
577 without focusing it or modifying the focus order lists. */
578 gboolean client_can_focus(ObClient *self);
579
580 /*! Attempt to focus the client window */
581 gboolean client_focus(ObClient *self);
582
583 /*! Activates the client for use, focusing, uniconifying it, etc. To be used
584 when the user deliberately selects a window for use.
585 @param here If true, then the client is brought to the current desktop;
586 otherwise, the desktop is changed to where the client lives.
587 @param raise If true, the client is brought to the front.
588 @param unshade If true, the client is unshaded (if it is shaded)
589 @param user If true, then a user action is what requested the activation;
590 otherwise, it means an application requested it on its own
591 */
592 void client_activate(ObClient *self, gboolean here, gboolean raise,
593 gboolean unshade, gboolean user);
594
595 /*! Bring all of its helper windows to its desktop. These are the utility and
596 stuff windows. */
597 void client_bring_helper_windows(ObClient *self);
598
599 /*! Bring all of its modal windows to its desktop. */
600 void client_bring_modal_windows(ObClient *self);
601
602 /*! Calculates the stacking layer for the client window */
603 void client_calc_layer(ObClient *self);
604
605 /*! Updates the window's transient status, and any parents of it */
606 void client_update_transient_for(ObClient *self);
607 /*! Update the protocols that the window supports and adjusts things if they
608 change */
609 void client_update_protocols(ObClient *self);
610 #ifdef SYNC
611 /*! Updates the window's sync request counter for resizes */
612 void client_update_sync_request_counter(ObClient *self);
613 #endif
614 /*! Updates the window's colormap */
615 void client_update_colormap(ObClient *self, Colormap colormap);
616 /*! Updates the WMNormalHints and adjusts things if they change */
617 void client_update_normal_hints(ObClient *self);
618
619 /*! Updates the WMHints and adjusts things if they change
620 @param initstate Whether to read the initial_state property from the
621 WMHints. This should only be used during the mapping
622 process.
623 */
624 void client_update_wmhints(ObClient *self);
625 /*! Updates the window's title and icon title */
626 void client_update_title(ObClient *self);
627 /*! Updates the strut for the client */
628 void client_update_strut(ObClient *self);
629 /*! Updates the window's icons */
630 void client_update_icons(ObClient *self);
631 /*! Updates the window's icon geometry (where to iconify to/from) */
632 void client_update_icon_geometry(ObClient *self);
633
634 /*! Set up what decor should be shown on the window and what functions should
635 be allowed (ObClient::decorations and ObClient::functions).
636 This also updates the NET_WM_ALLOWED_ACTIONS hint.
637 @param reconfig When TRUE, the window will be reconfigured to show the
638 changes
639 */
640 void client_setup_decor_and_functions(ObClient *self, gboolean reconfig);
641
642 /*! Sets the window's type and transient flag */
643 void client_get_type_and_transientness(ObClient *self);
644
645 const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
646
647 /*! Return TRUE if the client is transient for some other window. Return
648 FALSE if it's not transient or there is no window for it to be
649 transient for */
650 gboolean client_has_parent(ObClient *self);
651
652 /*! Searches a client's direct parents for a focused window. The function does
653 not check for the passed client, only for *ONE LEVEL* of its parents.
654 If no focused parentt is found, NULL is returned.
655 */
656 ObClient *client_search_focus_parent(ObClient *self);
657
658 /*! Searches a client's transients for a focused window. The function does not
659 check for the passed client, only for its transients.
660 If no focused transient is found, NULL is returned.
661 */
662 ObClient *client_search_focus_tree(ObClient *self);
663
664 /*! Searches a client's transient tree for a focused window. The function
665 searches up the tree and down other branches as well as the passed client's.
666 If no focused client is found, NULL is returned.
667 */
668 ObClient *client_search_focus_tree_full(ObClient *self);
669
670 /*! Searches a client's group and each member's transients for a focused
671 window. This doesn't go up the window's transient tree at all. If no
672 focused client is found, NULL is returned. */
673 ObClient *client_search_focus_group_full(ObClient *self);
674
675 /*! Return a modal child of the client window that can be focused.
676 @return A modal child of the client window that can be focused, or 0 if
677 none was found.
678 */
679 ObClient *client_search_modal_child(ObClient *self);
680
681 /*! Returns a list of top-level windows which this is a transient for.
682 It will only contain more than 1 element if the client is transient for its
683 group.
684 */
685 GSList *client_search_all_top_parents(ObClient *self);
686
687 /*! Returns a list of top-level windows which this is a transient for, and
688 which are in the same layer as this client.
689 It will only contain more than 1 element if the client is transient for its
690 group.
691 */
692 GSList *client_search_all_top_parents_layer(ObClient *self);
693
694 /*! Returns the client's parent when it is transient for a direct window
695 rather than a group. If it has no parents, or is transient for the
696 group, this returns null */
697 ObClient *client_direct_parent(ObClient *self);
698
699 /*! Returns a window's top level parent. This only counts direct parents,
700 not groups if it is transient for its group.
701 */
702 ObClient *client_search_top_direct_parent(ObClient *self);
703
704 /*! Is one client a direct child of another (i.e. not through the group.)
705 This checks more than one level, so there may be another direct child in
706 between */
707 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
708
709 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
710 returns the searched for parent if it is a parent, or NULL if not. */
711 ObClient *client_search_parent(ObClient *self, ObClient *search);
712
713 /*! Search for a transient of a client. The transient is returned if it is one,
714 NULL is returned if the given search is not a transient of the client. */
715 ObClient *client_search_transient(ObClient *self, ObClient *search);
716
717 /*! Set a client window to be above/below other clients.
718 @layer < 0 indicates the client should be placed below other clients.<br />
719 = 0 indicates the client should be placed with other clients.<br />
720 > 0 indicates the client should be placed above other clients.
721 */
722 void client_set_layer(ObClient *self, gint layer);
723
724 guint client_monitor(ObClient *self);
725
726 ObClient* client_under_pointer();
727
728 gboolean client_has_group_siblings(ObClient *self);
729
730 #endif
This page took 0.063234 seconds and 3 git commands to generate.