git.sur5r.net Git - i3/i3/blob - include/workspace.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * workspace.c: Modifying workspaces, accessing them, moving containers to
   8  *              workspaces.
   9  *
  10  */
  11 #ifndef _WORKSPACE_H
  12 #define _WORKSPACE_H
  13
  14 #include "data.h"
  15 #include "tree.h"
  16 #include "randr.h"
  17
  18 /**
  19  * Returns a pointer to the workspace with the given number (starting at 0),
  20  * creating the workspace if necessary (by allocating the necessary amount of
  21  * memory and initializing the data structures correctly).
  22  *
  23  * If created is not NULL, *created will be set to whether or not the
  24  * workspace has just been created.
  25  *
  26  */
  27 Con *workspace_get(const char *num, bool *created);
  28
  29 #if 0
  30 /**
  31  * Sets the name (or just its number) for the given workspace. This has to
  32  * be called for every workspace as the rendering function
  33  * (render_internal_bar) relies on workspace->name and workspace->name_len
  34  * being ready-to-use.
  35  *
  36  */
  37 void workspace_set_name(Workspace *ws, const char *name);
  38 #endif
  39
  40 /**
  41  * Returns true if the workspace is currently visible. Especially important for
  42  * multi-monitor environments, as they can have multiple currenlty active
  43  * workspaces.
  44  *
  45  */
  46 bool workspace_is_visible(Con *ws);
  47
  48 /**
  49  * Switches to the given workspace
  50  *
  51  */
  52 void workspace_show(Con *ws);
  53
  54 /**
  55  * Looks up the workspace by name and switches to it.
  56  *
  57  */
  58 void workspace_show_by_name(const char *num);
  59
  60 /**
  61  * Returns the next workspace.
  62  *
  63  */
  64 Con* workspace_next();
  65
  66 /**
  67  * Returns the previous workspace.
  68  *
  69  */
  70 Con* workspace_prev();
  71
  72 /**
  73  * Focuses the previously focused workspace.
  74  *
  75  */
  76 void workspace_back_and_forth();
  77
  78
  79 #if 0
  80 /**
  81  * Assigns the given workspace to the given screen by correctly updating its
  82  * state and reconfiguring all the clients on this workspace.
  83  *
  84  * This is called when initializing a screen and when re-assigning it to a
  85  * different screen which just got available (if you configured it to be on
  86  * screen 1 and you just plugged in screen 1).
  87  *
  88  */
  89 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
  90
  91 /**
  92  * Initializes the given workspace if it is not already initialized. The given
  93  * screen is to be understood as a fallback, if the workspace itself either
  94  * was not assigned to a particular screen or cannot be placed there because
  95  * the screen is not attached at the moment.
  96  *
  97  */
  98 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
  99
 100 /**
 101  * Gets the first unused workspace for the given screen, taking into account
 102  * the preferred_screen setting of every workspace (workspace assignments).
 103  *
 104  */
 105 Workspace *get_first_workspace_for_output(Output *screen);
 106
 107 /**
 108  * Unmaps all clients (and stack windows) of the given workspace.
 109  *
 110  * This needs to be called separately when temporarily rendering a workspace
 111  * which is not the active workspace to force reconfiguration of all clients,
 112  * like in src/xinerama.c when re-assigning a workspace to another screen.
 113  *
 114  */
 115 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
 116
 117 /**
 118  * Maps all clients (and stack windows) of the given workspace.
 119  *
 120  */
 121 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
 122 #endif
 123
 124 /**
 125  * Goes through all clients on the given workspace and updates the workspace’s
 126  * urgent flag accordingly.
 127  *
 128  */
 129 void workspace_update_urgent_flag(Con *ws);
 130
 131 /**
 132  * 'Forces' workspace orientation by moving all cons into a new split-con with
 133  * the same orientation as the workspace and then changing the workspace
 134  * orientation.
 135  *
 136  */
 137 void ws_force_orientation(Con *ws, orientation_t orientation);
 138
 139 /**
 140  * Called when a new con (with a window, not an empty or split con) should be
 141  * attached to the workspace (for example when managing a new window or when
 142  * moving an existing window to the workspace level).
 143  *
 144  * Depending on the workspace_layout setting, this function either returns the
 145  * workspace itself (default layout) or creates a new stacked/tabbed con and
 146  * returns that.
 147  *
 148  */
 149 Con *workspace_attach_to(Con *ws);
 150
 151 #endif