git.sur5r.net Git - i3/i3/blob - include/scratchpad.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  * scratchpad.c: Scratchpad functions (TODO: more description)
   8  *
   9  */
  10 #ifndef _SCRATCHPAD_H
  11 #define _SCRATCHPAD_H
  12
  13 /**
  14  * Moves the specified window to the __i3_scratch workspace, making it floating
  15  * and setting the appropriate scratchpad_state.
  16  *
  17  * Gets called upon the command 'move scratchpad'.
  18  *
  19  */
  20 void scratchpad_move(Con *con);
  21
  22 /**
  23  * Either shows the top-most scratchpad window (con == NULL) or shows the
  24  * specified con (if it is scratchpad window).
  25  *
  26  * When called with con == NULL and the currently focused window is a
  27  * scratchpad window, this serves as a shortcut to hide it again (so the user
  28  * can press the same key to quickly look something up).
  29  *
  30  */
  31 void scratchpad_show(Con *con);
  32
  33 /**
  34  * When starting i3 initially (and after each change to the connected outputs),
  35  * this function fixes the resolution of the __i3 pseudo-output. When that
  36  * resolution is not set to a function which shares a common divisor with every
  37  * active output’s resolution, floating point calculation errors will lead to
  38  * the scratchpad window moving when shown repeatedly.
  39  *
  40  */
  41 void scratchpad_fix_resolution(void);
  42
  43 #endif