doc/commands/Scroll.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: Scroll.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Scroll'>
  12 <title>Scroll</title>
  13
  14 <cmdsynopsis>
  15         <command>Scroll</command
  16         ><group choice='opt'
  17                 ><arg choice='plain'
  18                         ><replaceable>horizonal</replaceable
  19                         ><optional>p</optional
  20                         > <replaceable>vertical</replaceable
  21                         ><optional>p</optional
  22                 ></arg
  23                 ><arg choice='plain'>reverse</arg
  24         ></group>
  25 </cmdsynopsis>
  26
  27 <para>
  28 Scrolls the virtual desktop's viewport by
  29 <fvwmopt cmd="MenuStyle" opt="horizontal"/>
  30 pages in the x-direction and
  31 <fvwmopt cmd="MenuStyle" opt="vertical"/>
  32 pages in the y-direction or starts interactive scrolling of the viewport.  Either or both entries may be negative.
  33 Both
  34 <replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>
  35 values are expressed in percent of pages, so</para>
  36
  37 <programlisting>
  38 Scroll 100 100
  39 </programlisting>
  40
  41 <para>means to scroll down and right by one full page.</para>
  42
  43 <programlisting>
  44 Scroll 50 25
  45 </programlisting>
  46
  47 <para>means to scroll right half a page and down a quarter of a page.
  48 The
  49 <emphasis remap='B'>Scroll</emphasis>
  50 function should not be called from pop-up menus.  Normally,
  51 scrolling stops at the edge of the desktop.</para>
  52
  53 <para>If the
  54 <replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>
  55 percentages are 100 or more and are multiplied by 1000 then
  56 scrolling wraps around at the edge of the desktop.  If</para>
  57
  58 <programlisting>
  59 Scroll 100000 0
  60 </programlisting>
  61
  62 <para>is executed over and over fvwm moves to the next desktop page on
  63 each execution and wraps around at the edge of the desktop, so
  64 that every page is hit in turn.</para>
  65
  66 <para>If the letter
  67 '<fvwmopt cmd="Scroll" opt="p"/>'
  68 is appended to each coordinate
  69 (<replaceable>horizontal</replaceable> and/or <replaceable>vertical</replaceable>),
  70 then the scroll amount is measured in pixels.</para>
  71
  72 <para>Without arguments or if the option
  73 <emphasis>reverse</emphasis>
  74 is given interactive scrolling takes place.  The viewport
  75 scrolls as the mouse is moved. With the
  76 <fvwmopt cmd="Scroll" opt="reverse"/>
  77 option scrolling is done in opposite direction of the mouse
  78 movement, and without it scrolling in the same direction as the
  79 mouse.</para>
  80
  81 <para>The binding</para>
  82
  83 <programlisting>
  84 <fvwmref cmd="Mouse"/> 1 A CM Scroll reverse
  85 </programlisting>
  86
  87 <para>gives an effect of grabbing and dragging the viewport with button 1
  88 if
  89 <keysym>Control</keysym>
  90 and
  91 <keysym>Meta</keysym>
  92 is pressed.</para>
  93
  94 </section>