doc/commands/AddToDecor.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: AddToDecor.xml,v 1.3 2007/06/16 12:38:45 griph Exp $ -->
  10
  11 <section id='AddToDecor'>
  12 <title>AddToDecor</title>
  13
  14 <cmdsynopsis>
  15         <command>AddToDecor</command
  16         ><arg choice='plain'
  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>Add or divert commands to the decor named
  25 <replaceable>decor</replaceable>.
  26 A decor is a name given to the set of commands which affect button
  27 styles, title-bar styles and border styles.  If
  28 <replaceable>decor</replaceable>
  29 does not exist it is created; otherwise the existing
  30 <replaceable>decor</replaceable>
  31 is modified.  Note: Earlier versions allowed to use the
  32 <fvwmref cmd="HilightColor"/>, <fvwmref cmd="HilightColorset"/> and <fvwmref cmd="WindowFont"/>
  33 commands in decors.  This is no longer possible.  Please use the
  34 <fvwmref cmd="Style"/>
  35 command with the
  36 <emphasis remap='I'>Hilight...</emphasis> and <fvwmref cmd="Style" opt="Font"/>
  37 options.</para>
  38
  39 <para>New decors start out exactly like the "default" decor without any
  40 style definitions.  A given decor may be applied to a set of
  41 windows with the
  42 <fvwmref cmd="Style" opt="UseDecor"/>
  43 option of the
  44 <fvwmref cmd="Style"/>
  45 command.  Modifying an existing decor affects all windows which
  46 are currently assigned to it.</para>
  47
  48 <para><emphasis remap='B'>AddToDecor</emphasis>
  49 is similar in usage to the
  50 <fvwmref cmd="AddToMenu"/> and <fvwmref cmd="AddToFunc"/>
  51 commands, except that menus and functions are replaced by
  52 <fvwmref cmd="ButtonStyle"/>, <fvwmref cmd="AddButtonStyle"/>, <fvwmref cmd="TitleStyle"/>,
  53 <fvwmref cmd="AddTitleStyle"/> and <fvwmref cmd="BorderStyle"/>
  54 commands.  Decors created with
  55 <emphasis remap='B'>AddToDecor</emphasis>
  56 can be manipulated with
  57 <fvwmref cmd="ChangeDecor"/>, <fvwmref cmd="DestroyDecor"/>, <fvwmref cmd="UpdateDecor"/>
  58 and the
  59 <fvwmref cmd="Style"/>
  60 option.</para>
  61
  62 <para>The following example creates a decor "FlatDecor" and style
  63 "FlatStyle".  They are distinct entities:</para>
  64
  65 <programlisting>
  66 AddToDecor FlatDecor
  67 + <fvwmref cmd="ButtonStyle"/> All Active (-- flat) Inactive (-- flat)
  68 + <fvwmref cmd="TitleStyle"/>  -- flat
  69 + <fvwmref cmd="BorderStyle"/> -- HiddenHandles NoInset
  70
  71 <fvwmref cmd="Style"/> FlatStyle \
  72         UseDecor FlatDecor, HandleWidth 4, ForeColor white, \
  73         BackColor grey40, HilightFore black, HilightBack grey70
  74
  75 <fvwmref cmd="Style"/> xterm UseStyle FlatStyle
  76 </programlisting>
  77
  78 <para>An existing window's decor may be reassigned with
  79 <fvwmref cmd="ChangeDecor"/>.
  80 A decor can be destroyed with
  81 <fvwmref cmd="DestroyDecor"/>.</para>
  82
  83 <programlisting>
  84 <fvwmref cmd="DestroyDecor"/> FlatDecor
  85 AddToDecor FlatDecor ...
  86
  87 <fvwmref cmd="Style"/> FlatStyle UseDecor FlatDecor
  88 </programlisting>
  89
  90 <para>and now apply the style again:</para>
  91
  92 <programlisting>
  93 <fvwmref cmd="Style"/> xterm UseStyle FlatStyle
  94 </programlisting>
  95
  96 </section>