doc/commands/PointerWindow.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: PointerWindow.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='PointerWindow'>
  12 <title>PointerWindow</title>
  13
  14 <cmdsynopsis>
  15         <command>PointerWindow</command
  16         ><arg choice='opt'
  17                 >(<replaceable>conditions</replaceable
  18         >)</arg
  19         ><arg choice='plain'
  20                 ><replaceable>command</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para>Performs
  25 <replaceable>command</replaceable>
  26 if the window under the pointer satisfies all
  27 <replaceable>conditions</replaceable>.
  28 Returns -1 if there is no window under the pointer.
  29 See <fvwmref sect="conditionals" opt="conditions" name="Conditions"/> section for a list of conditions.</para>
  30
  31 <para>This command implies the conditions
  32 <emphasis remap='I'>CirculateHit</emphasis>, <emphasis remap='I'>CirculateHitIcon</emphasis> and <emphasis remap='I'>CirculateHitShaded</emphasis>.
  33 They can be turned off by specifying
  34 <emphasis remap='I'>!CirculateHit</emphasis>
  35 etc. explicitly.</para>
  36
  37 </section>