updated doxygen docu, added FIXMEs, fixed headers to 80chars width.

[i3/i3] / include / client.h

diff --git a/include/client.h b/include/client.h
index 2547c52fb0817b185bc5453f38b696da6bd49f54..8fbd443472ecf962d9f5fae7b9a5c5d621ca4069 100644 (file)
--- a/include/client.h
+++ b/include/client.h
@@ -16,15 +16,17 @@
 #define _CLIENT_H
 
 /**
- * Removes the given client from the container, either because it will be inserted into another
- * one or because it was unmapped
+ * Removes the given client from the container, either because it will be
+ * inserted into another one or because it was unmapped
  *
  */
-void client_remove_from_container(xcb_connection_t *conn, Client *client, Container *container);
+void client_remove_from_container(xcb_connection_t *conn, Client *client,
+                                  Container *container,
+                                  bool remove_from_focusstack);
 
 /**
- * Warps the pointer into the given client (in the middle of it, to be specific), therefore
- * selecting it
+ * Warps the pointer into the given client (in the middle of it, to be
+ * specific), therefore selecting it
  *
  */
 void client_warp_pointer_into(xcb_connection_t *conn, Client *client);
@@ -36,8 +38,8 @@ void client_warp_pointer_into(xcb_connection_t *conn, Client *client);
 void client_kill(xcb_connection_t *conn, Client *window);
 
 /**
- * Checks if the given window class and title match the given client
- * Window title is passed as "normal" string and as UCS-2 converted string for
+ * Checks if the given window class and title match the given client Window
+ * title is passed as "normal" string and as UCS-2 converted string for
  * matching _NET_WM_NAME capable clients as well as those using legacy hints.
  *
  */
@@ -45,11 +47,35 @@ bool client_matches_class_name(Client *client, char *to_class, char *to_title,
                                char *to_title_ucs, int to_title_ucs_len);
 
 /**
- * Toggles fullscreen mode for the given client. It updates the data structures and
- * reconfigures (= resizes/moves) the client and its frame to the full size of the
- * screen. When leaving fullscreen, re-rendering the layout is forced.
+ * Enters fullscreen mode for the given client. This is called by toggle_fullscreen
+ * and when moving a fullscreen client to another screen.
+ *
+ */
+void client_enter_fullscreen(xcb_connection_t *conn, Client *client);
+
+/**
+ * Toggles fullscreen mode for the given client. It updates the data
+ * structures and reconfigures (= resizes/moves) the client and its frame to
+ * the full size of the screen. When leaving fullscreen, re-rendering the
+ * layout is forced.
  *
  */
 void client_toggle_fullscreen(xcb_connection_t *conn, Client *client);
 
+/**
+ * Sets the position of the given client in the X stack to the highest (tiling
+ * layer is always on the same position, so this doesn’t matter) below the
+ * first floating client, so that floating windows are always on top.
+ *
+ */
+void client_set_below_floating(xcb_connection_t *conn, Client *client);
+
+/**
+ * Returns true if the client is floating. Makes the code more beatiful, as
+ * floating is not simply a boolean, but also saves whether the user selected
+ * the current state or whether it was automatically set.
+ *
+ */
+bool client_is_floating(Client *client);
+
 #endif