X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;ds=inline;f=openbox%2Fclient.h;h=5942eb14db0d80fc1177d6895029e4c2646620da;hb=e3786e64fb0786632b89ff086b818c0a3b0522b7;hp=4421f8fe3e4f4af048076b0699432ddb70f9dbb8;hpb=950516124f49000bd8df0481df0c54a14a05b7f9;p=chaz%2Fopenbox
diff --git a/openbox/client.h b/openbox/client.h
index 4421f8fe..5942eb14 100644
--- a/openbox/client.h
+++ b/openbox/client.h
@@ -1,3 +1,21 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+ client.h for the Openbox window manager
+ Copyright (c) 2003 Ben 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
@@ -12,6 +30,7 @@
struct _ObFrame;
struct _ObGroup;
+struct _ObSessionState;
typedef struct _ObClient ObClient;
typedef struct _ObClientIcon ObClientIcon;
@@ -63,10 +82,14 @@ struct _ObClient
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 _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. */
@@ -83,6 +106,10 @@ struct _ObClient
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
@@ -97,6 +124,8 @@ struct _ObClient
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) */
ObClientType type;
@@ -106,13 +135,18 @@ struct _ObClient
is, rather, the position requested by the client, to which the window's
gravity is applied.
*/
- Rect area;
+ Rect area;
+
+ /*! 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
@@ -120,7 +154,7 @@ struct _ObClient
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,
@@ -131,11 +165,11 @@ struct _ObClient
/*! 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
@@ -158,11 +192,11 @@ struct _ObClient
/*! 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;
@@ -216,10 +250,10 @@ struct _ObClient
*/
guint decorations;
- /*! A user option. When this is set to FALSE the client will not ever
+ /*! A user option. When this is set to TRUE the client will not ever
be decorated.
*/
- gboolean decorate;
+ gboolean undecorated;
/*! A bitmask of values in the ObFunctions enum
The values in the variable specify the ways in which the user is allowed
@@ -235,8 +269,13 @@ struct _ObClient
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();
@@ -263,6 +302,19 @@ gboolean client_normal(ObClient *self);
/* Returns if the window is focused */
gboolean client_focused(ObClient *self);
+#define client_move(self, x, y) \
+ client_configure(self, OB_CORNER_TOPLEFT, x, y, \
+ self->area.width, self->area.height, \
+ TRUE, TRUE)
+#define client_resize(self, w, h) \
+ client_configure(self, OB_CORNER_TOPLEFT, self->area.x, self->area.y, \
+ w, h, TRUE, TRUE)
+#define client_move_resize(self, x, y, w, h) \
+ client_configure(self, OB_CORNER_TOPLEFT, x, y, w, h, TRUE, TRUE)
+
+#define client_configure(self, anchor, x, y, w, h, user, final) \
+ client_configure_full(self, anchor, x, y, w, h, user, final, FALSE)
+
/*! 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.
@@ -277,10 +329,13 @@ gboolean client_focused(ObClient *self);
configuration. e.g. Final should be FALSE if doing an
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, ObCorner anchor,
+ gint x, gint y, gint w, gint h,
+ gboolean user, gboolean final,
+ gboolean force_reply);
void client_reconfigure(ObClient *self);
@@ -295,7 +350,7 @@ void client_reconfigure(ObClient *self);
struts if possible.
@return true if the client was moved to be on-screen; false if not.
*/
-gboolean client_find_onscreen(ObClient *self, int *x, int *y, int w, int h,
+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
@@ -312,8 +367,8 @@ void client_move_onscreen(ObClient *self, gboolean rude);
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.
+ 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);
@@ -322,7 +377,7 @@ void client_fullscreen(ObClient *self, gboolean fs, gboolean savearea);
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);
@@ -332,11 +387,11 @@ void client_iconify(ObClient *self, gboolean iconic, gboolean curdesk);
@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.
+ 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,
+ gboolean savearea);
/*! Shades or unshades the client window
@param shade true if the window should be shaded; false if it should be
@@ -363,7 +418,7 @@ void client_set_desktop(ObClient *self, guint target, gboolean donthide);
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
@@ -371,7 +426,7 @@ void client_set_wm_state(ObClient *self, long state);
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
@@ -389,12 +444,35 @@ gboolean client_focus(ObClient *self);
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.
+*/
+void client_activate(ObClient *self, gboolean here);
/*! 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
@@ -427,7 +505,13 @@ void client_setup_decor_and_functions(ObClient *self);
/*! 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.
@@ -449,18 +533,36 @@ ObClient *client_search_modal_child(ObClient *self);
ObClient *client_search_top_transient(ObClient *self);
+/*! 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);
+
+/*! 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" client in the given direction */
ObClient *client_find_directional(ObClient *c, ObDirection dir);
+/*! Return the closest edge in the given direction */
+gint client_directional_edge_search(ObClient *c, ObDirection dir);
+
/*! Set a client window to be above/below other clients.
@layer < 0 indicates the client should be placed below other clients.
= 0 indicates the client should be placed with other clients.
> 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);
+
#endif