-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
55 changed files
with
30,534 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,361 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>JSDoc: Class: Key</title> | ||
|
||
<script src="scripts/prettify/prettify.js"> </script> | ||
<script src="scripts/prettify/lang-css.js"> </script> | ||
<!--[if lt IE 9]> | ||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> | ||
<![endif]--> | ||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> | ||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> | ||
</head> | ||
|
||
<body> | ||
|
||
<div id="main"> | ||
|
||
<h1 class="page-title">Class: Key</h1> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<section> | ||
|
||
<header> | ||
|
||
<h2>Key</h2> | ||
|
||
<div class="class-description"><p>An abstraction around a KeyEvent | ||
that key listeners in the editor can use | ||
to determine what sort of key was pressed</p></div> | ||
|
||
|
||
</header> | ||
|
||
<article> | ||
<div class="container-overview"> | ||
|
||
|
||
|
||
|
||
<h2>Constructor</h2> | ||
|
||
|
||
<h4 class="name" id="Key"><span class="type-signature"></span>new Key<span class="signature">()</span><span class="type-signature"></span></h4> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="details"> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dt class="tag-source">Source:</dt> | ||
<dd class="tag-source"><ul class="dummy"><li> | ||
<a href="utils_key.js.html">utils/key.js</a>, <a href="utils_key.js.html#line66">line 66</a> | ||
</li></ul></dd> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3 class="subsection-title">Methods</h3> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="name" id="isPrintable"><span class="type-signature"></span>isPrintable<span class="signature">()</span><span class="type-signature"></span></h4> | ||
|
||
|
||
|
||
|
||
|
||
<div class="description"> | ||
<p>See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode#Printable_keys_in_standard_position | ||
and http://stackoverflow.com/a/12467610/137784</p> | ||
</div> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="details"> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dt class="tag-source">Source:</dt> | ||
<dd class="tag-source"><ul class="dummy"><li> | ||
<a href="utils_key.js.html">utils/key.js</a>, <a href="utils_key.js.html#line194">line 194</a> | ||
</li></ul></dd> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="name" id="isShift"><span class="type-signature"></span>isShift<span class="signature">()</span><span class="type-signature"> → {bool}</span></h4> | ||
|
||
|
||
|
||
|
||
|
||
<div class="description"> | ||
<p>If the shift key is depressed. | ||
For example, while holding down meta+shift, pressing the "v" | ||
key would result in an event whose <code>Key</code> had <code>isShift()</code> with a truthy value, | ||
because the shift key is down when pressing the "v".</p> | ||
</div> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="details"> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dt class="tag-source">Source:</dt> | ||
<dd class="tag-source"><ul class="dummy"><li> | ||
<a href="utils_key.js.html">utils/key.js</a>, <a href="utils_key.js.html#line152">line 152</a> | ||
</li></ul></dd> | ||
|
||
|
||
|
||
|
||
|
||
<dt class="tag-see">See:</dt> | ||
<dd class="tag-see"> | ||
<ul> | ||
<li>{isShiftKey} which checks if the key is actually the shift key itself.</li> | ||
</ul> | ||
</dd> | ||
|
||
|
||
|
||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h5>Returns:</h5> | ||
|
||
|
||
|
||
|
||
<dl> | ||
<dt> | ||
Type | ||
</dt> | ||
<dd> | ||
|
||
<span class="param-type">bool</span> | ||
|
||
|
||
</dd> | ||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article> | ||
|
||
</section> | ||
|
||
|
||
|
||
|
||
</div> | ||
|
||
<nav> | ||
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Editor.html">Editor</a></li><li><a href="Key.html">Key</a></li><li><a href="Position.html">Position</a></li><li><a href="Post.html">Post</a></li><li><a href="PostEditor.html">PostEditor</a></li><li><a href="PostNodeBuilder.html">PostNodeBuilder</a></li><li><a href="Range.html">Range</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Direction">Direction</a></li></ul> | ||
</nav> | ||
|
||
<br class="clear"> | ||
|
||
<footer> | ||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 14 2016 18:00:34 GMT-0400 (EDT) | ||
</footer> | ||
|
||
<script> prettyPrint(); </script> | ||
<script src="scripts/linenumber.js"> </script> | ||
</body> | ||
</html> |
Oops, something went wrong.