1 | <!DOCTYPE html>
|
---|
2 | <html>
|
---|
3 | <head>
|
---|
4 | <meta charset="UTF-8">
|
---|
5 | <title>MouseEvent</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>MouseEvent</h1>
|
---|
16 |
|
---|
17 | <p> Extends <b><a href="../classes/Event.html"><tt>Event</tt></a></b></p>
|
---|
18 |
|
---|
19 | <p>The MouseEvent object is received by the <a href="../classes/Item.html"><tt>Item</tt></a>'s mouse event
|
---|
20 | handlers <a href="../classes/Item.html#onmousedown"><tt>item.onMouseDown</tt></a>, <tt>Item#onMouseDrag</tt>,
|
---|
21 | <a href="../classes/Item.html#onmousemove"><tt>item.onMouseMove</tt></a>, <a href="../classes/Item.html#onmouseup"><tt>item.onMouseUp</tt></a>, <a href="../classes/Item.html#onclick"><tt>item.onClick</tt></a>,
|
---|
22 | <a href="../classes/Item.html#ondoubleclick"><tt>item.onDoubleClick</tt></a>, <a href="../classes/Item.html#onmouseenter"><tt>item.onMouseEnter</tt></a> and
|
---|
23 | <a href="../classes/Item.html#onmouseleave"><tt>item.onMouseLeave</tt></a>. The MouseEvent object is the only parameter passed
|
---|
24 | to these functions and contains information about the mouse event.</p>
|
---|
25 |
|
---|
26 | </div>
|
---|
27 |
|
---|
28 |
|
---|
29 |
|
---|
30 |
|
---|
31 |
|
---|
32 | <div class="reference-members"><h2>Properties</h2>
|
---|
33 |
|
---|
34 |
|
---|
35 | <div id="type" class="member">
|
---|
36 | <div class="member-link">
|
---|
37 | <a name="type" href="#type"><tt><b>type</b></tt></a>
|
---|
38 | </div>
|
---|
39 | <div class="member-description hidden">
|
---|
40 |
|
---|
41 | <div class="member-text">
|
---|
42 | <p>The type of mouse event.</p>
|
---|
43 |
|
---|
44 |
|
---|
45 | <ul><b>Type:</b>
|
---|
46 | <li>
|
---|
47 | <tt>String('mousedown', 'mouseup', 'mousedrag', 'click',
|
---|
48 | 'doubleclick', 'mousemove', 'mouseenter', 'mouseleave')</tt>
|
---|
49 | </li>
|
---|
50 | </ul>
|
---|
51 |
|
---|
52 |
|
---|
53 | </div>
|
---|
54 |
|
---|
55 | </div>
|
---|
56 | </div>
|
---|
57 |
|
---|
58 |
|
---|
59 | <div id="point" class="member">
|
---|
60 | <div class="member-link">
|
---|
61 | <a name="point" href="#point"><tt><b>point</b></tt></a>
|
---|
62 | </div>
|
---|
63 | <div class="member-description hidden">
|
---|
64 |
|
---|
65 | <div class="member-text">
|
---|
66 | <p>The position of the mouse in project coordinates when the event was
|
---|
67 | fired.</p>
|
---|
68 |
|
---|
69 |
|
---|
70 | <ul><b>Type:</b>
|
---|
71 | <li>
|
---|
72 | <a href="../classes/Point.html"><tt>Point</tt></a>
|
---|
73 | </li>
|
---|
74 | </ul>
|
---|
75 |
|
---|
76 |
|
---|
77 | </div>
|
---|
78 |
|
---|
79 | </div>
|
---|
80 | </div>
|
---|
81 |
|
---|
82 |
|
---|
83 | <div id="target" class="member">
|
---|
84 | <div class="member-link">
|
---|
85 | <a name="target" href="#target"><tt><b>target</b></tt></a>
|
---|
86 | </div>
|
---|
87 | <div class="member-description hidden">
|
---|
88 |
|
---|
89 | <div class="member-text">
|
---|
90 |
|
---|
91 |
|
---|
92 |
|
---|
93 | <ul><b>Type:</b>
|
---|
94 | <li>
|
---|
95 | <a href="../classes/Item.html"><tt>Item</tt></a>
|
---|
96 | </li>
|
---|
97 | </ul>
|
---|
98 |
|
---|
99 |
|
---|
100 | </div>
|
---|
101 |
|
---|
102 | </div>
|
---|
103 | </div>
|
---|
104 |
|
---|
105 |
|
---|
106 | <div id="delta" class="member">
|
---|
107 | <div class="member-link">
|
---|
108 | <a name="delta" href="#delta"><tt><b>delta</b></tt></a>
|
---|
109 | </div>
|
---|
110 | <div class="member-description hidden">
|
---|
111 |
|
---|
112 | <div class="member-text">
|
---|
113 |
|
---|
114 |
|
---|
115 |
|
---|
116 | <ul><b>Type:</b>
|
---|
117 | <li>
|
---|
118 | <a href="../classes/Point.html"><tt>Point</tt></a>
|
---|
119 | </li>
|
---|
120 | </ul>
|
---|
121 |
|
---|
122 |
|
---|
123 | </div>
|
---|
124 |
|
---|
125 | </div>
|
---|
126 | </div>
|
---|
127 |
|
---|
128 | </div>
|
---|
129 |
|
---|
130 |
|
---|
131 |
|
---|
132 | <!-- ============================== methods ================================ -->
|
---|
133 | <div class="reference-members"><h2>Methods</h2>
|
---|
134 |
|
---|
135 |
|
---|
136 | <div id="tostring" class="member">
|
---|
137 | <div class="member-link">
|
---|
138 | <a name="tostring" href="#tostring"><tt><b>toString</b>()</tt></a>
|
---|
139 | </div>
|
---|
140 | <div class="member-description hidden">
|
---|
141 | <div class="member-text">
|
---|
142 |
|
---|
143 |
|
---|
144 |
|
---|
145 | <ul><b>Returns:</b>
|
---|
146 |
|
---|
147 | <li>
|
---|
148 | <tt><tt>String</tt></tt> — a string representation of the mouse event
|
---|
149 | </li>
|
---|
150 |
|
---|
151 | </ul>
|
---|
152 |
|
---|
153 |
|
---|
154 |
|
---|
155 | </div>
|
---|
156 | </div>
|
---|
157 | </div>
|
---|
158 |
|
---|
159 | </div>
|
---|
160 |
|
---|
161 |
|
---|
162 |
|
---|
163 |
|
---|
164 | <!-- =========================== inherited properties ====================== -->
|
---|
165 | <div class="reference-members"><h2>Properties inherited from <a href="../classes/Event.html"><tt>Event</tt></a></h2>
|
---|
166 |
|
---|
167 |
|
---|
168 | <div id="modifiers" class="member">
|
---|
169 | <div class="member-link">
|
---|
170 | <a name="modifiers" href="#modifiers"><tt><b>modifiers</b></tt></a>
|
---|
171 | </div>
|
---|
172 | <div class="member-description hidden">
|
---|
173 |
|
---|
174 | <div class="member-text">
|
---|
175 |
|
---|
176 |
|
---|
177 | <p>Read only.</p>
|
---|
178 |
|
---|
179 |
|
---|
180 | <ul><b>Type:</b>
|
---|
181 | <li>
|
---|
182 | <tt>object</tt>
|
---|
183 | </li>
|
---|
184 | </ul>
|
---|
185 |
|
---|
186 |
|
---|
187 | </div>
|
---|
188 |
|
---|
189 | </div>
|
---|
190 | </div>
|
---|
191 |
|
---|
192 | </div>
|
---|
193 |
|
---|
194 |
|
---|
195 |
|
---|
196 |
|
---|
197 | <!-- =========================== copyright notice ========================= -->
|
---|
198 | <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>
|
---|
199 | <div class="content-end"></div>
|
---|
200 |
|
---|
201 | </body> |
---|