+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+ client.h for the Openbox window manager
+ Copyright (c) 2006 Mikael Magnusson
+ Copyright (c) 2003-2007 Dana Jansens
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ See the COPYING file for a copy of the GNU General Public License.
+*/
+
#ifndef __client_h
#define __client_h
#include <glib.h>
#include <X11/Xlib.h>
-struct Frame;
-struct Group;
+struct _ObFrame;
+struct _ObGroup;
+struct _ObSessionState;
-typedef struct _ObClient ObClient;
-typedef struct _ObClientIcon ObClientIcon;
+typedef struct _ObClient ObClient;
+typedef struct _ObClientIcon ObClientIcon;
+typedef struct _ObAppSettings ObAppSettings;
/* The value in client.transient_for indicating it is a transient for its
group instead of for a single window */
-#define TRAN_GROUP ((void*)~0l)
+#define OB_TRAN_GROUP ((void*)~0l)
/*! Holds an icon in ARGB format */
struct _ObClientIcon
};
/*! Possible window types */
-typedef enum {
- Type_Desktop, /*!< A desktop (bottom-most window) */
- Type_Dock, /*!< A dock bar/panel window */
- Type_Toolbar, /*!< A toolbar window, pulled off an app */
- Type_Menu, /*!< An unpinned menu from an app */
- Type_Utility, /*!< A small utility window such as a palette */
- Type_Splash, /*!< A splash screen window */
- Type_Dialog, /*!< A dialog window */
- Type_Normal /*!< A normal application window */
-} WindowType;
+typedef enum
+{
+ OB_CLIENT_TYPE_DESKTOP, /*!< A desktop (bottom-most window) */
+ OB_CLIENT_TYPE_DOCK, /*!< A dock bar/panel window */
+ OB_CLIENT_TYPE_TOOLBAR, /*!< A toolbar window, pulled off an app */
+ OB_CLIENT_TYPE_MENU, /*!< An unpinned menu from an app */
+ OB_CLIENT_TYPE_UTILITY, /*!< A small utility window such as a palette */
+ OB_CLIENT_TYPE_SPLASH, /*!< A splash screen window */
+ OB_CLIENT_TYPE_DIALOG, /*!< A dialog window */
+ OB_CLIENT_TYPE_NORMAL /*!< A normal application window */
+} ObClientType;
/*! The things the user can do to the client window */
-typedef enum {
- Func_Resize = 1 << 0, /*!< Allow resizing */
- Func_Move = 1 << 1, /*!< Allow moving */
- Func_Iconify = 1 << 2, /*!< Allow to be iconified */
- Func_Maximize = 1 << 3, /*!< Allow to be maximized */
- Func_Shade = 1 << 4, /*!< Allow to be shaded */
- Func_Fullscreen = 1 << 5, /*!< Allow to be made fullscreen */
- Func_Close = 1 << 6 /*!< Allow to be closed */
-} Function;
-
-/*! The decorations the client window wants to be displayed on it */
-typedef enum {
- Decor_Titlebar = 1 << 0, /*!< Display a titlebar */
- Decor_Handle = 1 << 1, /*!< Display a handle (bottom) */
- Decor_Border = 1 << 2, /*!< Display a border */
- Decor_Icon = 1 << 3, /*!< Display the window's icon */
- Decor_Iconify = 1 << 4, /*!< Display an iconify button */
- Decor_Maximize = 1 << 5, /*!< Display a maximize button */
- /*! Display a button to toggle the window's placement on
- all desktops */
- Decor_AllDesktops = 1 << 6,
- Decor_Shade = 1 << 7, /*!< Displays a shade button */
- Decor_Close = 1 << 8 /*!< Display a close button */
-} Decoration;
+typedef enum
+{
+ OB_CLIENT_FUNC_RESIZE = 1 << 0, /*!< Allow user resizing */
+ OB_CLIENT_FUNC_MOVE = 1 << 1, /*!< Allow user moving */
+ OB_CLIENT_FUNC_ICONIFY = 1 << 2, /*!< Allow to be iconified */
+ OB_CLIENT_FUNC_MAXIMIZE = 1 << 3, /*!< Allow to be maximized */
+ OB_CLIENT_FUNC_SHADE = 1 << 4, /*!< Allow to be shaded */
+ OB_CLIENT_FUNC_FULLSCREEN = 1 << 5, /*!< Allow to be made fullscreen */
+ OB_CLIENT_FUNC_CLOSE = 1 << 6 /*!< Allow to be closed */
+} ObFunctions;
struct _ObClient
{
Window window;
/*! The window's decorations. NULL while the window is being managed! */
- struct Frame *frame;
+ struct _ObFrame *frame;
/*! The number of unmap events to ignore on the window */
- int ignore_unmaps;
+ gint ignore_unmaps;
/*! The id of the group the window belongs to */
- struct Group *group;
+ struct _ObGroup *group;
+
+ /*! Saved session data to apply to this client */
+ struct _ObSessionState *session;
+
/*! Whether or not the client is a transient window. This is guaranteed to
be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
transient_for == NULL. */
gboolean transient;
/*! The client which this client is a transient (child) for.
A value of TRAN_GROUP signifies that the window is a transient for all
- members of its Group, and is not a valid pointer to be followed in this
+ members of its ObGroup, and is not a valid pointer to be followed in this
case.
*/
ObClient *transient_for;
desktops) */
guint desktop;
+ /*! The startup id for the startup-notification protocol. This will be
+ NULL if a startup id is not set. */
+ gchar *startup_id;
+
/*! Normal window title */
gchar *title;
- /*! The count for the title. When another window with the same title
- exists, a count will be appended to it. */
- guint title_count;
/*! Window title when iconified */
gchar *icon_title;
+ /*! Hostname of machine running the client */
+ gchar *client_machine;
+ /*! The command used to run the program. Pre-XSMP window identification. */
+ gchar *wm_command;
/*! The application that created the window */
gchar *name;
gchar *class;
/*! The specified role of the window, used for identification */
gchar *role;
+ /*! The session client id for the window. *This can be NULL!* */
+ gchar *sm_client_id;
/*! The type of window (what its function is) */
- WindowType type;
+ ObClientType type;
/*! Position and size of the window
This will not always be the actual position of the window on screen, it
is, rather, the position requested by the client, to which the window's
gravity is applied.
*/
- Rect area;
+ Rect area;
+
+ /*! Position of the client window relative to the root window */
+ Point root_pos;
+
+ /*! Position and size of the window prior to being maximized */
+ Rect pre_max_area;
+ /*! Position and size of the window prior to being fullscreened */
+ Rect pre_fullscreen_area;
/*! The window's strut
The strut defines areas of the screen that are marked off-bounds for
window placement. In theory, where this window exists.
*/
- Strut strut;
+ StrutPartial strut;
/*! The logical size of the window
The "logical" size of the window is refers to the user's perception of
user. For example, with xterms, this value it the number of characters
being displayed in the terminal, instead of the number of pixels.
*/
- Size logical_size;
+ Size logical_size;
/*! Width of the border on the window.
The window manager will set this to 0 while the window is being managed,
/*! The minimum aspect ratio the client window can be sized to.
A value of 0 means this is ignored.
*/
- float min_ratio;
+ gfloat min_ratio;
/*! The maximum aspect ratio the client window can be sized to.
A value of 0 means this is ignored.
*/
- float max_ratio;
+ gfloat max_ratio;
/*! The minimum size of the client window
If the min is > the max, then the window is not resizable
/*! Window decoration and functionality hints */
ObMwmHints mwmhints;
+
+ /*! The client's specified colormap */
+ Colormap colormap;
/*! Where to place the decorated window in relation to the undecorated
window */
- int gravity;
+ gint gravity;
/*! The state of the window, one of WithdrawnState, IconicState, or
NormalState */
- long wmstate;
+ glong wmstate;
/*! True if the client supports the delete_window protocol */
gboolean delete_window;
- /*! Was the window's position requested by the application? if not, we
+ /*! Was the window's position requested by the application or the user?
+ if by the application, we force it completely onscreen, if by the user
+ we only force it if it tries to go completely offscreen, if neither, we
should place the window ourselves when it first appears */
- gboolean positioned;
+ guint positioned;
/*! Can the window receive input focus? */
gboolean can_focus;
- /*! Urgency flag */
- gboolean urgent;
/*! Notify the window when it receives focus? */
gboolean focus_notify;
+#ifdef SYNC
+ /*! The client wants to sync during resizes */
+ gboolean sync_request;
+ /*! The XSync counter used for synchronizing during resizes */
+ guint32 sync_counter;
+ /*! The value we're waiting for the counter to reach */
+ gulong sync_counter_value;
+#endif
+
/*! The window uses shape extension to be non-rectangular? */
gboolean shaped;
/*! The window should be underneath other windows of the same type.
above takes priority over below. */
gboolean below;
+ /*! Demands attention flag */
+ gboolean demands_attention;
+
+ /*! The urgent flag */
+ gboolean urgent;
/*! The layer in which the window will be stacked, windows in lower layers
are always below windows in higher layers. */
- StackLayer layer;
+ ObStackingLayer layer;
- /*! A bitmask of values in the Decoration enum
+ /*! A bitmask of values in the ObFrameDecorations enum
The values in the variable are the decorations that the client wants to
be displayed around it.
*/
- int decorations;
+ guint decorations;
- /*! A bitmask of values in the Decoration enum.
- Specifies the decorations that should NOT be displayed on the client.
+ /*! A user option. When this is set to TRUE the client will not ever
+ be decorated.
*/
- int disabled_decorations;
+ gboolean undecorated;
- /*! A bitmask of values in the Function enum
+ /*! A bitmask of values in the ObFunctions enum
The values in the variable specify the ways in which the user is allowed
to modify this window.
*/
- int functions;
+ guint functions;
/*! Icons for the client as specified on the client window */
ObClientIcon *icons;
/*! The number of icons in icons */
- int nicons;
+ guint nicons;
+
+ /* Where the window should iconify to/from */
+ Rect icon_geometry;
+
+ guint32 user_time;
};
extern GList *client_list;
-void client_startup();
-void client_shutdown();
+void client_startup(gboolean reconfig);
+void client_shutdown(gboolean reconfig);
+
+typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
+
+void client_add_destructor(ObClientDestructor func, gpointer data);
+void client_remove_destructor(ObClientDestructor func);
/*! Manages all existing windows */
void client_manage_all();
to them in a number of places regarding focus or user interaction. */
gboolean client_normal(ObClient *self);
+/*! Returns if the window is one of an application's main windows (normal or
+ dialog type) rather than an accessory window (utilty, menu, etc) or a
+ non-normal window */
+gboolean client_application(ObClient *self);
+
/* Returns if the window is focused */
gboolean client_focused(ObClient *self);
+/*! Convery a position/size from a given gravity to the client's true gravity
+ */
+void client_convert_gravity(ObClient *client, gint gravity, gint *x, gint *y,
+ gint w, gint h);
+
+#define client_move(self, x, y) \
+ client_configure(self, x, y, self->area.width, self->area.height, \
+ TRUE, TRUE)
+#define client_resize(self, w, h) \
+ client_configure(self, self->area.x, self->area.y, w, h, TRUE, TRUE)
+#define client_move_resize(self, x, y, w, h) \
+ client_configure(self, x, y, w, h, TRUE, TRUE)
+
+#define client_configure(self, x, y, w, h, user, final) \
+ client_configure_full(self, x, y, w, h, user, final, FALSE)
+
+/*! Figure out where a window will end up and what size it will be if you
+ told it to move/resize to these coordinates.
+
+ These values are what client_configure_full will give the window.
+
+ @param x The x coordiante of the new position for the client.
+ @param y The y coordiante of the new position for the client.
+ @param w The width component of the new size for the client.
+ @param h The height component of the new size for the client.
+ @param logicalw Returns the width component of the new logical width.
+ This value is only returned when the new w or h calculated
+ differ from the ones passed in.
+ @param logicalh Returns the height component of the new logical height.
+ This value is only returned when the new w or h calculated
+ differ from the ones passed in.
+ @param user Specifies whether this is a user-requested change or a
+ program requested change. For program requested changes, the
+ constraints are not checked.
+*/
+void client_try_configure(ObClient *self, gint *x, gint *y, gint *w, gint *h,
+ gint *logicalw, gint *logicalh,
+ gboolean user);
+
/*! Move and/or resize the window.
This also maintains things like the client's minsize, and size increments.
- @param anchor The corner to keep in the same position when resizing.
@param x The x coordiante of the new position for the client.
@param y The y coordiante of the new position for the client.
@param w The width component of the new size for the client.
@param h The height component of the new size for the client.
@param user Specifies whether this is a user-requested change or a
program requested change. For program requested changes, the
- constraints are not checked.
+ constraints are not checked.
@param final If user is true, then this should specify if this is a final
configuration. e.g. Final should be FALSE if doing an
- interactive move/resize, and then be TRUE for the last call
- only.
+ interactive move/resize, and then be TRUE for the last call
+ only.
+ @param force_reply Send a ConfigureNotify to the client regardless of if
+ the position changed.
*/
-void client_configure(ObClient *self, ObCorner anchor,
- int x, int y, int w, int h,
- gboolean user, gboolean final);
+void client_configure_full(ObClient *self, gint x, gint y, gint w, gint h,
+ gboolean user, gboolean final,
+ gboolean force_reply);
void client_reconfigure(ObClient *self);
+/*! Finds coordinates to keep a client on the screen.
+ @param self The client
+ @param x The x coord of the client, may be changed.
+ @param y The y coord of the client, may be changed.
+ @param w The width of the client.
+ @param w The height of the client.
+ @param rude Be rude about it. If false, it is only moved if it is entirely
+ not visible. If true, then make sure the window is inside the
+ struts if possible.
+ @return true if the client was moved to be on-screen; false if not.
+*/
+gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
+ gboolean rude);
+
/*! Moves a client so that it is on screen if it is entirely out of the
viewable screen.
+ @param self The client to move
+ @param rude Be rude about it. If false, it is only moved if it is entirely
+ not visible. If true, then make sure the window is inside the
+ struts if possible.
*/
-void client_move_onscreen(ObClient *self);
+void client_move_onscreen(ObClient *self, gboolean rude);
/*! Fullscreen's or unfullscreen's the client window
@param fs true if the window should be made fullscreen; false if it should
be returned to normal state.
- @param savearea true to have the client's current size and position saved;
- otherwise, they are not. You should not save when mapping a
- new window that is set to fullscreen. This has no effect
- when restoring a window from fullscreen.
*/
-void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
+void client_fullscreen(ObClient *self, gboolean fs);
/*! Iconifies or uniconifies the client window
@param iconic true if the window should be iconified; false if it should be
restored.
@param curdesk If iconic is FALSE, then this determines if the window will
be uniconified to the current viewable desktop (true) or to
- its previous desktop (false)
+ its previous desktop (false)
*/
void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
@param max true if the window should be maximized; false if it should be
returned to normal size.
@param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
- @param savearea true to have the client's current size and position saved;
- otherwise, they are not. You should not save when mapping a
- new window that is set to fullscreen. This has no effect
- when unmaximizing a window.
*/
-void client_maximize(ObClient *self, gboolean max, int dir,
- gboolean savearea);
+void client_maximize(ObClient *self, gboolean max, gint dir);
/*! Shades or unshades the client window
@param shade true if the window should be shaded; false if it should be
*/
void client_shade(ObClient *self, gboolean shade);
+/*! Hilite the window to make the user notice it */
+void client_hilite(ObClient *self, gboolean hilite);
+
/*! Request the client to close its window */
void client_close(ObClient *self);
desktop has been changed. Generally this should be FALSE. */
void client_set_desktop(ObClient *self, guint target, gboolean donthide);
+/*! Show the client if it should be shown. */
+void client_show(ObClient *self);
+
+/*! Show the client if it should be shown. */
+void client_hide(ObClient *self);
+
+/*! Show the client if it should be shown, and hide it if it should be
+ hidden. This is for example, when switching desktops.
+*/
+void client_showhide(ObClient *self);
+
/*! Validate client, by making sure no Destroy or Unmap events exist in
the event queue for the window.
@return true if the client is valid; false if the client has already
gboolean client_validate(ObClient *self);
/*! Sets the wm_state to the specified value */
-void client_set_wm_state(ObClient *self, long state);
+void client_set_wm_state(ObClient *self, glong state);
/*! Adjusts the window's net_state
This should not be called as part of the window mapping process! It is for
client_apply_startup_state is used to do the same things during the mapping
process.
*/
-void client_set_state(ObClient *self, Atom action, long data1, long data2);
+void client_set_state(ObClient *self, Atom action, glong data1, glong data2);
/* Given a ObClient, find the client that focus would actually be sent to if
you wanted to give focus to the specified ObClient. Will return the same
without focusing it or modifying the focus order lists. */
gboolean client_can_focus(ObClient *self);
-/*! Attempt to focus the client window */
+/*! Attempt to focus the client window
+ NOTE: You should validate the client before calling this !! (client_validate)
+*/
gboolean client_focus(ObClient *self);
-/*! Remove focus from the client window */
-void client_unfocus(ObClient *self);
-
/*! Activates the client for use, focusing, uniconifying it, etc. To be used
- when the user deliberately selects a window for use. */
-void client_activate(ObClient *self);
+ when the user deliberately selects a window for use.
+ @param here If true, then the client is brought to the current desktop;
+ otherwise, the desktop is changed to where the client lives.
+ @param user If true, then a user action is what requested the activation;
+ otherwise, it means an application requested it on its own
+*/
+void client_activate(ObClient *self, gboolean here, gboolean user);
/*! Calculates the stacking layer for the client window */
void client_calc_layer(ObClient *self);
+/*! Raises the client to the top of its stacking layer
+ Normally actions call to the client_* functions to make stuff go, but this
+ one is an exception. It just fires off an action, which will be queued.
+ This is because stacking order rules can be changed by focus state, and so
+ any time focus changes you have to wait for it to complete before you can
+ properly restart windows. As such, this only queues an action for later
+ execution, once the focus change has gone through.
+*/
+void client_raise(ObClient *self);
+
+/*! Lowers the client to the bottom of its stacking layer
+ Normally actions call to the client_* functions to make stuff go, but this
+ one is an exception. It just fires off an action, which will be queued.
+ This is because stacking order rules can be changed by focus state, and so
+ any time focus changes you have to wait for it to complete before you can
+ properly restart windows. As such, this only queues an action for later
+ execution, once the focus change has gone through.
+*/
+void client_lower(ObClient *self);
+
/*! Updates the window's transient status, and any parents of it */
void client_update_transient_for(ObClient *self);
/*! Update the protocols that the window supports and adjusts things if they
change */
void client_update_protocols(ObClient *self);
+#ifdef SYNC
+/*! Updates the window's sync request counter for resizes */
+void client_update_sync_request_counter(ObClient *self);
+#endif
+/*! Updates the window's colormap */
+void client_update_colormap(ObClient *self, Colormap colormap);
/*! Updates the WMNormalHints and adjusts things if they change */
void client_update_normal_hints(ObClient *self);
/*! Updates the WMHints and adjusts things if they change
@param initstate Whether to read the initial_state property from the
WMHints. This should only be used during the mapping
- process.
+ process.
*/
void client_update_wmhints(ObClient *self);
/*! Updates the window's title and icon title */
void client_update_title(ObClient *self);
+/*! Updates the command used to run the program */
+void client_update_command(ObClient *self);
/*! Updates the window's application name and class */
void client_update_class(ObClient *self);
/*! Updates the strut for the client */
void client_update_strut(ObClient *self);
/*! Updates the window's icons */
void client_update_icons(ObClient *self);
+/*! Updates the window's user time */
+void client_update_user_time(ObClient *self);
+/*! Updates the window's icon geometry (where to iconify to/from) */
+void client_update_icon_geometry(ObClient *self);
/*! Set up what decor should be shown on the window and what functions should
be allowed (ObClient::decorations and ObClient::functions).
/*! Retrieves the window's type and sets ObClient->type */
void client_get_type(ObClient *self);
-ObClientIcon *client_icon(ObClient *self, int w, int h);
+const ObClientIcon *client_icon(ObClient *self, gint w, gint h);
+
+/*! Searches a client's direct parents for a focused window. The function does
+ not check for the passed client, only for *ONE LEVEL* of its parents.
+ If no focused parentt is found, NULL is returned.
+*/
+ObClient *client_search_focus_parent(ObClient *self);
/*! Searches a client's transients for a focused window. The function does not
check for the passed client, only for its transients.
*/
ObClient *client_search_modal_child(ObClient *self);
-ObClient *client_search_top_transient(ObClient *self);
+/*! Returns a list of top-level windows which this is a transient for.
+ It will only contain more than 1 element if the client is transient for its
+ group.
+*/
+GSList *client_search_all_top_parents(ObClient *self);
+
+/*! Returns a list of top-level windows which this is a transient for, and
+ which are in the same layer as this client.
+ It will only contain more than 1 element if the client is transient for its
+ group.
+*/
+GSList *client_search_all_top_parents_layer(ObClient *self);
+
+/*! Returns a window's top level parent. This only counts direct parents,
+ not groups if it is transient for its group.
+*/
+ObClient *client_search_top_normal_parent(ObClient *self);
+
+/*! Is one client a direct child of another (i.e. not through the group.) */
+gboolean client_is_direct_child(ObClient *parent, ObClient *child);
+
+/*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
+ returns the searched for parent if it is a parent, or NULL if not. */
+ObClient *client_search_parent(ObClient *self, ObClient *search);
-/*! Return the "closest" client in the given direction */
-ObClient *client_find_directional(ObClient *c, ObDirection dir);
+/*! Search for a transient of a client. The transient is returned if it is one,
+ NULL is returned if the given search is not a transient of the client. */
+ObClient *client_search_transient(ObClient *self, ObClient *search);
+
+/*! Return the closest edge in the given direction */
+gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
/*! Set a client window to be above/below other clients.
@layer < 0 indicates the client should be placed below other clients.<br>
= 0 indicates the client should be placed with other clients.<br>
> 0 indicates the client should be placed above other clients.
*/
-void client_set_layer(ObClient *self, int layer);
+void client_set_layer(ObClient *self, gint layer);
+
+/*! Set a client window to have decorations or not */
+void client_set_undecorated(ObClient *self, gboolean undecorated);
guint client_monitor(ObClient *self);
+void client_update_sm_client_id(ObClient *self);
+
+ObClient* client_under_pointer();
+
+gboolean client_has_group_siblings(ObClient *self);
+
+gboolean client_has_application_group_siblings(ObClient *self);
+
#endif
projects / chaz / openbox / blobdiff