doc/commands/CursorMove.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: CursorMove.xml,v 1.3 2007/06/16 12:38:45 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='CursorMove'>
  12 <title>CursorMove</title>
  13
  14 <cmdsynopsis>
  15         <command>CursorMove</command
  16         ><arg choice='plain'
  17                 ><replaceable>horizontal</replaceable
  18                 ><optional>p</optional
  19         ></arg
  20         ><arg choice='plain'
  21                 ><replaceable>vertical</replaceable
  22                 ><optional>p</optional
  23         ></arg>
  24 </cmdsynopsis>
  25
  26 <para>Moves the mouse pointer by
  27 <replaceable>horizontal</replaceable>
  28 pages in the X direction and
  29 <replaceable>vertical</replaceable>
  30 pages in the Y direction.  Either or both entries may be
  31 negative. Both horizontal and vertical values are expressed in
  32 percent of pages, so</para>
  33
  34 <programlisting>
  35 CursorMove 100 100
  36 </programlisting>
  37
  38 <para>means to move down and right by one full page.</para>
  39
  40 <programlisting>
  41 CursorMove 50 25
  42 </programlisting>
  43
  44 <para>means to move right half a page and down a quarter of a
  45 page. Alternatively, the distance can be specified in pixels by
  46 appending a
  47 '<fvwmopt cmd="CursorMove" opt="p"/>'
  48 to the horizontal and/or vertical specification.  For example</para>
  49
  50 <programlisting>
  51 CursorMove -10p -10p
  52 </programlisting>
  53
  54 <para>means move ten pixels up and ten pixels left.  The CursorMove
  55 function should not be called from pop-up menus.</para>
  56
  57 </section>