doc/commands/EdgeLeaveCommand.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: EdgeLeaveCommand.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='EdgeLeaveCommand'>
  12 <title>EdgeLeaveCommand</title>
  13
  14 <cmdsynopsis>
  15         <command>EdgeLeaveCommand</command
  16         ><arg choice='opt'
  17                 ><arg choice='plain'
  18                         ><replaceable>direction</replaceable
  19                 ></arg>
  20                 <arg choice='opt'
  21                         ><replaceable>Function</replaceable
  22                 ></arg
  23         ></arg>
  24 </cmdsynopsis>
  25
  26 <para>Binds a specified fvwm command
  27 <replaceable>Function</replaceable>
  28 to an edge of the screen. Direction may be one of
  29 "<fvwmopt cmd="EdgeLeaveCommand" opt="North"/>",
  30 "<fvwmopt cmd="EdgeLeaveCommand" opt="Top"/>",
  31 "<fvwmopt cmd="EdgeLeaveCommand" opt="West"/>",
  32 "<fvwmopt cmd="EdgeLeaveCommand" opt="Left"/>",
  33 "<fvwmopt cmd="EdgeLeaveCommand" opt="South"/>",
  34 "<fvwmopt cmd="EdgeLeaveCommand" opt="Bottom"/>",
  35 "<fvwmopt cmd="EdgeLeaveCommand" opt="Right"/>" and
  36 "<fvwmopt cmd="EdgeLeaveCommand" opt="East"/>".
  37 If
  38 <replaceable>Function</replaceable>
  39 is omitted the binding for this edge is removed. If
  40 EdgeLeaveCommand is called without any arguments all edge bindings
  41 are removed.</para>
  42
  43 <para><replaceable>Function</replaceable>
  44 is executed when the mouse pointer
  45 leaves the invisible pan frames that surround the visible screen.
  46 The binding works only if
  47 <fvwmref cmd="EdgeThickness"/>
  48 is set to a value greater than 0.
  49 If a function is bound to an edge, scrolling specified by
  50 <fvwmref cmd="EdgeScroll"/>
  51 is disabled for this edge.
  52 It is possible to bind a function only to some edges
  53 and use the other edges for scrolling.
  54 This command is intended to raise or lower certain windows
  55 when the mouse pointer leaves an edge.
  56 <fvwmref mod="FvwmAuto"/>
  57 can be used get a delay when raising or lowering windows.
  58 See example for
  59 <fvwmref cmd="EdgeCommand"/></para>
  60
  61 <para>Normally, the invisible pan frames are only on the screen edges
  62 that border virtual pages.  If a screen edge has a command bound
  63 to it, the pan frame is always created on that edge.</para>
  64
  65 </section>