Resources/Help/Contents/Resources/English.lproj/pgs/mouse.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml">
   5   <head>
   6     <title>Mouse Events</title>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
   8     <link href="../sty/default.css"
   9           rel="stylesheet"
  10           type="text/css"
  11           media="all"/>
  12   </head>
  13
  14   <body>
  15     <a name="mouse"></a>
  16
  17     <div id="navbox">
  18       <div id="navleftbox">
  19         <a class="navlink_left"
  20            href="help:anchor='home' bookID='com.yukkurigames.Enjoyable.help'">
  21           Home
  22         </a>
  23       </div>
  24     </div>
  25
  26     <div id="headerbox">
  27       <div id="iconbox">
  28         <img id="iconimg"
  29              src="../gfx/Icon.png"
  30              alt="Icon"
  31              height="32" width="32"/>
  32       </div>
  33       <h1>Mouse Events</h1>
  34     </div>
  35
  36     <p>
  37       You can use Enjoyable to map input to mouse buttons, moving, and
  38       scrolling.
  39     </p>
  40
  41     <h3>Movement</h3>
  42     <p>
  43       Select the direction you'd like the input to move the
  44       mouse. Adjust the movement speed using the slider underneath.  If
  45       you are mapping an analog input then this is the maximum speed;
  46       for a button it's a constant speed.
  47     </p>
  48     <p>
  49       The speed is set independently for each input. You can have
  50       faster horizontal movement than vertical movement, or map one
  51       set of inputs to a fast speed and another set to a slow
  52       speed.
  53     </p>
  54
  55     <h3>Buttons</h3>
  56     <p>
  57       Select the mouse button you'd like the input to simulate.
  58     </p>
  59
  60     <h3><a name="scrolling"></a>Scrolling</h3>
  61     <p>
  62       Simulated scrolling can be continuous like the scrolling
  63       gestures on a trackpad, or discrete like a mouse wheel that
  64       clicks as you spin it. You can simulate a vertical or horizontal
  65       mouse wheel.
  66     </p>
  67     <p>
  68       To use <em>continuous scrolling</em> check the <b>Smooth</b>
  69       button and use the slider underneath the directions to adjust
  70       the scrolling speed. If you are mapping an analog input then
  71       this is the maximum speed; for a button it's a constant
  72       speed. Scrolling will continue as long as as the input is held
  73       down.
  74     <p>
  75       To use <em>discrete scrolling</em> leave the button
  76       unchecked. The input will trigger scrolling by exactly one line
  77       and stop, regardless of how long you hold the button down or how
  78       far you move an analog input.
  79     </p>
  80     <p>
  81       The arrows indicate the direction you would spin a mouse wheel
  82       or move your fingers. Depending on settings this may mean you
  83       need to choose a down arrow to scroll up and vice versa. You can
  84       also change this globally in <b> > System Preferences… >
  85       Mouse</b> and <b> > System Preferences… > Trackpad</b>.
  86     </p>
  87
  88     <h3><a name="mouseissues"></a>Known Issues</h3>
  89     <p>
  90       Enjoyable is unable to send most mouse events to itself - the
  91       application will freeze until you click on it with a real mouse
  92       or touchpad. If you find another appliation that has problems
  93       with Enjoyable's mouse support <a
  94       href="https://github.com/joewreschnig/enjoyable/issues">please
  95       file a ticket in the issue tracker</a>.
  96     </p>
  97   </body>
  98 </html>