X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;ds=inline;f=openbox%2Fclient.h;h=a01c2b0f6083aad80c84105a683f9e23f9cd47ff;hb=a9910e520b1e5a7020ca8df0f2a7d0d0d48e2857;hp=4d6ee56c6d9aef95e160aab234cd37bd85415b07;hpb=3e9d050ffe36fa08c1e3e6f610c4d6587d2fdadd;p=chaz%2Fopenbox
diff --git a/openbox/client.h b/openbox/client.h
index 4d6ee56c..a01c2b0f 100644
--- a/openbox/client.h
+++ b/openbox/client.h
@@ -1,3 +1,22 @@
+/* -*- 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 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
@@ -14,8 +33,9 @@ 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 */
@@ -64,7 +84,7 @@ 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;
@@ -119,6 +139,11 @@ struct _ObClient
*/
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.
@@ -142,11 +167,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
@@ -169,23 +194,23 @@ 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;
- /*! 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;
@@ -216,6 +241,8 @@ struct _ObClient
/*! 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 layer in which the window will be stacked, windows in lower layers
are always below windows in higher layers. */
@@ -227,10 +254,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
@@ -242,6 +269,34 @@ struct _ObClient
ObClientIcon *icons;
/*! The number of icons in icons */
guint nicons;
+
+ guint32 user_time;
+};
+
+struct _ObAppSettings
+{
+ gchar *class;
+ gchar *name;
+ gchar *role;
+
+ Point position;
+ gboolean center_x;
+ gboolean center_y;
+ gboolean pos_given;
+
+ guint desktop;
+ gint shade;
+ gint decor;
+ gint focus;
+ gint head;
+ gint iconic;
+ gint skip_pager;
+ gint skip_taskbar;
+ gint max_horz;
+ gint max_vert;
+ gint fullscreen;
+
+ gint layer;
};
extern GList *client_list;
@@ -249,8 +304,10 @@ extern GList *client_list;
void client_startup(gboolean reconfig);
void client_shutdown(gboolean reconfig);
-void client_add_destructor(GDestroyNotify func);
-void client_remove_destructor(GDestroyNotify func);
+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();
@@ -299,16 +356,16 @@ gboolean client_focused(ObClient *self);
@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_full(ObClient *self, ObCorner anchor,
- int x, int y, int w, int h,
+ gint x, gint y, gint w, gint h,
gboolean user, gboolean final,
gboolean force_reply);
@@ -325,7 +382,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
@@ -340,19 +397,15 @@ 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);
@@ -360,13 +413,8 @@ 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
@@ -374,6 +422,9 @@ void client_maximize(ObClient *self, gboolean max, int dir,
*/
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);
@@ -385,6 +436,11 @@ void client_kill(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, 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
@@ -393,7 +449,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
@@ -401,7 +457,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
@@ -412,7 +468,9 @@ ObClient *client_focus_target(ObClient *self);
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 */
@@ -422,12 +480,35 @@ void client_unfocus(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
+ @param timestamp The time at which the activate was requested.
*/
-void client_activate(ObClient *self, gboolean here);
+void client_activate(ObClient *self, gboolean here, gboolean user, Time time);
/*! 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
@@ -439,7 +520,7 @@ 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 */
@@ -450,6 +531,8 @@ void client_update_class(ObClient *self);
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, gboolean new_event);
/*! Set up what decor should be shown on the window and what functions should
be allowed (ObClient::decorations and ObClient::functions).
@@ -460,7 +543,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.
@@ -480,25 +569,50 @@ ObClient *client_search_focus_tree_full(ObClient *self);
*/
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 window's top level parent. This only counts direct parents,
+ not groups if it is transient for its group.
+*/
+ObClient *client_search_top_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);
+
+/*! 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 */
-int client_directional_edge_search(ObClient *c, ObDirection dir);
+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.
= 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