doc/commands/GotoPage.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: GotoPage.xml,v 1.4 2009/06/24 21:38:30 tadam 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='GotoPage'>
  12 <title>GotoPage</title>
  13
  14 <cmdsynopsis>
  15         <command>GotoPage</command
  16         ><group choice='plain'
  17                 ><arg choice='plain'>prev</arg
  18                 ><arg choice='plain'
  19                         ><arg choice='opt'
  20                                 ><replaceable>options</replaceable
  21                         ></arg
  22                         ><arg choice='plain'
  23                                 ><replaceable>x</replaceable
  24                                 ><optional>p</optional
  25                         ></arg
  26                         ><arg choice='plain'
  27                                 ><replaceable>y</replaceable
  28                                 ><optional>p</optional
  29                         ></arg
  30                 ></arg
  31         ></group>
  32 </cmdsynopsis>
  33
  34 <para>
  35 Moves the desktop viewport to page (x,y).  The upper left page is
  36 (0,0), the upper right is (M,0), where M is one less than the
  37 current number of horizontal pages specified in the
  38 <fvwmref cmd="DesktopSize"/>
  39 command.  The lower left page is (0,N), and the lower right page
  40 is (M,N), where N is the desktop's vertical size as specified in the
  41 <fvwmref cmd="DesktopSize"/>
  42 command.  To switch to a page relative to the current one add a
  43 trailing
  44 '<fvwmopt cmd="GotoPage" opt="p"/>'
  45 after any or both numerical arguments.</para>
  46
  47 <para>Possible
  48 <replaceable>options</replaceable>
  49 are
  50 <fvwmopt cmd="GotoPage" opt="wrapx"/> and <fvwmopt cmd="GotoPage" opt="wrapy"/>
  51 to wrap around the x or y coordinate when the viewport is moved
  52 beyond the border of the desktop.</para>
  53
  54 <para>To go to the last visited page use
  55 <fvwmopt cmd="GotoPage" opt="prev"/>
  56 as the first argument.  The
  57 <emphasis remap='B'>GotoPage</emphasis>
  58 function should not be used in a pop-up menu.</para>
  59
  60 <para>Examples:</para>
  61
  62 <programlisting>
  63 # Go to page (2,3)
  64 GotoPage 2 3
  65
  66 # Go to lowest and rightmost page
  67 GotoPage -1 -1
  68
  69 # Go to last page visited
  70 GotoPage prev
  71
  72 # Go two pages to the right and one page up
  73 GotoPage +2p -1p
  74 </programlisting>
  75
  76
  77 </section>