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 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  */
  11 #include <xcb/xcb.h>
  12
  13 #include "data.h"
  14 #include "xinerama.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  */
  25 Workspace *workspace_get(int number);
  26
  27 /**
  28  * Sets the name (or just its number) for the given workspace. This has to
  29  * be called for every workspace as the rendering function
  30  * (render_internal_bar) relies on workspace->name and workspace->name_len
  31  * being ready-to-use.
  32  *
  33  */
  34 void workspace_set_name(Workspace *ws, const char *name);
  35
  36 /**
  37  * Returns true if the workspace is currently visible. Especially important for
  38  * multi-monitor environments, as they can have multiple currenlty active
  39  * workspaces.
  40  *
  41  */
  42 bool workspace_is_visible(Workspace *ws);
  43
  44 /** Switches to the given workspace */
  45 void workspace_show(xcb_connection_t *conn, int workspace);
  46
  47 /**
  48  * Assigns the given workspace to the given screen by correctly updating its
  49  * state and reconfiguring all the clients on this workspace.
  50  *
  51  * This is called when initializing a screen and when re-assigning it to a
  52  * different screen which just got available (if you configured it to be on
  53  * screen 1 and you just plugged in screen 1).
  54  *
  55  */
  56 void workspace_assign_to(Workspace *ws, i3Screen *screen);
  57
  58 /**
  59  * Initializes the given workspace if it is not already initialized. The given
  60  * screen is to be understood as a fallback, if the workspace itself either
  61  * was not assigned to a particular screen or cannot be placed there because
  62  * the screen is not attached at the moment.
  63  *
  64  */
  65 void workspace_initialize(Workspace *ws, i3Screen *screen, bool recheck);
  66
  67 /**
  68  * Gets the first unused workspace for the given screen, taking into account
  69  * the preferred_screen setting of every workspace (workspace assignments).
  70  *
  71  */
  72 Workspace *get_first_workspace_for_screen(struct screens_head *slist, i3Screen *screen);
  73
  74 /**
  75  * Unmaps all clients (and stack windows) of the given workspace.
  76  *
  77  * This needs to be called separately when temporarily rendering a workspace
  78  * which is not the active workspace to force reconfiguration of all clients,
  79  * like in src/xinerama.c when re-assigning a workspace to another screen.
  80  *
  81  */
  82 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
  83
  84 /**
  85  * Maps all clients (and stack windows) of the given workspace.
  86  *
  87  */
  88 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
  89
  90 /**
  91  * Goes through all clients on the given workspace and updates the workspace’s
  92  * urgent flag accordingly.
  93  *
  94  */
  95 void workspace_update_urgent_flag(Workspace *ws);
  96
  97 /*
  98  * Returns the width of the workspace.
  99  *
 100  */
 101 int workspace_width(Workspace *ws);
 102
 103 /*
 104  * Returns the effective height of the workspace (without the internal bar and
 105  * without dock clients).
 106  *
 107  */
 108 int workspace_height(Workspace *ws);
 109
 110 #endif