File: EdgeLeaveCommand.xml

package info (click to toggle)
fvwm 1%3A2.7.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 15,908 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 (65 lines) | stat: -rw-r--r-- 2,077 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
<?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='EdgeLeaveCommand'>
<title>EdgeLeaveCommand</title>

<cmdsynopsis>
	<command>EdgeLeaveCommand</command
	><arg choice='opt'
		><arg choice='plain'
			><replaceable>direction</replaceable
		></arg>
		<arg choice='opt'
			><replaceable>Function</replaceable
		></arg
	></arg>
</cmdsynopsis>

<para>Binds a specified fvwm command
<replaceable>Function</replaceable>
to an edge of the screen. Direction may be one of
"<fvwmopt cmd="EdgeLeaveCommand" opt="North"/>",
"<fvwmopt cmd="EdgeLeaveCommand" opt="Top"/>",
"<fvwmopt cmd="EdgeLeaveCommand" opt="West"/>",
"<fvwmopt cmd="EdgeLeaveCommand" opt="Left"/>",
"<fvwmopt cmd="EdgeLeaveCommand" opt="South"/>",
"<fvwmopt cmd="EdgeLeaveCommand" opt="Bottom"/>",
"<fvwmopt cmd="EdgeLeaveCommand" opt="Right"/>" and
"<fvwmopt cmd="EdgeLeaveCommand" opt="East"/>".
If
<replaceable>Function</replaceable>
is omitted the binding for this edge is removed. If
EdgeLeaveCommand is called without any arguments all edge bindings
are removed.</para>

<para><replaceable>Function</replaceable>
is executed when the mouse pointer
leaves the invisible pan frames that surround the visible screen.
The binding works only if
<fvwmref cmd="EdgeThickness"/>
is set to a value greater than 0.
If a function is bound to an edge, scrolling specified by
<fvwmref cmd="EdgeScroll"/>
is disabled for this edge.
It is possible to bind a function only to some edges
and use the other edges for scrolling.
This command is intended to raise or lower certain windows
when the mouse pointer leaves an edge.
<fvwmref mod="FvwmAuto"/>
can be used get a delay when raising or lowering windows.
See example for
<fvwmref cmd="EdgeCommand"/></para>

<para>Normally, the invisible pan frames are only on the screen edges
that border virtual pages.  If a screen edge has a command bound
to it, the pan frame is always created on that edge.</para>

</section>