X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fclient.h;h=08a3a887361d4fe6bbb4201b395acd7a86acdbc8;hb=7a166a383805f7693e0800f3bf693e3736463a0d;hp=e575a35aa016ef72fd3619146206058336648ba9;hpb=bfea000a7407e51b5659590415e410a47f6f046b;p=chaz%2Fopenbox diff --git a/openbox/client.h b/openbox/client.h index e575a35a..08a3a887 100644 --- a/openbox/client.h +++ b/openbox/client.h @@ -7,11 +7,15 @@ #include 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 width, height; unsigned long *data; } Icon; @@ -100,41 +104,52 @@ 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; @@ -217,8 +232,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; @@ -280,8 +293,7 @@ typedef struct Client { Pixmap pixmap_icon_mask; } Client; -extern GSList *client_list; -extern GHashTable *client_map; +extern GList *client_list; void client_startup(); void client_shutdown(); @@ -313,6 +325,9 @@ gboolean client_should_show(Client *self); 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,6 +346,11 @@ gboolean client_normal(Client *self); void client_configure(Client *self, Corner anchor, int x, int y, int w, int h, gboolean user, gboolean final); +/*! 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. @@ -368,16 +388,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, guint 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. @@ -397,12 +417,21 @@ 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); + /*! 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); @@ -420,10 +449,8 @@ 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 */ @@ -442,4 +469,23 @@ 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 + @return A modal child of the client window, or 0 if none was found. +*/ +Client *client_search_modal_child(Client *self); + #endif