doc/commands/FakeClick.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: FakeClick.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='FakeClick'>
  12 <title>FakeClick</title>
  13
  14 <cmdsynopsis>
  15         <command>FakeClick</command
  16         ><arg choice='plain' rep='repeat'
  17                 ><optional
  18                         ><arg choice='plain'
  19                                 ><replaceable>command</replaceable
  20                         ></arg
  21                         ><arg choice='plain'
  22                                 ><replaceable>value</replaceable
  23                         ></arg
  24                 ></optional
  25         ></arg>
  26 </cmdsynopsis>
  27
  28 <para>This command is mainly intended for debugging fvwm and no
  29 guarantees are made that it works for you.
  30 <emphasis>FakeClick</emphasis>
  31 can simulate mouse button press and release events and pass them
  32 to fvwm or the applications.  The parameters are a list of
  33 commands which consist of pairs of
  34 <replaceable>command</replaceable>
  35 tokens and integer
  36 <replaceable>values</replaceable>,
  37 The
  38 <fvwmopt cmd="FakeClick" opt="press"/> and <fvwmopt cmd="FakeClick" opt="release"/>
  39 commands are followed by the appropriate mouse button number and
  40 generate a button press or release event on the window below the
  41 pointer.  The
  42 <fvwmopt cmd="FakeClick" opt="wait"/>
  43 commands pauses fvwm for the given number of milliseconds.  The
  44 <fvwmopt cmd="FakeClick" opt="modifiers"/>
  45 command simulates pressing or releasing modifier keys.  The values
  46 1 to 5 are mapped to
  47 <keysym>Mod1</keysym>
  48 to
  49 <keysym>Mod5</keysym>
  50 while 6, 7 and 8 are mapped to
  51 <keysym>Shift</keysym>,
  52 <keysym>Lock</keysym>
  53 and
  54 <keysym>Control</keysym>.
  55 The modifier is set for any further button events.  To release a
  56 modifier key, use the corresponding negative number.  The
  57 <fvwmopt cmd="FakeClick" opt="depth"/>
  58 command determines to which window the button events are
  59 sent. With a depth of 1, all events go to the root window,
  60 regardless of the pointer's position.  With 2, the event is passed
  61 to the top level window under the pointer which is usually the
  62 frame window. With 3, events go to the client window. Higher
  63 numbers go to successive sub windows.  Zero (0) goes to the
  64 smallest window that contains the pointer.  Note that events
  65 propagate upward.</para>
  66
  67 <programlisting>
  68 FakeClick depth 2 press 1 wait 250 release 1
  69 </programlisting>
  70
  71 <para>This simulates a click with button 1 in the parent window (depth
  72 2) with a delay of 250 milliseconds between the press and the
  73 release.
  74 Note: all command names can be abbreviated with their first letter.</para>
  75
  76
  77 </section>