doc/commands/EdgeCommand.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: EdgeCommand.xml,v 1.4 2007/11/17 11:47:56 domivogt Exp $ -->
  10
  11 <section id='EdgeCommand'>
  12 <title>EdgeCommand</title>
  13
  14 <cmdsynopsis>
  15         <command>EdgeCommand</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="EdgeCommand" opt="North"/>",
  30 "<fvwmopt cmd="EdgeCommand" opt="Top"/>",
  31 "<fvwmopt cmd="EdgeCommand" opt="West"/>",
  32 "<fvwmopt cmd="EdgeCommand" opt="Left"/>",
  33 "<fvwmopt cmd="EdgeCommand" opt="South"/>",
  34 "<fvwmopt cmd="EdgeCommand" opt="Bottom"/>",
  35 "<fvwmopt cmd="EdgeCommand" opt="Right"/>" and
  36 "<fvwmopt cmd="EdgeCommand" opt="East"/>".
  37 If
  38 <replaceable>Function</replaceable>
  39 is omitted the binding for this edge is removed. If EdgeCommand is
  40 called without any arguments all edge bindings are removed.</para>
  41
  42 <para><replaceable>Function</replaceable> is executed when the mouse pointer
  43 enters the invisible pan frames that surround the visible screen.
  44 The binding works only if
  45 <fvwmref cmd="EdgeThickness"/>
  46 is set to a value greater than 0.
  47 If a function is bound to an edge, scrolling specified by
  48 <fvwmref cmd="EdgeScroll"/>
  49 is disabled for this edge.
  50 It is possible to bind a function only to some edges
  51 and use the other edges for scrolling.
  52 This command is intended to raise or lower certain windows
  53 when the mouse pointer enters an edge.
  54 <fvwmref mod="FvwmAuto"/>
  55 can be used get a delay when raising or lowering windows.
  56 The following example raises
  57 <fvwmref mod="FvwmButtons"/>
  58 if the mouse pointer enters the top edge of the screen.</para>
  59
  60 <programlisting>
  61 # Disable EdgeScrolling but make it possible
  62 # to move windows over the screen edge
  63 <fvwmref cmd="EdgeResistance"/> -1
  64 <fvwmref cmd="Style"/> * EdgeMoveDelay 250
  65 <fvwmref cmd="Style"/> * EdgeMoveResistance 20
  66
  67 # Set thickness of the edge of the screen to 1
  68 <fvwmref cmd="EdgeThickness"/> 1
  69
  70 # Give focus to FvwmButtons if the mouse
  71 # hits top edge
  72 EdgeCommand Top <fvwmref cmd="Next"/> (FvwmButtons) <fvwmref cmd="Focus"/>
  73 # Make sure the <fvwmref cmd="Next"/> command matches the window
  74 <fvwmref cmd="Style"/> FvwmButtons CirculateHit
  75
  76 <fvwmref cmd="Module"/> <fvwmref mod="FvwmButtons"/>
  77 <fvwmref cmd="Module"/> <fvwmref mod="FvwmAuto"/> 100 "Silent AutoRaiseFunction" \
  78      "Silent AutoLowerFunction"
  79
  80 # If any window except FvwmButtons has
  81 # focus when calling this function
  82 # FvwmButtons are lowered
  83 <fvwmref cmd="DestroyFunc"/> AutoLowerFunction
  84 <fvwmref cmd="AddToFunc"/> AutoLowerFunction
  85 + I <fvwmref cmd="Current"/> (!FvwmButtons) <fvwmref cmd="All"/> (FvwmButtons) <fvwmref cmd="Lower"/>
  86
  87 # If FvwmButtons has focus when calling this function raise it
  88 <fvwmref cmd="DestroyFunc"/> AutoRaiseFunction
  89 <fvwmref cmd="AddToFunc"/> AutoRaiseFunction
  90 + I <fvwmref cmd="Current"/> (FvwmButtons) <fvwmref cmd="Raise"/>
  91 </programlisting>
  92
  93 <para>Normally, the invisible pan frames are only on the screen edges
  94 that border virtual pages.  If a screen edge has a command bound
  95 to it, the pan frame is always created on that edge.</para>
  96
  97 </section>