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  * Initializes the given workspace if it is not already initialized. The given
  49  * screen is to be understood as a fallback, if the workspace itself either
  50  * was not assigned to a particular screen or cannot be placed there because
  51  * the screen is not attached at the moment.
  52  *
  53  */
  54 void workspace_initialize(Workspace *ws, i3Screen *screen);
  55
  56 /**
  57  * Gets the first unused workspace for the given screen, taking into account
  58  * the preferred_screen setting of every workspace (workspace assignments).
  59  *
  60  */
  61 Workspace *get_first_workspace_for_screen(struct screens_head *slist, i3Screen *screen);
  62
  63 /**
  64  * Unmaps all clients (and stack windows) of the given workspace.
  65  *
  66  * This needs to be called separately when temporarily rendering a workspace
  67  * which is not the active workspace to force reconfiguration of all clients,
  68  * like in src/xinerama.c when re-assigning a workspace to another screen.
  69  *
  70  */
  71 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
  72
  73 /**
  74  * Maps all clients (and stack windows) of the given workspace.
  75  *
  76  */
  77 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
  78
  79 /**
  80  * Goes through all clients on the given workspace and updates the workspace’s
  81  * urgent flag accordingly.
  82  *
  83  */
  84 void workspace_update_urgent_flag(Workspace *ws);
  85
  86 #endif