Merge branch 'master' into next

[i3/i3] / include / workspace.h

diff --git a/include/workspace.h b/include/workspace.h
index 2b41a5276fc169534b50a2916f30e16509937f13..aebf13656d866e8b15e3de5a03678f3bb9f3baed 100644 (file)
--- a/include/workspace.h
+++ b/include/workspace.h
@@ -3,18 +3,31 @@
  *
  * i3 - an improved dynamic tiling window manager
  *
- * © 2009 Michael Stapelberg and contributors
+ * © 2009-2010 Michael Stapelberg and contributors
  *
  * See file LICENSE for license information.
  *
  */
-#include <xcb/xcb.h>
 
 #include "data.h"
+#include "tree.h"
+#include "randr.h"
 
 #ifndef _WORKSPACE_H
 #define _WORKSPACE_H
 
+/**
+ * Returns a pointer to the workspace with the given number (starting at 0),
+ * creating the workspace if necessary (by allocating the necessary amount of
+ * memory and initializing the data structures correctly).
+ *
+ * If created is not NULL, *created will be set to whether or not the
+ * workspace has just been created.
+ *
+ */
+Con *workspace_get(const char *num, bool *created);
+
+#if 0
 /**
  * Sets the name (or just its number) for the given workspace. This has to
  * be called for every workspace as the rendering function
@@ -23,5 +36,101 @@
  *
  */
 void workspace_set_name(Workspace *ws, const char *name);
+#endif
+
+/**
+ * Returns true if the workspace is currently visible. Especially important for
+ * multi-monitor environments, as they can have multiple currenlty active
+ * workspaces.
+ *
+ */
+bool workspace_is_visible(Con *ws);
+
+/** Switches to the given workspace */
+void workspace_show(const char *num);
+
+/**
+ * Focuses the next workspace.
+ *
+ */
+void workspace_next();
+
+/**
+ * Focuses the previous workspace.
+ *
+ */
+void workspace_prev();
+
+#if 0
+/**
+ * Assigns the given workspace to the given screen by correctly updating its
+ * state and reconfiguring all the clients on this workspace.
+ *
+ * This is called when initializing a screen and when re-assigning it to a
+ * different screen which just got available (if you configured it to be on
+ * screen 1 and you just plugged in screen 1).
+ *
+ */
+void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
+
+/**
+ * Initializes the given workspace if it is not already initialized. The given
+ * screen is to be understood as a fallback, if the workspace itself either
+ * was not assigned to a particular screen or cannot be placed there because
+ * the screen is not attached at the moment.
+ *
+ */
+void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
+
+/**
+ * Gets the first unused workspace for the given screen, taking into account
+ * the preferred_screen setting of every workspace (workspace assignments).
+ *
+ */
+Workspace *get_first_workspace_for_output(Output *screen);
+
+/**
+ * Unmaps all clients (and stack windows) of the given workspace.
+ *
+ * This needs to be called separately when temporarily rendering a workspace
+ * which is not the active workspace to force reconfiguration of all clients,
+ * like in src/xinerama.c when re-assigning a workspace to another screen.
+ *
+ */
+void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
+
+/**
+ * Maps all clients (and stack windows) of the given workspace.
+ *
+ */
+void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
+#endif
+
+/**
+ * Goes through all clients on the given workspace and updates the workspace’s
+ * urgent flag accordingly.
+ *
+ */
+void workspace_update_urgent_flag(Con *ws);
+
+/**
+ * 'Forces' workspace orientation by moving all cons into a new split-con with
+ * the same orientation as the workspace and then changing the workspace
+ * orientation.
+ *
+ */
+void ws_force_orientation(Con *ws, orientation_t orientation);
+
+/**
+ * Called when a new con (with a window, not an empty or split con) should be
+ * attached to the workspace (for example when managing a new window or when
+ * moving an existing window to the workspace level).
+ *
+ * Depending on the workspace_layout setting, this function either returns the
+ * workspace itself (default layout) or creates a new stacked/tabbed con and
+ * returns that.
+ *
+ */
+Con *workspace_attach_to(Con *ws);
 
 #endif