doc/commands/UpdateDecor.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: UpdateDecor.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='UpdateDecor'>
  12 <title>UpdateDecor</title>
  13
  14 <cmdsynopsis>
  15         <command>UpdateDecor</command
  16         ><arg choice='opt'
  17                 ><replaceable>decor</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>This command is deprecated and will be removed in the future.  There
  22 are plans to replace it with a more flexible solution in fvwm-3.0.</para>
  23
  24 <para>This command is kept mainly for backward compatibility.  Since
  25 all elements of a decor are updated immediately when they are
  26 changed, this command is mostly useless.</para>
  27
  28 <para>Updates window decorations.
  29 <replaceable>decor</replaceable>
  30 is an optional argument which specifies the
  31 <replaceable>decor</replaceable>
  32 to update.  If given, only windows which are assigned to that
  33 particular
  34 <replaceable>decor</replaceable>
  35 are updated.  This command is useful, for instance, after a
  36 <fvwmref cmd="ButtonStyle"/>, <fvwmref cmd="TitleStyle"/> or <fvwmref cmd="BorderStyle"/>
  37 (possibly used in conjunction with
  38 <fvwmref cmd="AddToDecor"/>).
  39 Specifying an invalid decor results in all windows being
  40 updated.  This command is less disturbing than
  41 <fvwmref cmd="Recapture"/>,
  42 but does not affect window style options as
  43 <fvwmref cmd="Recapture"/>
  44 does.</para>
  45
  46
  47 </section>