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

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