doc/commands/State.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: State.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='State'>
  12 <title>State</title>
  13
  14 <cmdsynopsis>
  15         <command>State</command
  16         ><arg choice='plain'
  17                 ><replaceable>state</replaceable
  18         ></arg
  19         ><arg choice='opt'
  20                 ><replaceable>bool</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para>Sets, clears or toggles one of the 32 user defined states which
  25 are associated with each window.  The
  26 <replaceable>state</replaceable>
  27 is a number ranging from 0 to 31.  The states have no meaning in
  28 fvwm, but they can be checked in conditional commands like
  29 <fvwmref cmd="Next"/>
  30 with the
  31 <emphasis remap='I'>State</emphasis>
  32 condition.  The optional argument
  33 <replaceable>bool</replaceable>
  34 is a boolean argument.  "True" sets the given state, while "False"
  35 clears it.  Using "toggle" switches to the opposite state.  If the
  36 <replaceable>bool</replaceable>
  37 argument is not given, the state is toggled.</para>
  38
  39 </section>