1 | <!DOCTYPE html>
|
---|
2 | <html>
|
---|
3 | <head>
|
---|
4 | <meta charset="UTF-8">
|
---|
5 | <title>KeyEvent</title>
|
---|
6 | <base target="class-frame">
|
---|
7 | <link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
|
---|
8 | <script src="../assets/js/paper.js"></script>
|
---|
9 | <script src="../assets/js/jquery.js"></script>
|
---|
10 | <script src="../assets/js/codemirror.js"></script>
|
---|
11 | <script src="../assets/js/docs.js"></script>
|
---|
12 | </head>
|
---|
13 | <body class="reference">
|
---|
14 | <div class="reference-class">
|
---|
15 | <h1>KeyEvent</h1>
|
---|
16 |
|
---|
17 | <p> Extends <b><a href="../classes/Event.html"><tt>Event</tt></a></b></p>
|
---|
18 |
|
---|
19 | <p>The KeyEvent object is received by the <a href="../classes/Tool.html"><tt>Tool</tt></a>'s keyboard
|
---|
20 | handlers <a href="../classes/Tool.html#onkeydown"><tt>tool.onKeyDown</tt></a>, <a href="../classes/Tool.html#onkeyup"><tt>tool.onKeyUp</tt></a>. The KeyEvent object is
|
---|
21 | the only parameter passed to these functions and contains information about
|
---|
22 | the keyboard event.</p>
|
---|
23 |
|
---|
24 | </div>
|
---|
25 |
|
---|
26 |
|
---|
27 |
|
---|
28 |
|
---|
29 |
|
---|
30 | <div class="reference-members"><h2>Properties</h2>
|
---|
31 |
|
---|
32 |
|
---|
33 | <div id="type" class="member">
|
---|
34 | <div class="member-link">
|
---|
35 | <a name="type" href="#type"><tt><b>type</b></tt></a>
|
---|
36 | </div>
|
---|
37 | <div class="member-description hidden">
|
---|
38 |
|
---|
39 | <div class="member-text">
|
---|
40 | <p>The type of key event.</p>
|
---|
41 |
|
---|
42 |
|
---|
43 | <ul><b>Type:</b>
|
---|
44 | <li>
|
---|
45 | <tt>String('keydown', 'keyup')</tt>
|
---|
46 | </li>
|
---|
47 | </ul>
|
---|
48 |
|
---|
49 |
|
---|
50 | </div>
|
---|
51 |
|
---|
52 | </div>
|
---|
53 | </div>
|
---|
54 |
|
---|
55 |
|
---|
56 | <div id="character" class="member">
|
---|
57 | <div class="member-link">
|
---|
58 | <a name="character" href="#character"><tt><b>character</b></tt></a>
|
---|
59 | </div>
|
---|
60 | <div class="member-description hidden">
|
---|
61 |
|
---|
62 | <div class="member-text">
|
---|
63 | <p>The string character of the key that caused this key event.</p>
|
---|
64 |
|
---|
65 |
|
---|
66 | <ul><b>Type:</b>
|
---|
67 | <li>
|
---|
68 | <tt>String</tt>
|
---|
69 | </li>
|
---|
70 | </ul>
|
---|
71 |
|
---|
72 |
|
---|
73 | </div>
|
---|
74 |
|
---|
75 | </div>
|
---|
76 | </div>
|
---|
77 |
|
---|
78 |
|
---|
79 | <div id="key" class="member">
|
---|
80 | <div class="member-link">
|
---|
81 | <a name="key" href="#key"><tt><b>key</b></tt></a>
|
---|
82 | </div>
|
---|
83 | <div class="member-description hidden">
|
---|
84 |
|
---|
85 | <div class="member-text">
|
---|
86 | <p>The key that caused this key event.</p>
|
---|
87 |
|
---|
88 |
|
---|
89 | <ul><b>Type:</b>
|
---|
90 | <li>
|
---|
91 | <tt>String</tt>
|
---|
92 | </li>
|
---|
93 | </ul>
|
---|
94 |
|
---|
95 |
|
---|
96 | </div>
|
---|
97 |
|
---|
98 | </div>
|
---|
99 | </div>
|
---|
100 |
|
---|
101 | </div>
|
---|
102 |
|
---|
103 |
|
---|
104 |
|
---|
105 | <!-- ============================== methods ================================ -->
|
---|
106 | <div class="reference-members"><h2>Methods</h2>
|
---|
107 |
|
---|
108 |
|
---|
109 | <div id="tostring" class="member">
|
---|
110 | <div class="member-link">
|
---|
111 | <a name="tostring" href="#tostring"><tt><b>toString</b>()</tt></a>
|
---|
112 | </div>
|
---|
113 | <div class="member-description hidden">
|
---|
114 | <div class="member-text">
|
---|
115 |
|
---|
116 |
|
---|
117 |
|
---|
118 | <ul><b>Returns:</b>
|
---|
119 |
|
---|
120 | <li>
|
---|
121 | <tt><tt>String</tt></tt> — a string representation of the key event
|
---|
122 | </li>
|
---|
123 |
|
---|
124 | </ul>
|
---|
125 |
|
---|
126 |
|
---|
127 |
|
---|
128 | </div>
|
---|
129 | </div>
|
---|
130 | </div>
|
---|
131 |
|
---|
132 | </div>
|
---|
133 |
|
---|
134 |
|
---|
135 |
|
---|
136 |
|
---|
137 | <!-- =========================== inherited properties ====================== -->
|
---|
138 | <div class="reference-members"><h2>Properties inherited from <a href="../classes/Event.html"><tt>Event</tt></a></h2>
|
---|
139 |
|
---|
140 |
|
---|
141 | <div id="modifiers" class="member">
|
---|
142 | <div class="member-link">
|
---|
143 | <a name="modifiers" href="#modifiers"><tt><b>modifiers</b></tt></a>
|
---|
144 | </div>
|
---|
145 | <div class="member-description hidden">
|
---|
146 |
|
---|
147 | <div class="member-text">
|
---|
148 |
|
---|
149 |
|
---|
150 | <p>Read only.</p>
|
---|
151 |
|
---|
152 |
|
---|
153 | <ul><b>Type:</b>
|
---|
154 | <li>
|
---|
155 | <tt>object</tt>
|
---|
156 | </li>
|
---|
157 | </ul>
|
---|
158 |
|
---|
159 |
|
---|
160 | </div>
|
---|
161 |
|
---|
162 | </div>
|
---|
163 | </div>
|
---|
164 |
|
---|
165 | </div>
|
---|
166 |
|
---|
167 |
|
---|
168 |
|
---|
169 |
|
---|
170 | <!-- =========================== copyright notice ========================= -->
|
---|
171 | <p class="footer">Copyright © 2011 <a href="http://www.lehni.org" target="_blank">Jürg Lehni</a> & <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
|
---|
172 | <div class="content-end"></div>
|
---|
173 |
|
---|
174 | </body> |
---|