X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fclient.h;h=65376719820eb3bbb3865114842c343df8756087;hb=b42ef7362ccd35aeebf7863528556a7cc444a176;hp=0f9eaa4b2c4df9da37855d41b989e01baf6ab68a;hpb=f8a47de5ec444c452093371e3db16857eb39a490;p=chaz%2Fopenbox diff --git a/openbox/client.h b/openbox/client.h index 0f9eaa4b..65376719 100644 --- a/openbox/client.h +++ b/openbox/client.h @@ -1,72 +1,28 @@ #ifndef __client_h #define __client_h +#include "misc.h" +#include "mwm.h" #include "geom.h" #include "stacking.h" +#include "render/color.h" + #include #include -struct ClientWrap; struct Frame; +struct Group; +/* 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) /*! Holds an icon in ARGB format */ typedef struct Icon { - unsigned long w, h; - unsigned long *data; + int width, height; + RrPixel32 *data; } Icon; -/*! The MWM Hints as retrieved from the window property - This structure only contains 3 elements, even though the Motif 2.0 - structure contains 5. We only use the first 3, so that is all gets - defined. -*/ -typedef struct MwmHints { - /*! A bitmask of Client::MwmFlags values */ - unsigned long flags; - /*! A bitmask of Client::MwmFunctions values */ - unsigned long functions; - /*! A bitmask of Client::MwmDecorations values */ - unsigned long decorations; -} MwmHints; -/*! The number of elements in the Client::MwmHints struct */ -#define MWM_ELEMENTS 3 - -/*! Possible flags for MWM Hints (defined by Motif 2.0) */ -typedef enum { - MwmFlag_Functions = 1 << 0, /*!< The MMW Hints define funcs */ - MwmFlag_Decorations = 1 << 1 /*!< The MWM Hints define decor */ -} MwmFlags; - -/*! Possible functions for MWM Hints (defined by Motif 2.0) */ -typedef enum { - MwmFunc_All = 1 << 0, /*!< All functions */ - MwmFunc_Resize = 1 << 1, /*!< Allow resizing */ - MwmFunc_Move = 1 << 2, /*!< Allow moving */ - MwmFunc_Iconify = 1 << 3, /*!< Allow to be iconfied */ - MwmFunc_Maximize = 1 << 4 /*!< Allow to be maximized */ - /*MwmFunc_Close = 1 << 5 /!< Allow to be closed */ -} MwmFunctions; - -/*! Possible decorations for MWM Hints (defined by Motif 2.0) */ -typedef enum { - MwmDecor_All = 1 << 0, /*!< All decorations */ - MwmDecor_Border = 1 << 1, /*!< Show a border */ - MwmDecor_Handle = 1 << 2, /*!< Show a handle (bottom) */ - MwmDecor_Title = 1 << 3, /*!< Show a titlebar */ - /*MwmDecor_Menu = 1 << 4, /!< Show a menu */ - MwmDecor_Iconify = 1 << 5, /*!< Show an iconify button */ - MwmDecor_Maximize = 1 << 6 /*!< Show a maximize button */ -} MemDecorations; - -/*! Corners of the client window, used for anchor positions */ -typedef enum { - Corner_TopLeft, - Corner_TopRight, - Corner_BottomLeft, - Corner_BottomRight -} Corner; - /*! Possible window types */ typedef enum { Type_Desktop, /*!< A desktop (bottom-most window) */ @@ -101,41 +57,51 @@ typedef enum { /*! Display a button to toggle the window's placement on all desktops */ Decor_AllDesktops = 1 << 6, - Decor_Close = 1 << 7 /*!< Display a close button */ + Decor_Shade = 1 << 7, /*!< Displays a shade button */ + Decor_Close = 1 << 8 /*!< Display a close button */ } Decoration; - typedef struct Client { + ObWindow obwin; + Window window; + /*! The window's decorations. NULL while the window is being managed! */ struct Frame *frame; /*! The number of unmap events to ignore on the window */ int ignore_unmaps; /*! The id of the group the window belongs to */ - Window group; + struct Group *group; /*! 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 */ + /*! 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 + case. + */ struct Client *transient_for; /*! The clients which are transients (children) of this client */ GSList *transients; /*! The desktop on which the window resides (0xffffffff for all desktops) */ - unsigned int desktop; + guint desktop; /*! 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; /*! The application that created the window */ - gchar *res_name; + gchar *name; /*! The class of the window, can used for grouping */ - gchar *res_class; + gchar *class; /*! The specified role of the window, used for identification */ gchar *role; @@ -195,7 +161,7 @@ typedef struct Client { Size base_size; /*! Window decoration and functionality hints */ - MwmHints mwmhints; + ObMwmHints mwmhints; /*! Where to place the decorated window in relation to the undecorated window */ @@ -218,8 +184,6 @@ typedef struct Client { gboolean urgent; /*! Notify the window when it receives focus? */ gboolean focus_notify; - /*! Does the client window have the input focus? */ - gboolean focused; /*! The window uses shape extension to be non-rectangular? */ gboolean shaped; @@ -274,18 +238,9 @@ typedef struct Client { Icon *icons; /*! The number of icons in icons */ int nicons; - - /*! The icon for the client specified in the WMHints or the KWM hints */ - Pixmap pixmap_icon; - /*! The mask for the pixmap_icon, or None if its not masked */ - Pixmap pixmap_icon_mask; - - /* The instance of the wrapper class if one exists */ - struct ClientWrap *wrap; } Client; -extern GSList *client_list; -extern GHashTable *client_map; +extern GList *client_list; void client_startup(); void client_shutdown(); @@ -302,20 +257,19 @@ void client_unmanage(Client *client); /*! Sets the client list on the root window from the client_list */ void client_set_list(); -/*! Reapplies the maximized state to the window - Use this to make the window readjust its maximized size to new - surroundings (struts, etc). */ -void client_remaximize(Client *self); - -/*! Shows the window if it should be shown, or hides it - Used when changing desktops, the window's state, etc. */ -void client_showhide(Client *self, gboolean firehook); +/*! Determines if the client should be shown or hidden currently. + @return TRUE if it should be visible; otherwise, FALSE. +*/ +gboolean client_should_show(Client *self); /*! Returns if the window should be treated as a normal window. Some windows (desktops, docks, splash screens) have special rules applied to them in a number of places regarding focus or user interaction. */ gboolean client_normal(Client *self); +/* Returns if the window is focused */ +gboolean client_focused(Client *self); + /*! 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. @@ -331,9 +285,17 @@ gboolean client_normal(Client *self); interactive move/resize, and then be TRUE for the last call only. */ -void client_configure(Client *self, Corner anchor, int x, int y, int w, int h, +void client_configure(Client *self, ObCorner anchor, + int x, int y, int w, int h, gboolean user, gboolean final); +void client_reconfigure(Client *self); + +/*! Moves a client so that it is on screen if it is entirely out of the + viewable screen. +*/ +void client_move_onscreen(Client *self); + /*! 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. @@ -371,16 +333,16 @@ void client_maximize(Client *self, gboolean max, int dir, */ void client_shade(Client *self, gboolean shade); -/*! Request the client to close its window. */ +/*! Request the client to close its window */ void client_close(Client *self); -/*! Sends the window to the specified desktop */ -void client_set_desktop(Client *self, unsigned int target); +/*! Kill the client off violently */ +void client_kill(Client *self); -/*! Return a modal child of the client window - @return A modal child of the client window, or 0 if none was found. -*/ -Client *client_find_modal_child(Client *self); +/*! Sends the window to the specified desktop + @param donthide If TRUE, the window will not be shown/hidden after its + desktop has been changed. Generally this should be FALSE. */ +void client_set_desktop(Client *self, guint target, gboolean donthide); /*! Validate client, by making sure no Destroy or Unmap events exist in the event queue for the window. @@ -400,12 +362,25 @@ void client_set_wm_state(Client *self, long state); */ void client_set_state(Client *self, Atom action, long data1, long data2); +/* Given a Client, find the client that focus would actually be sent to if + you wanted to give focus to the specified Client. Will return the same + Client passed to it or another Client if appropriate. */ +Client *client_focus_target(Client *self); + +/*! Returns what client_focus would return if passed the same client, but + without focusing it or modifying the focus order lists. */ +gboolean client_can_focus(Client *self); + /*! Attempt to focus the client window */ gboolean client_focus(Client *self); /*! Remove focus from the client window */ void client_unfocus(Client *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(Client *self); + /*! Calculates the stacking layer for the client window */ void client_calc_layer(Client *self); @@ -423,18 +398,14 @@ void client_update_normal_hints(Client *self); process. */ void client_update_wmhints(Client *self); -/*! Updates the window's title */ +/*! Updates the window's title and icon title */ void client_update_title(Client *self); -/*! Updates the window's icon title */ -void client_update_icon_title(Client *self); /*! Updates the window's application name and class */ void client_update_class(Client *self); /*! Updates the strut for the client */ void client_update_strut(Client *self); /*! Updates the window's icons */ void client_update_icons(Client *self); -/*! Updates the window's kwm icon */ -void client_update_kwm_icon(Client *self); /*! Set up what decor should be shown on the window and what functions should be allowed (Client::decorations and Client::functions). @@ -445,4 +416,38 @@ void client_setup_decor_and_functions(Client *self); /*! Retrieves the window's type and sets Client->type */ void client_get_type(Client *self); +Icon *client_icon(Client *self, int w, int h); + +/*! Searches a client's transients for a focused window. The function does not + check for the passed client, only for its transients. + If no focused transient is found, NULL is returned. +*/ +Client *client_search_focus_tree(Client *self); + +/*! Searches a client's transient tree for a focused window. The function + searches up the tree and down other branches as well as the passed client's. + If no focused client is found, NULL is returned. +*/ +Client *client_search_focus_tree_full(Client *self); + +/*! Return a modal child of the client window that can be focused. + @return A modal child of the client window that can be focused, or 0 if + none was found. +*/ +Client *client_search_modal_child(Client *self); + +Client *client_search_top_transient(Client *self); + +/*! Return the "closest" client in the given direction */ +Client *client_find_directional(Client *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(Client *self, int layer); + +guint client_monitor(Client *self); + #endif