doc/commands/DestroyDecor.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: DestroyDecor.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='DestroyDecor'>
  12 <title>DestroyDecor</title>
  13
  14 <cmdsynopsis>
  15         <command>DestroyDecor</command
  16         ><arg choice='opt'>recreate</arg
  17         ><arg choice='plain'
  18                 ><replaceable>decor</replaceable
  19         ></arg>
  20 </cmdsynopsis>
  21
  22 <para>This command is deprecated and will be removed in the future.  There
  23 are plans to replace it with a more flexible solution in fvwm-3.0.</para>
  24
  25 <para>Deletes the
  26 <replaceable>decor</replaceable>
  27 defined with
  28 <emphasis remap='B'>AddToDecor</emphasis>,
  29 so that subsequent references to it are no longer valid.  Windows
  30 using this
  31 <replaceable>decor</replaceable>
  32 revert to the "Default" decor. The optional parameter
  33 <fvwmopt cmd="DestroyDecor" opt="recreate"/>
  34 tells fvwm not to throw away the decor completely but to throw
  35 away only its contents. If the decor is created again later,
  36 windows do not use it before the
  37 <fvwmref cmd="Style" opt="UseDecor"/>
  38 style is applied again unless the decor was destroyed with the
  39 <emphasis>recreate</emphasis>
  40 option.  The decor named "Default" cannot be destroyed.</para>
  41
  42 <programlisting>
  43 DestroyDecor CustomDecor1
  44 </programlisting>
  45
  46
  47 </section>