doc/commands/WindowShade.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3   "../docbook-xml/docbookx.dtd"
   4 [
   5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   6 %myents;
   7 ]>
   8
   9 <!-- $Id: WindowShade.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='WindowShade'>
  12 <title>WindowShade</title>
  13
  14 <cmdsynopsis>
  15         <command>WindowShade</command
  16         ><group choice='plain'
  17                 ><arg choice='opt'>bool</arg
  18                 ><arg choice='opt'
  19                         ><arg choice='opt'>ShadeAgain</arg
  20                         ><arg choice='plain'
  21                                 ><replaceable>direction</replaceable
  22                         ></arg
  23                 ></arg
  24         ></group>
  25 </cmdsynopsis>
  26
  27 <para>Toggles the window shade feature for titled windows.  Windows in
  28 the shaded state only display a title-bar.  If
  29 <emphasis remap='I'>bool</emphasis>
  30 is not given or "<fvwmopt cmd="WindowShade" opt="toggle"/>",
  31 the window shade state is toggled.  If
  32 <emphasis remap='I'>bool</emphasis>
  33 is "True", the window is forced to the shaded state.  If
  34 <emphasis remap='I'>bool</emphasis>
  35 is "False", then the window is forced to the non-shaded
  36 state.  To force shading in a certain direction, the
  37 <replaceable>direction</replaceable>
  38 argument can be used.  Any of the strings
  39 "<fvwmopt cmd="WindowShade" opt="North"/>",
  40 "<fvwmopt cmd="WindowShade" opt="South"/>",
  41 "<fvwmopt cmd="WindowShade" opt="West"/>",
  42 "<fvwmopt cmd="WindowShade" opt="East"/>",
  43 "<fvwmopt cmd="WindowShade" opt="NorthWest"/>",
  44 "<fvwmopt cmd="WindowShade" opt="NorthEast"/>",
  45 "<fvwmopt cmd="WindowShade" opt="SouthWest"/>",
  46 "<fvwmopt cmd="WindowShade" opt="SouthEast"/>" or
  47 "<fvwmopt cmd="WindowShade" opt="Last"/>"
  48 can be given. The direction can be abbreviated with
  49 the usual one or two letters "<fvwmopt cmd="WindowShade" opt="N"/>", "<fvwmopt cmd="WindowShade" opt="NW"/>", etc.  Using a direction on
  50 a window that was already shaded unshades the window.  To shade it
  51 in a different direction, use the
  52 <fvwmopt cmd="WindowShade" opt="ShadeAgain"/>
  53 option. The direction
  54 <emphasis remap='I'>Last</emphasis>
  55 shades the window in the direction it last was shaded. If the
  56 window has never been shaded before it is shaded as if no
  57 direction had been given. Windows without titles can be shaded too.
  58 Please refer also to the options
  59 <fvwmref cmd="Style" opt="WindowShadeSteps"/>,
  60 <fvwmref cmd="Style" opt="WindowShadeShrinks"/>,
  61 <fvwmref cmd="Style" opt="WindowShadeScrolls"/>,
  62 <fvwmref cmd="Style" opt="WindowShadeLazy"/>,
  63 <fvwmref cmd="Style" opt="WindowShadeAlwaysLazy"/> and
  64 <fvwmref cmd="Style" opt="WindowShadeBusy"/>
  65 options of the
  66 <fvwmref cmd="Style"/>
  67 command.  Examples:</para>
  68
  69 <programlisting>
  70 <fvwmref cmd="Style"/> * <fvwmref cmd="Style" opt="WindowShadeShrinks"/>, <fvwmref cmd="Style" opt="WindowShadeSteps"/> 20, \
  71         <fvwmref cmd="Style" opt="WindowShadeLazy"/>
  72 <fvwmref cmd="Mouse"/> 1 - S WindowShade North
  73 <fvwmref cmd="Mouse"/> 1 [ S WindowShade West
  74 <fvwmref cmd="Mouse"/> 1 ] S WindowShade E
  75 <fvwmref cmd="Mouse"/> 1 _ S WindowShade S
  76 </programlisting>
  77
  78
  79 <para>Note: When a window that has been shaded with a
  80 <replaceable>direction</replaceable>
  81 argument changes the direction of the window title (see
  82 <fvwmref cmd="Style" opt="TitleAtTop"/>
  83 <fvwmref cmd="Style"/>
  84 option), the shading direction does not change.  This may look
  85 very strange.  Windows that were shaded without a
  86 <replaceable>direction</replaceable>
  87 argument stay shaded in the direction of the title bar.</para>
  88
  89 <para>For backward compatibility, the optional argument may also be 1 to
  90 signify "on", and 2 to signify "off". Note that this syntax is
  91 obsolete, and will be removed in the future.</para>
  92
  93 </section>