doc/commands/ButtonState.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: ButtonState.xml,v 1.3 2007/06/16 12:38:45 griph Exp $ -->
  10
  11 <section id='ButtonState'>
  12 <title>ButtonState</title>
  13
  14 <cmdsynopsis>
  15         <command>ButtonState</command
  16         ><arg choice='opt'
  17                 >ActiveDown <replaceable>bool</replaceable
  18         ></arg
  19         ><arg choice='opt'
  20                 >Inactive <replaceable>bool</replaceable
  21         ></arg
  22         ><arg choice='opt'
  23                 >InactiveDown <replaceable>bool</replaceable
  24         ></arg>
  25 </cmdsynopsis>
  26
  27 <para>
  28 The
  29 <emphasis remap='B'>ButtonState</emphasis>
  30 command controls which states of the window titles and title
  31 buttons are used.  The default is to use all four states:
  32 "ActiveUp>",
  33 "ActiveDown>",
  34 "InactiveUp>" and
  35 "InactiveDown>" (see
  36 <fvwmref cmd="ButtonStyle"/> and
  37 <fvwmref cmd="TitleStyle"/>
  38 commands).  The
  39 <replaceable>bool</replaceable>
  40 argument after the key word controls if the designated state is
  41 used ("True") or not ("False").  The "ActiveUp" state cannot be
  42 deactivated. If no arguments are provided or the given arguments
  43 are illegal, the default is restored.</para>
  44
  45 <para>If
  46 <fvwmopt cmd="ButtonState" opt="ActiveDown"/>
  47 argument is "False", no different button style
  48 for the pressed down buttons used, instead "ActiveUp" state is
  49 used even when button is pressed.</para>
  50
  51 <para>If
  52 <fvwmopt cmd="ButtonState" opt="Inactive"/>
  53 argument is "False", focused and unfocused windows
  54 look similarly, the corresponding "Active" states are always used.</para>
  55
  56 <para>If
  57 <fvwmopt cmd="ButtonState" opt="InactiveDown"/>
  58 argument is "False" (only applied when
  59 <emphasis remap='I'>Inactive</emphasis>
  60 is "True"), the pressed titles and title buttons in non-focused
  61 windows are drawn using "InactiveUp" or "ActiveUp" states
  62 depending on the values of the other key words.</para>
  63
  64 </section>