]> Dogcows Code - chaz/openbox/blobdiff - openbox/client.h
consistant glib type usage
[chaz/openbox] / openbox / client.h
index 12674b819749a204f897891ca711bbc4a955372d..5942eb14db0d80fc1177d6895029e4c2646620da 100644 (file)
@@ -82,7 +82,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;
@@ -165,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
@@ -192,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;
@@ -272,8 +272,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();
@@ -331,7 +333,7 @@ gboolean client_focused(ObClient *self);
                      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);
 
@@ -348,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
@@ -365,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);
 
@@ -375,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);
 
@@ -385,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
@@ -416,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
@@ -424,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
@@ -451,6 +453,26 @@ 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
@@ -483,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.
@@ -505,20 +533,26 @@ 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 */
-int client_directional_edge_search(ObClient *c, ObDirection dir);
+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.<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);
@@ -529,4 +563,6 @@ void client_update_sm_client_id(ObClient *self);
 
 ObClient* client_under_pointer();
 
+gboolean client_has_group_siblings(ObClient *self);
+
 #endif
This page took 0.031159 seconds and 4 git commands to generate.