doc/commands/ThisWindow.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: ThisWindow.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
   3 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   4   "../docbook-xml/docbookx.dtd"
   5 [
   6 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   7 %myents;
   8 ]>
   9
  10
  11 <section id='ThisWindow'>
  12 <title>ThisWindow</title>
  13
  14 <cmdsynopsis>
  15         <command>ThisWindow</command
  16         ><arg choice='opt'
  17                 >(<replaceable>conditions</replaceable
  18         >)</arg
  19         ><arg choice='plain'>command</arg>
  20 </cmdsynopsis>
  21
  22 <para><emphasis remap='B'>ThisWindow</emphasis>
  23 executes the specified
  24 <replaceable>command</replaceable>
  25 in the context of the current operand window.  If there is no
  26 operand window (it is invoked in the root window), the command is
  27 ignored.
  28 <emphasis remap='B'>ThisWindow</emphasis>
  29 is never interactive.  The command is executed only if the given
  30 <replaceable>conditions</replaceable>
  31 are met.  It returns -1 if used outside a window context.
  32 See <fvwmref sect="conditionals" opt="conditions" name="Conditions"/> section for a list of conditions.</para>
  33
  34 <para>This command implies the conditions
  35 <emphasis remap='I'>CirculateHit</emphasis>, <emphasis remap='I'>CirculateHitIcon</emphasis> and <emphasis remap='I'>CirculateHitShaded</emphasis>.
  36 They can be turned off by specifying "!CirculateHit"
  37 etc. explicitly.</para>
  38
  39 </section>