DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra
1
0
Fork 0
Code Releases 0 Activity
Extra "ports" of juce-based plugins using the distrho build system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
1 Branch
28MB
Tree: aed02c1b70
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'aed02c1b70'
${ noResults }
DISTRHO-Ports-Extra/ports/protoplug/ProtoplugFiles/doc/modules/gui.html

678 lines
17KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

  2.    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

  3. <html>

  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

  5. <head>

  6.     <title>protoplug: Module gui</title>

  7.     <link rel="stylesheet" href="../ldoc.css" type="text/css" />

  8. </head>

  9. <body>

  10. 

  11. <div id="container">

  12. 

  13. <div id="product">

  14. 	<div id="product_logo"></div>

  15. 	<div id="product_name"><big><b></b></big></div>

  16. 	<div id="product_description"></div>

  17. </div> <!-- id="product" -->

  18. 

  19. 

  20. <div id="main">

  21. 

  22. 

  23. <!-- Menu -->

  24. 

  25. <div id="navigation">

  26. <a href="http://osar.fr">

  27. <div class=osarlogo> </div>

  28. </a>

  29. <br/>

  30. <a href="http://osar.fr/protoplug">

  31. <h1>protoplug</h1>

  32. </a>

  33. 	<span class="proto_subtitle">Lua API reference</span>

  34. 

  35. <ul>

  36.   <li><a href="../index.html">Index</a></li>

  37. </ul>

  38. 

  39. <h2>Contents</h2>

  40. <ul>

  41. <li><a href="#Functions">Functions</a></li>

  42. <li><a href="#Tables">Tables</a></li>

  43. <li><a href="#Class_gui_MouseEvent">Class gui.MouseEvent </a></li>

  44. <li><a href="#Class_gui_MouseWheelDetails">Class gui.MouseWheelDetails </a></li>

  45. <li><a href="#Class_gui_KeyPress">Class gui.KeyPress </a></li>

  46. </ul>

  47. 

  48. 

  49. <h2>Modules</h2>

  50. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  51.   <li><a href="../modules/plugin.html">plugin</a></li>

  52.   <li><a href="../modules/script.html">script</a></li>

  53.   <li><a href="../modules/midi.html">midi</a></li>

  54.   <li><strong>gui</strong></li>

  55.   <li><a href="../modules/polyGen.html">polyGen</a></li>

  56.   <li><a href="../modules/stereoFx.html">stereoFx</a></li>

  57. </ul>

  58. <h2>Classes</h2>

  59. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  60.   <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>

  61.   <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>

  62.   <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>

  63.   <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>

  64.   <li><a href="../classes/juce.Component.html">juce.Component</a></li>

  65.   <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>

  66.   <li><a href="../classes/juce.Font.html">juce.Font</a></li>

  67.   <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>

  68.   <li><a href="../classes/juce.Image.html">juce.Image</a></li>

  69.   <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>

  70.   <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>

  71.   <li><a href="../classes/juce.Line.html">juce.Line</a></li>

  72.   <li><a href="../classes/juce.Path.html">juce.Path</a></li>

  73.   <li><a href="../classes/juce.Point.html">juce.Point</a></li>

  74.   <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>

  75.   <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>

  76.   <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>

  77. </ul>

  78. <h2>Examples</h2>

  79. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  80.   <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>

  81.   <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>

  82.   <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>

  83.   <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>

  84.   <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>

  85. </ul>

  86. 

  87. </div>

  88. 

  89. <div id="content">

  90. 

  91. <h1>Module <code>gui</code></h1>

  92. <p>Use <a href="../modules/gui.html#">gui</a>  to define your script's custom graphical user interface.</p>

  93. <p>

  94. 

  95. <p> Custom GUI example : <a href="../examples/sinemouse-demo.lua.html#">sinemouse-demo.lua</a></p>

  96. 

  97. <p> The <a href="../modules/gui.html#">gui</a>  global is available to every protoplug script after including the

  98.  main protoplug header :</p>

  99. <pre><code>require "include/protoplug"

  100. </code></pre>

  101. </p>

  102. 

  103. 

  104. <h2><a href="#Functions">Functions</a></h2>

  105. <table class="function_list">

  106. 	<tr>

  107. 	<td class="name" nowrap><a href="#addHandler"><span class="proto_prefix">gui</span>.addHandler (event, handler)</a></td>

  108. 	<td class="summary">Add a handler for a GUI event.</td>

  109. 	</tr>

  110. 	<tr>

  111. 	<td class="name" nowrap><a href="#paint"><span class="proto_prefix">gui</span>.paint (g)</a></td>

  112. 	<td class="summary">Override to paint a custom GUI.</td>

  113. 	</tr>

  114. 	<tr>

  115. 	<td class="name" nowrap><a href="#getComponent"><span class="proto_prefix">gui</span>.getComponent ()</a></td>

  116. 	<td class="summary">Get GUI Component.</td>

  117. 	</tr>

  118. </table>

  119. <h2><a href="#Tables">Tables</a></h2>

  120. <table class="function_list">

  121. 	<tr>

  122. 	<td class="name" nowrap><a href="#FocusCause"><span class="proto_prefix">gui</span>.FocusCause</a></td>

  123. 	<td class="summary">Focus change causes.</td>

  124. 	</tr>

  125. 	<tr>

  126. 	<td class="name" nowrap><a href="#ModifierKeys"><span class="proto_prefix">gui</span>.ModifierKeys</a></td>

  127. 	<td class="summary">Keyboard and mouse modifiers.</td>

  128. 	</tr>

  129. </table>

  130. <h2><a href="#Class_gui_MouseEvent">Class gui.MouseEvent </a></h2>

  131. <table class="function_list">

  132. 	<tr>

  133. 	<td class="name" nowrap><a href="#MouseEvent.x"><span class="proto_prefix">gui.MouseEvent</span>.x</a></td>

  134. 	<td class="summary">X.</td>

  135. 	</tr>

  136. 	<tr>

  137. 	<td class="name" nowrap><a href="#MouseEvent.y"><span class="proto_prefix">gui.MouseEvent</span>.y</a></td>

  138. 	<td class="summary">Y.</td>

  139. 	</tr>

  140. 	<tr>

  141. 	<td class="name" nowrap><a href="#MouseEvent.mods"><span class="proto_prefix">gui.MouseEvent</span>.mods</a></td>

  142. 	<td class="summary">Modifier keys.</td>

  143. 	</tr>

  144. 	<tr>

  145. 	<td class="name" nowrap><a href="#MouseEvent.eventComponent"><span class="proto_prefix">gui.MouseEvent</span>.eventComponent</a></td>

  146. 	<td class="summary">Event component.</td>

  147. 	</tr>

  148. 	<tr>

  149. 	<td class="name" nowrap><a href="#MouseEvent.originalComponent"><span class="proto_prefix">gui.MouseEvent</span>.originalComponent</a></td>

  150. 	<td class="summary">Original component.</td>

  151. 	</tr>

  152. 	<tr>

  153. 	<td class="name" nowrap><a href="#MouseEvent.eventTime"><span class="proto_prefix">gui.MouseEvent</span>.eventTime</a></td>

  154. 	<td class="summary">Time.</td>

  155. 	</tr>

  156. 	<tr>

  157. 	<td class="name" nowrap><a href="#MouseEvent.mouseDownTime"><span class="proto_prefix">gui.MouseEvent</span>.mouseDownTime</a></td>

  158. 	<td class="summary">Mouse down time.</td>

  159. 	</tr>

  160. 	<tr>

  161. 	<td class="name" nowrap><a href="#MouseEvent.mouseDownPos"><span class="proto_prefix">gui.MouseEvent</span>.mouseDownPos</a></td>

  162. 	<td class="summary">Mouse down position.</td>

  163. 	</tr>

  164. 	<tr>

  165. 	<td class="name" nowrap><a href="#MouseEvent.numberOfClicks"><span class="proto_prefix">gui.MouseEvent</span>.numberOfClicks</a></td>

  166. 	<td class="summary">Number of clicks.</td>

  167. 	</tr>

  168. 	<tr>

  169. 	<td class="name" nowrap><a href="#MouseEvent.wasMovedSinceMouseDown"><span class="proto_prefix">gui.MouseEvent</span>.wasMovedSinceMouseDown</a></td>

  170. 	<td class="summary">Was moved since mouse down.</td>

  171. 	</tr>

  172. </table>

  173. <h2><a href="#Class_gui_MouseWheelDetails">Class gui.MouseWheelDetails </a></h2>

  174. <table class="function_list">

  175. 	<tr>

  176. 	<td class="name" nowrap><a href="#MouseWheelDetails.deltaX"><span class="proto_prefix">gui.MouseWheelDetails</span>.deltaX</a></td>

  177. 	<td class="summary">X delta.</td>

  178. 	</tr>

  179. 	<tr>

  180. 	<td class="name" nowrap><a href="#MouseWheelDetails.deltaY"><span class="proto_prefix">gui.MouseWheelDetails</span>.deltaY</a></td>

  181. 	<td class="summary">Y delta.</td>

  182. 	</tr>

  183. 	<tr>

  184. 	<td class="name" nowrap><a href="#MouseWheelDetails.isReversed"><span class="proto_prefix">gui.MouseWheelDetails</span>.isReversed</a></td>

  185. 	<td class="summary">Is reversed.</td>

  186. 	</tr>

  187. 	<tr>

  188. 	<td class="name" nowrap><a href="#MouseWheelDetails.isSmooth"><span class="proto_prefix">gui.MouseWheelDetails</span>.isSmooth</a></td>

  189. 	<td class="summary">Is smooth.</td>

  190. 	</tr>

  191. </table>

  192. <h2><a href="#Class_gui_KeyPress">Class gui.KeyPress </a></h2>

  193. <table class="function_list">

  194. 	<tr>

  195. 	<td class="name" nowrap><a href="#KeyPress.keyCode"><span class="proto_prefix">gui.KeyPress</span>.keyCode</a></td>

  196. 	<td class="summary">Key code.</td>

  197. 	</tr>

  198. 	<tr>

  199. 	<td class="name" nowrap><a href="#KeyPress.mods"><span class="proto_prefix">gui.KeyPress</span>.mods</a></td>

  200. 	<td class="summary">Modifier Keys.</td>

  201. 	</tr>

  202. 	<tr>

  203. 	<td class="name" nowrap><a href="#KeyPress.textCharacter"><span class="proto_prefix">gui.KeyPress</span>.textCharacter</a></td>

  204. 	<td class="summary">Text character.</td>

  205. 	</tr>

  206. </table>

  207. 

  208. <br/>

  209. <br/>

  210. 

  211. 

  212.     <h2><a name="Functions"></a>Functions</h2>

  213.     <dl class="function">

  214.     <dt>

  215.     <a name = "addHandler"></a>

  216.     <strong><span class="proto_prefix">gui</span>.addHandler (event, handler)</strong>

  217.     </dt>

  218.     <dd>

  219.     Add a handler for a GUI event. </p>

  220. 

  221. <p>Here's a list of the events and their parameters, showing how they

  222. should be received :</p>

  223. <pre><code>gui.addHandler("resized",               function() ... end)

  224. gui.addHandler("focusGained",           function(focusCause) ... end)

  225. gui.addHandler("focusLost",             function(focusCause) ... end)

  226. gui.addHandler("modifierKeysChanged",   function(modifierKeys) ... end)

  227. gui.addHandler("mouseMove",             function(mouseEvent) ... end)

  228. gui.addHandler("mouseEnter",            function(mouseEvent) ... end)

  229. gui.addHandler("mouseExit",             function(mouseEvent) ... end)

  230. gui.addHandler("mouseDown",             function(mouseEvent) ... end)

  231. gui.addHandler("mouseDrag",             function(mouseEvent) ... end)

  232. gui.addHandler("mouseUp",               function(mouseEvent) ... end)

  233. gui.addHandler("mouseDoubleClick",      function(mouseEvent) ... end)

  234. gui.addHandler("mouseWheelMove",        function(mouseEvent, mouseWheelDetails) ... end)

  235. gui.addHandler("keyPressed",            function(keyPress, srcComponent) ... end)

  236. gui.addHandler("keyStateChanged",       function(keyPress, srcComponent) ... end)

  237. </code></pre>

  238. <p>Parameters received by the event handlers are of

  239. type <a href="../modules/gui.html#FocusCause">FocusCause</a>, <a href="../modules/gui.html#ModifierKeys">ModifierKeys</a>, <a href="../modules/gui.html#gui.MouseEvent">MouseEvent</a>, <a href="../modules/gui.html#gui.MouseWheelDetails">MouseWheelDetails</a>,

  240. and <a href="../modules/gui.html#gui.KeyPress">KeyPress</a>.

  241. 

  242.     </ul>

  243. 

  244.     <h3>Parameters:</h3>

  245.     <ul>

  246.         <li><span class="parameter">event</span>

  247.             <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>

  248.          the event to handle

  249.         </li>

  250.         <li><span class="parameter">handler</span>

  251.             <span class="types"><span class="type">function</span></span>

  252.          a function to add the event's handlers

  253.         </li>

  254.     </ul>

  255. 

  256. 

  257. 

  258.     <h3>See also:</h3>

  259.     <ul>

  260.          <li><a href="../modules/script.html#addHandler">script.addHandler</a></li>

  261.          <li><a href="../modules/plugin.html#addHandler">plugin.addHandler</a></li>

  262.     </ul>

  263. 

  264. 

  265. </dd>

  266.     <dt>

  267.     <a name = "paint"></a>

  268.     <strong><span class="proto_prefix">gui</span>.paint (g)</strong>

  269.     </dt>

  270.     <dd>

  271.     Override to paint a custom GUI.

  272.  Define this function to paint something in the custom GUI space.

  273. 

  274.     </ul>

  275. 

  276.     <h3>Parameters:</h3>

  277.     <ul>

  278.         <li><span class="parameter">g</span>

  279.             <span class="types"><a class="type" href="../classes/juce.Graphics.html#">juce.Graphics</a></span>

  280.          a JUCE graphics target

  281.         </li>

  282.     </ul>

  283. 

  284. 

  285. 

  286. 

  287. 

  288. </dd>

  289.     <dt>

  290.     <a name = "getComponent"></a>

  291.     <strong><span class="proto_prefix">gui</span>.getComponent ()</strong>

  292.     </dt>

  293.     <dd>

  294.     Get GUI Component.

  295. 

  296.     </ul>

  297. 

  298. 

  299.     <h3>Returns:</h3>

  300.     <ol>

  301. 

  302.         the current GUI component, or <code>nil</code> if the GUI

  303.  has not been opened yet.

  304.     </ol>

  305. 

  306. 

  307. 

  308. 

  309. </dd>

  310. </dl>

  311.     <h2><a name="Tables"></a>Tables</h2>

  312.     <dl class="function">

  313.     <dt>

  314.     <a name = "FocusCause"></a>

  315.     <strong><span class="proto_prefix">gui</span>.FocusCause</strong>

  316.     </dt>

  317.     <dd>

  318.     Focus change causes.

  319.  Values received by the <code>focusGained</code> and <code>focusLost</code> handlers.

  320. 

  321.     </ul>

  322. 

  323.     <h3>Fields:</h3>

  324.     <ul>

  325.         <li><span class="parameter">focusChangedByMouseClick</span>

  326.         0

  327.         </li>

  328.         <li><span class="parameter">focusChangedByTabKey</span>

  329.         1

  330.         </li>

  331.         <li><span class="parameter">focusChangedDirectly</span>

  332.         2

  333.         </li>

  334.     </ul>

  335. 

  336. 

  337. 

  338.     <h3>See also:</h3>

  339.     <ul>

  340.          <a href="../modules/gui.html#addHandler">gui.addHandler</a>

  341.     </ul>

  342. 

  343. 

  344. </dd>

  345.     <dt>

  346.     <a name = "ModifierKeys"></a>

  347.     <strong><span class="proto_prefix">gui</span>.ModifierKeys</strong>

  348.     </dt>

  349.     <dd>

  350.     Keyboard and mouse modifiers.

  351.  Contained in every <a href="../modules/gui.html#gui.MouseEvent">gui.MouseEvent</a> and received by the

  352.  <code>modifierKeysChanged</code> handler.

  353. 

  354.     </ul>

  355. 

  356.     <h3>Fields:</h3>

  357.     <ul>

  358.         <li><span class="parameter">noModifiers</span>

  359.         0

  360.         </li>

  361.         <li><span class="parameter">shiftModifier</span>

  362.         1

  363.         </li>

  364.         <li><span class="parameter">ctrlModifier</span>

  365.         2

  366.         </li>

  367.         <li><span class="parameter">altModifier</span>

  368.         4

  369.         </li>

  370.         <li><span class="parameter">leftButtonModifier</span>

  371.         16

  372.         </li>

  373.         <li><span class="parameter">rightButtonModifier</span>

  374.         32

  375.         </li>

  376.         <li><span class="parameter">middleButtonModifier</span>

  377.         64

  378.         </li>

  379.         <li><span class="parameter">commandModifier</span>

  380.         8

  381.         </li>

  382.         <li><span class="parameter">ctrlAltCommandModifiers</span>

  383.         14

  384.         </li>

  385.     </ul>

  386. 

  387. 

  388. 

  389. 

  390. 

  391. </dd>

  392. </dl>

  393.     <h2><a name="Class_gui_MouseEvent"></a>Class gui.MouseEvent </h2>

  394. 

  395.  A mouse event as received by GUI handlers (see <a href="../modules/gui.html#addHandler">gui.addHandler</a>)

  396.  <br><br>

  397.     <dl class="function">

  398.     <dt>

  399.     <a name = "MouseEvent.x"></a>

  400.     <strong><span class="proto_prefix">gui.MouseEvent</span>.x</strong>

  401.     </dt>

  402.     <dd>

  403.     X.

  404. 

  405.     </ul>

  406. 

  407. 

  408. 

  409. 

  410. 

  411. 

  412. </dd>

  413.     <dt>

  414.     <a name = "MouseEvent.y"></a>

  415.     <strong><span class="proto_prefix">gui.MouseEvent</span>.y</strong>

  416.     </dt>

  417.     <dd>

  418.     Y.

  419. 

  420.     </ul>

  421. 

  422. 

  423. 

  424. 

  425. 

  426. 

  427. </dd>

  428.     <dt>

  429.     <a name = "MouseEvent.mods"></a>

  430.     <strong><span class="proto_prefix">gui.MouseEvent</span>.mods</strong>

  431.     </dt>

  432.     <dd>

  433.     Modifier keys.

  434.  Values defined in <a href="../modules/gui.html#ModifierKeys">gui.ModifierKeys</a>

  435. 

  436.     </ul>

  437. 

  438. 

  439. 

  440. 

  441. 

  442. 

  443. </dd>

  444.     <dt>

  445.     <a name = "MouseEvent.eventComponent"></a>

  446.     <strong><span class="proto_prefix">gui.MouseEvent</span>.eventComponent</strong>

  447.     </dt>

  448.     <dd>

  449.     Event component.

  450. 

  451.     </ul>

  452. 

  453. 

  454. 

  455. 

  456. 

  457. 

  458. </dd>

  459.     <dt>

  460.     <a name = "MouseEvent.originalComponent"></a>

  461.     <strong><span class="proto_prefix">gui.MouseEvent</span>.originalComponent</strong>

  462.     </dt>

  463.     <dd>

  464.     Original component.

  465. 

  466.     </ul>

  467. 

  468. 

  469. 

  470. 

  471. 

  472. 

  473. </dd>

  474.     <dt>

  475.     <a name = "MouseEvent.eventTime"></a>

  476.     <strong><span class="proto_prefix">gui.MouseEvent</span>.eventTime</strong>

  477.     </dt>

  478.     <dd>

  479.     Time.

  480. 

  481.     </ul>

  482. 

  483. 

  484. 

  485. 

  486. 

  487. 

  488. </dd>

  489.     <dt>

  490.     <a name = "MouseEvent.mouseDownTime"></a>

  491.     <strong><span class="proto_prefix">gui.MouseEvent</span>.mouseDownTime</strong>

  492.     </dt>

  493.     <dd>

  494.     Mouse down time.

  495. 

  496.     </ul>

  497. 

  498. 

  499. 

  500. 

  501. 

  502. 

  503. </dd>

  504.     <dt>

  505.     <a name = "MouseEvent.mouseDownPos"></a>

  506.     <strong><span class="proto_prefix">gui.MouseEvent</span>.mouseDownPos</strong>

  507.     </dt>

  508.     <dd>

  509.     Mouse down position.

  510. 

  511.     </ul>

  512. 

  513. 

  514. 

  515. 

  516. 

  517. 

  518. </dd>

  519.     <dt>

  520.     <a name = "MouseEvent.numberOfClicks"></a>

  521.     <strong><span class="proto_prefix">gui.MouseEvent</span>.numberOfClicks</strong>

  522.     </dt>

  523.     <dd>

  524.     Number of clicks.

  525. 

  526.     </ul>

  527. 

  528. 

  529. 

  530. 

  531. 

  532. 

  533. </dd>

  534.     <dt>

  535.     <a name = "MouseEvent.wasMovedSinceMouseDown"></a>

  536.     <strong><span class="proto_prefix">gui.MouseEvent</span>.wasMovedSinceMouseDown</strong>

  537.     </dt>

  538.     <dd>

  539.     Was moved since mouse down.

  540. 

  541.     </ul>

  542. 

  543. 

  544. 

  545. 

  546. 

  547. 

  548. </dd>

  549. </dl>

  550.     <h2><a name="Class_gui_MouseWheelDetails"></a>Class gui.MouseWheelDetails </h2>

  551. 

  552.  As received by the <code>mouseWheelMove</code> handler (see <a href="../modules/gui.html#addHandler">gui.addHandler</a>)

  553.  <br><br>

  554.     <dl class="function">

  555.     <dt>

  556.     <a name = "MouseWheelDetails.deltaX"></a>

  557.     <strong><span class="proto_prefix">gui.MouseWheelDetails</span>.deltaX</strong>

  558.     </dt>

  559.     <dd>

  560.     X delta.

  561. 

  562.     </ul>

  563. 

  564. 

  565. 

  566. 

  567. 

  568. 

  569. </dd>

  570.     <dt>

  571.     <a name = "MouseWheelDetails.deltaY"></a>

  572.     <strong><span class="proto_prefix">gui.MouseWheelDetails</span>.deltaY</strong>

  573.     </dt>

  574.     <dd>

  575.     Y delta.

  576. 

  577.     </ul>

  578. 

  579. 

  580. 

  581. 

  582. 

  583. 

  584. </dd>

  585.     <dt>

  586.     <a name = "MouseWheelDetails.isReversed"></a>

  587.     <strong><span class="proto_prefix">gui.MouseWheelDetails</span>.isReversed</strong>

  588.     </dt>

  589.     <dd>

  590.     Is reversed.

  591. 

  592.     </ul>

  593. 

  594. 

  595. 

  596. 

  597. 

  598. 

  599. </dd>

  600.     <dt>

  601.     <a name = "MouseWheelDetails.isSmooth"></a>

  602.     <strong><span class="proto_prefix">gui.MouseWheelDetails</span>.isSmooth</strong>

  603.     </dt>

  604.     <dd>

  605.     Is smooth.

  606. 

  607.     </ul>

  608. 

  609. 

  610. 

  611. 

  612. 

  613. 

  614. </dd>

  615. </dl>

  616.     <h2><a name="Class_gui_KeyPress"></a>Class gui.KeyPress </h2>

  617. 

  618.  As received by the <code>keyPressed</code> and <code>keyStateChanged</code> handlers (see <a href="../modules/gui.html#addHandler">gui.addHandler</a>)

  619.  <br><br>

  620.     <dl class="function">

  621.     <dt>

  622.     <a name = "KeyPress.keyCode"></a>

  623.     <strong><span class="proto_prefix">gui.KeyPress</span>.keyCode</strong>

  624.     </dt>

  625.     <dd>

  626.     Key code.

  627.  (undecipherable for now)

  628. 

  629.     </ul>

  630. 

  631. 

  632. 

  633. 

  634. 

  635. 

  636. </dd>

  637.     <dt>

  638.     <a name = "KeyPress.mods"></a>

  639.     <strong><span class="proto_prefix">gui.KeyPress</span>.mods</strong>

  640.     </dt>

  641.     <dd>

  642.     Modifier Keys.

  643. 

  644.     </ul>

  645. 

  646. 

  647. 

  648. 

  649. 

  650. 

  651. </dd>

  652.     <dt>

  653.     <a name = "KeyPress.textCharacter"></a>

  654.     <strong><span class="proto_prefix">gui.KeyPress</span>.textCharacter</strong>

  655.     </dt>

  656.     <dd>

  657.     Text character.

  658. 

  659.     </ul>

  660. 

  661. 

  662. 

  663. 

  664. 

  665. 

  666. </dd>

  667. </dl>

  668. 

  669. 

  670. </div> <!-- id="content" -->

  671. </div> <!-- id="main" -->

  672. <div id="about">

  673. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>

  674. </div> <!-- id="about" -->

  675. </div> <!-- id="container" -->

  676. </body>

  677. </html>