doc/commands/AddTitleStyle.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: AddTitleStyle.xml,v 1.3 2007/06/16 12:38:45 griph Exp $ -->
  10
  11 <section id='AddTitleStyle'>
  12 <title>AddTitleStyle</title>
  13
  14 <cmdsynopsis>
  15         <command>AddTitleStyle</command
  16         ><arg choice='opt'
  17                 ><replaceable>state</replaceable
  18         ></arg
  19         ><arg choice='opt'
  20                 ><replaceable>style</replaceable
  21         ></arg
  22         ><arg choice='opt'
  23                 >-- <arg choice='plain' rep='repeat'
  24                         ><optional>!</optional
  25                         ><replaceable>flag</replaceable
  26                 ></arg
  27         ></arg>
  28 </cmdsynopsis>
  29
  30 <para>Adds a title style to the title-bar.
  31 <replaceable>state</replaceable> can be
  32 "<fvwmopt cmd="AddTitleStyle" opt="ActiveUp"/>",
  33 "<fvwmopt cmd="AddTitleStyle" opt="ActiveDown"/>",
  34 "<fvwmopt cmd="AddTitleStyle" opt="InactiveUp"/>" or
  35 "<fvwmopt cmd="AddTitleStyle" opt="InactiveDown"/>", or
  36 "<fvwmopt cmd="AddTitleStyle" opt="Active"/>" (the same as both "ActiveUp" and "ActiveDown") or
  37 "<fvwmopt cmd="AddTitleStyle" opt="Inactive"/>" (the same as both "InactiveUp" and "InactiveDown")
  38 or any of these 6 with "Toggled" prepended.  If
  39 <replaceable>state</replaceable>
  40 is omitted, then the style is added to every state.  If the
  41 <replaceable>style</replaceable> and <replaceable>flags</replaceable>
  42 are enclosed in parentheses, then multiple
  43 <replaceable>state</replaceable>
  44 definitions can be placed on a single line.  This command is quite
  45 similar to the
  46 <fvwmref cmd="AddButtonStyle"/>
  47 command.</para>
  48
  49 <para>Title-bars are drawn in the order of definition, beginning with
  50 the most recent
  51 <fvwmref cmd="TitleStyle"/>,
  52 followed by those added with
  53 <emphasis remap='B'>AddTitleStyle</emphasis>.
  54 To clear the title style stack, change style flags, or for the
  55 descriptions of available styles and flags, see the
  56 <fvwmref cmd="TitleStyle"/> and
  57 <fvwmref cmd="ButtonStyle"/>
  58 commands.</para>
  59
  60 </section>