doc/commands/WarpToWindow.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: WarpToWindow.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='WarpToWindow'>
  12 <title>WarpToWindow</title>
  13
  14 <cmdsynopsis>
  15         <command>WarpToWindow</command
  16         ><arg choice='plain'
  17                 ><replaceable>x</replaceable
  18                 ><optional>p</optional
  19         ></arg
  20         ><arg choice='plain'
  21                 ><replaceable>y</replaceable
  22                 ><optional>p</optional
  23         ></arg>
  24 </cmdsynopsis>
  25
  26 <para>Warps the cursor to the associated window.  The parameters
  27 <replaceable>x</replaceable> and <replaceable>y</replaceable>
  28 default to percentage of window down and in from the upper left
  29 hand corner (or number of pixels down and in if
  30 '<fvwmopt cmd="WarpToWindow" opt="p"/>'
  31 is appended to the numbers).  If a number is negative the opposite
  32 edge is used and the direction reversed.  This command works also
  33 with windows that are not managed by fvwm.  In this case fvwm does
  34 not bring the window onto the screen if it is not visible.  For
  35 example it is possible to warp the pointer to the center of the
  36 root window on screen 1:</para>
  37
  38 <programlisting>
  39 <fvwmref cmd="WindowId"/> root 1 WarpToWindow 50 50
  40 </programlisting>
  41
  42 </section>