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