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 95 96 97
|
<?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: EdgeCommand.xml,v 1.4 2007/11/17 11:47:56 domivogt Exp $ -->
<section id='EdgeCommand'>
<title>EdgeCommand</title>
<cmdsynopsis>
<command>EdgeCommand</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="EdgeCommand" opt="North"/>",
"<fvwmopt cmd="EdgeCommand" opt="Top"/>",
"<fvwmopt cmd="EdgeCommand" opt="West"/>",
"<fvwmopt cmd="EdgeCommand" opt="Left"/>",
"<fvwmopt cmd="EdgeCommand" opt="South"/>",
"<fvwmopt cmd="EdgeCommand" opt="Bottom"/>",
"<fvwmopt cmd="EdgeCommand" opt="Right"/>" and
"<fvwmopt cmd="EdgeCommand" opt="East"/>".
If
<replaceable>Function</replaceable>
is omitted the binding for this edge is removed. If EdgeCommand is
called without any arguments all edge bindings are removed.</para>
<para><replaceable>Function</replaceable> is executed when the mouse pointer
enters 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 enters an edge.
<fvwmref mod="FvwmAuto"/>
can be used get a delay when raising or lowering windows.
The following example raises
<fvwmref mod="FvwmButtons"/>
if the mouse pointer enters the top edge of the screen.</para>
<programlisting>
# Disable EdgeScrolling but make it possible
# to move windows over the screen edge
<fvwmref cmd="EdgeResistance"/> -1
<fvwmref cmd="Style"/> * EdgeMoveDelay 250
<fvwmref cmd="Style"/> * EdgeMoveResistance 20
# Set thickness of the edge of the screen to 1
<fvwmref cmd="EdgeThickness"/> 1
# Give focus to FvwmButtons if the mouse
# hits top edge
EdgeCommand Top <fvwmref cmd="Next"/> (FvwmButtons) <fvwmref cmd="Focus"/>
# Make sure the <fvwmref cmd="Next"/> command matches the window
<fvwmref cmd="Style"/> FvwmButtons CirculateHit
<fvwmref cmd="Module"/> <fvwmref mod="FvwmButtons"/>
<fvwmref cmd="Module"/> <fvwmref mod="FvwmAuto"/> 100 "Silent AutoRaiseFunction" \
"Silent AutoLowerFunction"
# If any window except FvwmButtons has
# focus when calling this function
# FvwmButtons are lowered
<fvwmref cmd="DestroyFunc"/> AutoLowerFunction
<fvwmref cmd="AddToFunc"/> AutoLowerFunction
+ I <fvwmref cmd="Current"/> (!FvwmButtons) <fvwmref cmd="All"/> (FvwmButtons) <fvwmref cmd="Lower"/>
# If FvwmButtons has focus when calling this function raise it
<fvwmref cmd="DestroyFunc"/> AutoRaiseFunction
<fvwmref cmd="AddToFunc"/> AutoRaiseFunction
+ I <fvwmref cmd="Current"/> (FvwmButtons) <fvwmref cmd="Raise"/>
</programlisting>
<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>
|