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 Workspace *workspace_get(int number);
  21
  22 /**
  23  * Sets the name (or just its number) for the given workspace. This has to
  24  * be called for every workspace as the rendering function
  25  * (render_internal_bar) relies on workspace->name and workspace->name_len
  26  * being ready-to-use.
  27  *
  28  */
  29 void workspace_set_name(Workspace *ws, const char *name);
  30
  31 /**
  32  * Returns true if the workspace is currently visible. Especially important for
  33  * multi-monitor environments, as they can have multiple currenlty active
  34  * workspaces.
  35  *
  36  */
  37 bool workspace_is_visible(Workspace *ws);
  38
  39 /** Switches to the given workspace */
  40 void workspace_show(xcb_connection_t *conn, int workspace);
  41
  42 /**
  43  * Initializes the given workspace if it is not already initialized. The given
  44  * screen is to be understood as a fallback, if the workspace itself either
  45  * was not assigned to a particular screen or cannot be placed there because
  46  * the screen is not attached at the moment.
  47  *
  48  */
  49 void workspace_initialize(Workspace *ws, i3Screen *screen);
  50
  51 /**
  52  * Gets the first unused workspace for the given screen, taking into account
  53  * the preferred_screen setting of every workspace (workspace assignments).
  54  *
  55  */
  56 Workspace *get_first_workspace_for_screen(struct screens_head *slist, i3Screen *screen);
  57
  58 /**
  59  * Unmaps all clients (and stack windows) of the given workspace.
  60  *
  61  * This needs to be called separately when temporarily rendering a workspace
  62  * which is not the active workspace to force reconfiguration of all clients,
  63  * like in src/xinerama.c when re-assigning a workspace to another screen.
  64  *
  65  */
  66 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
  67
  68 /**
  69  * Maps all clients (and stack windows) of the given workspace.
  70  *
  71  */
  72 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
  73
  74 /**
  75  * Goes through all clients on the given workspace and updates the workspace’s
  76  * urgent flag accordingly.
  77  *
  78  */
  79 void workspace_update_urgent_flag(Workspace *ws);
  80
  81 #endif