File: Scroll.xml

package info (click to toggle)
fvwm 1%3A2.7.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 15,968 kB
  • sloc: ansic: 145,836; xml: 17,096; perl: 7,237; sh: 5,100; makefile: 1,101; yacc: 688; lex: 187; sed: 11
file content (94 lines) | stat: -rw-r--r-- 2,612 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "../docbook-xml/docbookx.dtd"
[
<!ENTITY % myents SYSTEM "../fvwm.ent" >
%myents;
]>

<!-- $Id$ -->

<section id='Scroll'>
<title>Scroll</title>

<cmdsynopsis>
	<command>Scroll</command
	><group choice='opt'
		><arg choice='plain'
			><replaceable>horizonal</replaceable
			><optional>p</optional
			> <replaceable>vertical</replaceable
			><optional>p</optional
		></arg
		><arg choice='plain'>reverse</arg
	></group>
</cmdsynopsis>

<para>
Scrolls the virtual desktop's viewport by
<fvwmopt cmd="MenuStyle" opt="horizontal"/>
pages in the x-direction and
<fvwmopt cmd="MenuStyle" opt="vertical"/>
pages in the y-direction or starts interactive scrolling of the viewport.  Either or both entries may be negative.
Both
<replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>
values are expressed in percent of pages, so</para>

<programlisting>
Scroll 100 100
</programlisting>

<para>means to scroll down and right by one full page.</para>

<programlisting>
Scroll 50 25
</programlisting>

<para>means to scroll right half a page and down a quarter of a page.
The
<emphasis remap='B'>Scroll</emphasis>
function should not be called from pop-up menus.  Normally,
scrolling stops at the edge of the desktop.</para>

<para>If the
<replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>
percentages are 100 or more and are multiplied by 1000 then
scrolling wraps around at the edge of the desktop.  If</para>

<programlisting>
Scroll 100000 0
</programlisting>

<para>is executed over and over fvwm moves to the next desktop page on
each execution and wraps around at the edge of the desktop, so
that every page is hit in turn.</para>

<para>If the letter
'<fvwmopt cmd="Scroll" opt="p"/>'
is appended to each coordinate
(<replaceable>horizontal</replaceable> and/or <replaceable>vertical</replaceable>),
then the scroll amount is measured in pixels.</para>

<para>Without arguments or if the option
<emphasis>reverse</emphasis>
is given interactive scrolling takes place.  The viewport
scrolls as the mouse is moved. With the
<fvwmopt cmd="Scroll" opt="reverse"/>
option scrolling is done in opposite direction of the mouse
movement, and without it scrolling in the same direction as the
mouse.</para>

<para>The binding</para>

<programlisting>
<fvwmref cmd="Mouse"/> 1 A CM Scroll reverse
</programlisting>

<para>gives an effect of grabbing and dragging the viewport with button 1
if
<keysym>Control</keysym>
and
<keysym>Meta</keysym>
is pressed.</para>

</section>