1 | <!DOCTYPE html>
|
2 |
|
3 | <html lang="en">
|
4 | <head>
|
5 | <meta charset="utf-8">
|
6 | <meta name="viewport" content="width=device-width">
|
7 | <title>CrossBrowdy API documentation Namespace: CursorImage</title>
|
8 |
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
13 |
|
14 | <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
15 |
|
16 | </head>
|
17 |
|
18 | <body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
19 |
|
20 | <div class="navbar navbar-default navbar-fixed-top ">
|
21 | <div class="container">
|
22 | <div class="navbar-header">
|
23 | <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
|
24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
25 | <span class="icon-bar"></span>
|
26 | <span class="icon-bar"></span>
|
27 | <span class="icon-bar"></span>
|
28 | </button>
|
29 | </div>
|
30 | <div class="navbar-collapse collapse" id="topNavigation">
|
31 | <ul class="nav navbar-nav">
|
32 |
|
33 | <li class="dropdown">
|
34 | <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
|
35 | <ul class="dropdown-menu inline">
|
36 | <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li>
|
37 | </ul>
|
38 | </li>
|
39 |
|
40 | <li class="dropdown">
|
41 | <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
42 | <ul class="dropdown-menu inline">
|
43 | <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
|
44 | </ul>
|
45 | </li>
|
46 |
|
47 | <li class="dropdown">
|
48 | <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
49 | <ul class="dropdown-menu inline">
|
50 | <li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li>
|
51 | </ul>
|
52 | </li>
|
53 |
|
54 | </ul>
|
55 |
|
56 | <div class="col-sm-3 col-md-3">
|
57 | <form class="navbar-form" role="search">
|
58 | <div class="input-group">
|
59 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
60 | <div class="input-group-btn">
|
61 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
62 | </div>
|
63 | </div>
|
64 | </form>
|
65 | </div>
|
66 |
|
67 | </div>
|
68 |
|
69 | </div>
|
70 | </div>
|
71 |
|
72 |
|
73 | <div class="container" id="toc-content" style="width:100%;">
|
74 | <div class="row" style="width:100%;">
|
75 |
|
76 |
|
77 | <div class="col-md-8" style="width:85%;">
|
78 |
|
79 | <div id="main">
|
80 |
|
81 |
|
82 |
|
83 | <h1 class="page-title">Namespace: CursorImage</h1>
|
84 |
|
85 | <section>
|
86 |
|
87 | <header>
|
88 |
|
89 | <h2>
|
90 | <span class="ancestors"><a href="CB_Mouse.html">CB_Mouse</a>.</span>
|
91 |
|
92 | CursorImage
|
93 | </h2>
|
94 |
|
95 |
|
96 | </header>
|
97 |
|
98 |
|
99 | <article>
|
100 | <div class="container-overview">
|
101 |
|
102 |
|
103 | <div class="description"><p>Property that keeps an object to manage the mouse cursor using a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> containing an image for clients that do not support changing the cursor image by CSS.<br> <br /><br> Caution: Performance could be dramatically decreased while using this workaround.</p></div>
|
104 |
|
105 |
|
106 |
|
107 | <dl class="details">
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
138 | <dd class="tag-source">
|
139 | <ul class="dummy">
|
140 | <li>
|
141 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
142 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-28">line 28</a>
|
143 | </li>
|
144 | </ul>
|
145 | </dd>
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 | </dl>
|
154 |
|
155 |
|
156 |
|
157 |
|
158 | </div>
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 | <h3 class="subsection-title">Methods</h3>
|
174 |
|
175 | <dl>
|
176 |
|
177 | <hr>
|
178 | <dt>
|
179 | <h4 class="name" id=".get"><span class="type-signature"><static> </span>get<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4>
|
180 |
|
181 |
|
182 | </dt>
|
183 | <dd>
|
184 |
|
185 |
|
186 | <div class="description">
|
187 | <p>Gets the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div">DIV element</a> that contains the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img">IMG element</a> of the fake cursor (if any).</p>
|
188 | </div>
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 | <dl class="details">
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
230 | <dd class="tag-source">
|
231 | <ul class="dummy">
|
232 | <li>
|
233 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
234 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1191">line 1191</a>
|
235 | </li>
|
236 | </ul>
|
237 | </dd>
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 | </dl>
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 | <h5>Returns:</h5>
|
260 |
|
261 |
|
262 | <div class="param-desc">
|
263 | <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div">DIV element</a> that contains the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img">IMG element</a> of the fake cursor (if any).</p>
|
264 | </div>
|
265 |
|
266 |
|
267 |
|
268 | <dl>
|
269 | <dt>
|
270 | Type
|
271 | </dt>
|
272 | <dd>
|
273 |
|
274 | <span class="param-type">Element</span>
|
275 |
|
276 |
|
277 |
|
278 | </dd>
|
279 | </dl>
|
280 |
|
281 |
|
282 |
|
283 |
|
284 |
|
285 | </dd>
|
286 |
|
287 |
|
288 |
|
289 | <hr>
|
290 | <dt>
|
291 | <h4 class="name" id=".getImage"><span class="type-signature"><static> </span>getImage<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4>
|
292 |
|
293 |
|
294 | </dt>
|
295 | <dd>
|
296 |
|
297 |
|
298 | <div class="description">
|
299 | <p>Gets the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img">IMG element</a> of the fake cursor (if any).</p>
|
300 | </div>
|
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 |
|
307 |
|
308 |
|
309 |
|
310 |
|
311 | <dl class="details">
|
312 |
|
313 |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 |
|
326 |
|
327 |
|
328 |
|
329 |
|
330 |
|
331 |
|
332 |
|
333 |
|
334 |
|
335 |
|
336 |
|
337 |
|
338 |
|
339 |
|
340 |
|
341 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
342 | <dd class="tag-source">
|
343 | <ul class="dummy">
|
344 | <li>
|
345 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
346 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1202">line 1202</a>
|
347 | </li>
|
348 | </ul>
|
349 | </dd>
|
350 |
|
351 |
|
352 |
|
353 |
|
354 |
|
355 |
|
356 |
|
357 | </dl>
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 |
|
364 |
|
365 |
|
366 |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 | <h5>Returns:</h5>
|
372 |
|
373 |
|
374 | <div class="param-desc">
|
375 | <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img">IMG element</a> of the fake cursor (if any).</p>
|
376 | </div>
|
377 |
|
378 |
|
379 |
|
380 | <dl>
|
381 | <dt>
|
382 | Type
|
383 | </dt>
|
384 | <dd>
|
385 |
|
386 | <span class="param-type">Element</span>
|
387 |
|
388 |
|
389 |
|
390 | </dd>
|
391 | </dl>
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 | </dd>
|
398 |
|
399 |
|
400 |
|
401 | <hr>
|
402 | <dt>
|
403 | <h4 class="name" id=".hide"><span class="type-signature"><static> </span>hide<span class="signature">( [showNormalCursor])</span><span class="type-signature"></span></h4>
|
404 |
|
405 |
|
406 | </dt>
|
407 | <dd>
|
408 |
|
409 |
|
410 | <div class="description">
|
411 | <p>Hides the fake cursor image.</p>
|
412 | </div>
|
413 |
|
414 |
|
415 |
|
416 |
|
417 |
|
418 |
|
419 |
|
420 |
|
421 | <h5>Parameters:</h5>
|
422 |
|
423 |
|
424 | <table class="params table table-striped">
|
425 | <thead>
|
426 | <tr>
|
427 |
|
428 | <th style="width:12%; min-width:110px;">Name</th>
|
429 |
|
430 |
|
431 | <th style="width:12%; min-width:110px;">Type</th>
|
432 |
|
433 |
|
434 | <th style="width:12%; min-width:110px;">Argument</th>
|
435 |
|
436 |
|
437 |
|
438 | <th style="width:12%; min-width:110px;">Default</th>
|
439 |
|
440 |
|
441 | <th class="last" style="min-width:310px;">Description</th>
|
442 | </tr>
|
443 | </thead>
|
444 |
|
445 | <tbody>
|
446 |
|
447 |
|
448 | <tr>
|
449 |
|
450 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>showNormalCursor</code></td>
|
451 |
|
452 |
|
453 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
454 |
|
455 |
|
456 | <span class="param-type">boolean</span>
|
457 |
|
458 |
|
459 |
|
460 |
|
461 | </td>
|
462 |
|
463 |
|
464 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
465 |
|
466 | <optional><br>
|
467 |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 | </td>
|
473 |
|
474 |
|
475 |
|
476 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
477 |
|
478 | true
|
479 |
|
480 | </td>
|
481 |
|
482 |
|
483 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, restores (shows) the system cursor (calls the <a href="CB_Mouse.html#.restore"><code>CB_Mouse.restore</code></a> function internally).</p></td>
|
484 | </tr>
|
485 |
|
486 |
|
487 | </tbody>
|
488 | </table>
|
489 |
|
490 |
|
491 |
|
492 |
|
493 | <dl class="details">
|
494 |
|
495 |
|
496 |
|
497 |
|
498 |
|
499 |
|
500 |
|
501 |
|
502 |
|
503 |
|
504 |
|
505 |
|
506 |
|
507 |
|
508 |
|
509 |
|
510 |
|
511 |
|
512 |
|
513 |
|
514 |
|
515 |
|
516 |
|
517 |
|
518 |
|
519 |
|
520 |
|
521 |
|
522 |
|
523 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
524 | <dd class="tag-source">
|
525 | <ul class="dummy">
|
526 | <li>
|
527 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
528 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1224">line 1224</a>
|
529 | </li>
|
530 | </ul>
|
531 | </dd>
|
532 |
|
533 |
|
534 |
|
535 |
|
536 |
|
537 |
|
538 |
|
539 | </dl>
|
540 |
|
541 |
|
542 |
|
543 |
|
544 |
|
545 |
|
546 |
|
547 |
|
548 |
|
549 |
|
550 |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 | </dd>
|
556 |
|
557 |
|
558 |
|
559 | <hr>
|
560 | <dt>
|
561 | <h4 class="name" id=".isShowing"><span class="type-signature"><static> </span>isShowing<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
562 |
|
563 |
|
564 | </dt>
|
565 | <dd>
|
566 |
|
567 |
|
568 | <div class="description">
|
569 | <p>Tells whether the fake cursor is showing or not</p>
|
570 | </div>
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 |
|
577 |
|
578 |
|
579 |
|
580 |
|
581 | <dl class="details">
|
582 |
|
583 |
|
584 |
|
585 |
|
586 |
|
587 |
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 |
|
602 |
|
603 |
|
604 |
|
605 |
|
606 |
|
607 |
|
608 |
|
609 |
|
610 |
|
611 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
612 | <dd class="tag-source">
|
613 | <ul class="dummy">
|
614 | <li>
|
615 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
616 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1213">line 1213</a>
|
617 | </li>
|
618 | </ul>
|
619 | </dd>
|
620 |
|
621 |
|
622 |
|
623 |
|
624 |
|
625 |
|
626 |
|
627 | </dl>
|
628 |
|
629 |
|
630 |
|
631 |
|
632 |
|
633 |
|
634 |
|
635 |
|
636 |
|
637 |
|
638 |
|
639 |
|
640 |
|
641 | <h5>Returns:</h5>
|
642 |
|
643 |
|
644 | <div class="param-desc">
|
645 | <p>Returns whether the fake cursor is showing or not.</p>
|
646 | </div>
|
647 |
|
648 |
|
649 |
|
650 | <dl>
|
651 | <dt>
|
652 | Type
|
653 | </dt>
|
654 | <dd>
|
655 |
|
656 | <span class="param-type">boolean</span>
|
657 |
|
658 |
|
659 |
|
660 | </dd>
|
661 | </dl>
|
662 |
|
663 |
|
664 |
|
665 |
|
666 |
|
667 | </dd>
|
668 |
|
669 |
|
670 |
|
671 | <hr>
|
672 | <dt>
|
673 | <h4 class="name" id=".move"><span class="type-signature"><static> </span>move<span class="signature">( [x] [, y])</span><span class="type-signature"></span></h4>
|
674 |
|
675 |
|
676 | </dt>
|
677 | <dd>
|
678 |
|
679 |
|
680 | <div class="description">
|
681 | <p>Moves the fake cursor image (if it is not hidden). Automatically called when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mousemove_event">onMouseMove</a> event is fired.</p>
|
682 | </div>
|
683 |
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 |
|
690 |
|
691 | <h5>Parameters:</h5>
|
692 |
|
693 |
|
694 | <table class="params table table-striped">
|
695 | <thead>
|
696 | <tr>
|
697 |
|
698 | <th style="width:12%; min-width:110px;">Name</th>
|
699 |
|
700 |
|
701 | <th style="width:12%; min-width:110px;">Type</th>
|
702 |
|
703 |
|
704 | <th style="width:12%; min-width:110px;">Argument</th>
|
705 |
|
706 |
|
707 |
|
708 | <th style="width:12%; min-width:110px;">Default</th>
|
709 |
|
710 |
|
711 | <th class="last" style="min-width:310px;">Description</th>
|
712 | </tr>
|
713 | </thead>
|
714 |
|
715 | <tbody>
|
716 |
|
717 |
|
718 | <tr>
|
719 |
|
720 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>x</code></td>
|
721 |
|
722 |
|
723 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
724 |
|
725 |
|
726 | <span class="param-type">number</span>
|
727 |
|
728 |
|
729 |
|
730 |
|
731 | </td>
|
732 |
|
733 |
|
734 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
735 |
|
736 | <optional><br>
|
737 |
|
738 |
|
739 |
|
740 |
|
741 |
|
742 | </td>
|
743 |
|
744 |
|
745 |
|
746 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
747 |
|
748 | CB_Mouse.getX(null, false)
|
749 |
|
750 | </td>
|
751 |
|
752 |
|
753 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The X coordinate (horizontal position) in pixels where the fake cursor image wants to be moved to. If not provided, it will use the value returned by calling CB_Mouse.getX(null, false) internally.</p></td>
|
754 | </tr>
|
755 |
|
756 |
|
757 |
|
758 | <tr>
|
759 |
|
760 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>y</code></td>
|
761 |
|
762 |
|
763 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
764 |
|
765 |
|
766 | <span class="param-type">number</span>
|
767 |
|
768 |
|
769 |
|
770 |
|
771 | </td>
|
772 |
|
773 |
|
774 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
775 |
|
776 | <optional><br>
|
777 |
|
778 |
|
779 |
|
780 |
|
781 |
|
782 | </td>
|
783 |
|
784 |
|
785 |
|
786 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
787 |
|
788 | CB_Mouse.getY(null, false)
|
789 |
|
790 | </td>
|
791 |
|
792 |
|
793 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The Y coordinate (vertical position) in pixels where the fake cursor image wants to be moved to. If not provided, it will use the value returned by calling CB_Mouse.getY(null, false) internally.</p></td>
|
794 | </tr>
|
795 |
|
796 |
|
797 | </tbody>
|
798 | </table>
|
799 |
|
800 |
|
801 |
|
802 |
|
803 | <dl class="details">
|
804 |
|
805 |
|
806 |
|
807 |
|
808 |
|
809 |
|
810 |
|
811 |
|
812 |
|
813 |
|
814 |
|
815 |
|
816 |
|
817 |
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 |
|
827 |
|
828 |
|
829 |
|
830 |
|
831 |
|
832 |
|
833 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
834 | <dd class="tag-source">
|
835 | <ul class="dummy">
|
836 | <li>
|
837 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
838 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1243">line 1243</a>
|
839 | </li>
|
840 | </ul>
|
841 | </dd>
|
842 |
|
843 |
|
844 |
|
845 |
|
846 |
|
847 |
|
848 |
|
849 | </dl>
|
850 |
|
851 |
|
852 |
|
853 |
|
854 |
|
855 |
|
856 |
|
857 |
|
858 |
|
859 |
|
860 |
|
861 |
|
862 |
|
863 |
|
864 |
|
865 | </dd>
|
866 |
|
867 |
|
868 |
|
869 | <hr>
|
870 | <dt>
|
871 | <h4 class="name" id=".set"><span class="type-signature"><static> </span>set<span class="signature">( [showCursorImage] [, cursorImage] [, cursorImageWidth] [, cursorImageHeight] [, hideNormalCursor] [, isSprite] [, numberOfFrames] [, framesMs] [, divElement] [, imageElement])</span><span class="type-signature"></span></h4>
|
872 |
|
873 |
|
874 | </dt>
|
875 | <dd>
|
876 |
|
877 |
|
878 | <div class="description">
|
879 | <p>Uses an <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img">IMG element</a> inside a <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div">DIV element</a> (fakes the cursor) to simulate the mouse cursor (following its movements). If it was already called before and a fake cursor is already being used, the <a href="CB_Mouse.CursorImage.html#.hide"><code>CB_Mouse.CursorImage.hide</code></a> function must be called before in order to start using a different fake cursor image.<br> <br /><br> Caution: Performance could be dramatically decreased while using this workaround.</p>
|
880 | </div>
|
881 |
|
882 |
|
883 |
|
884 |
|
885 |
|
886 |
|
887 |
|
888 |
|
889 | <h5>Parameters:</h5>
|
890 |
|
891 |
|
892 | <table class="params table table-striped">
|
893 | <thead>
|
894 | <tr>
|
895 |
|
896 | <th style="width:12%; min-width:110px;">Name</th>
|
897 |
|
898 |
|
899 | <th style="width:12%; min-width:110px;">Type</th>
|
900 |
|
901 |
|
902 | <th style="width:12%; min-width:110px;">Argument</th>
|
903 |
|
904 |
|
905 |
|
906 | <th style="width:12%; min-width:110px;">Default</th>
|
907 |
|
908 |
|
909 | <th class="last" style="min-width:310px;">Description</th>
|
910 | </tr>
|
911 | </thead>
|
912 |
|
913 | <tbody>
|
914 |
|
915 |
|
916 | <tr>
|
917 |
|
918 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>showCursorImage</code></td>
|
919 |
|
920 |
|
921 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
922 |
|
923 |
|
924 | <span class="param-type">boolean</span>
|
925 |
|
926 |
|
927 |
|
928 |
|
929 | </td>
|
930 |
|
931 |
|
932 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
933 |
|
934 | <optional><br>
|
935 |
|
936 |
|
937 |
|
938 |
|
939 |
|
940 | </td>
|
941 |
|
942 |
|
943 |
|
944 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
945 |
|
946 | true
|
947 |
|
948 | </td>
|
949 |
|
950 |
|
951 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true and a valid cursor image is given, the fake cursor functionality will be used. Otherwise, the fake cursor will stop being used.</p></td>
|
952 | </tr>
|
953 |
|
954 |
|
955 |
|
956 | <tr>
|
957 |
|
958 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>cursorImage</code></td>
|
959 |
|
960 |
|
961 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
962 |
|
963 |
|
964 | <span class="param-type">string</span>
|
965 |
|
966 |
|
967 |
|
968 |
|
969 | </td>
|
970 |
|
971 |
|
972 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
973 |
|
974 | <optional><br>
|
975 |
|
976 |
|
977 |
|
978 |
|
979 |
|
980 | </td>
|
981 |
|
982 |
|
983 |
|
984 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
985 |
|
986 | </td>
|
987 |
|
988 |
|
989 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If a valid image path is given and "showCursorImage" is set to true, the fake cursor functionality will be used with the given image. Otherwise, the fake cursor will stop being used.</p></td>
|
990 | </tr>
|
991 |
|
992 |
|
993 |
|
994 | <tr>
|
995 |
|
996 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>cursorImageWidth</code></td>
|
997 |
|
998 |
|
999 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1000 |
|
1001 |
|
1002 | <span class="param-type">number</span>
|
1003 |
|
1004 |
|
1005 |
|
1006 |
|
1007 | </td>
|
1008 |
|
1009 |
|
1010 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1011 |
|
1012 | <optional><br>
|
1013 |
|
1014 |
|
1015 |
|
1016 |
|
1017 |
|
1018 | </td>
|
1019 |
|
1020 |
|
1021 |
|
1022 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1023 |
|
1024 | 32
|
1025 |
|
1026 | </td>
|
1027 |
|
1028 |
|
1029 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Width in pixels of the cursor image.</p></td>
|
1030 | </tr>
|
1031 |
|
1032 |
|
1033 |
|
1034 | <tr>
|
1035 |
|
1036 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>cursorImageHeight</code></td>
|
1037 |
|
1038 |
|
1039 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1040 |
|
1041 |
|
1042 | <span class="param-type">number</span>
|
1043 |
|
1044 |
|
1045 |
|
1046 |
|
1047 | </td>
|
1048 |
|
1049 |
|
1050 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1051 |
|
1052 | <optional><br>
|
1053 |
|
1054 |
|
1055 |
|
1056 |
|
1057 |
|
1058 | </td>
|
1059 |
|
1060 |
|
1061 |
|
1062 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1063 |
|
1064 | 32
|
1065 |
|
1066 | </td>
|
1067 |
|
1068 |
|
1069 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Height in pixels of the cursor image.</p></td>
|
1070 | </tr>
|
1071 |
|
1072 |
|
1073 |
|
1074 | <tr>
|
1075 |
|
1076 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>hideNormalCursor</code></td>
|
1077 |
|
1078 |
|
1079 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1080 |
|
1081 |
|
1082 | <span class="param-type">boolean</span>
|
1083 |
|
1084 |
|
1085 |
|
1086 |
|
1087 | </td>
|
1088 |
|
1089 |
|
1090 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1091 |
|
1092 | <optional><br>
|
1093 |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 | </td>
|
1099 |
|
1100 |
|
1101 |
|
1102 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1103 |
|
1104 | true
|
1105 |
|
1106 | </td>
|
1107 |
|
1108 |
|
1109 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, hides the system cursor (calls the <a href="CB_Mouse.html#.hide"><code>CB_Mouse.hide</code></a> function internally). Otherwise, shows the system cursor (calls the <a href="CB_Mouse.html#.restore"><code>CB_Mouse.restore</code></a> function internally).</p></td>
|
1110 | </tr>
|
1111 |
|
1112 |
|
1113 |
|
1114 | <tr>
|
1115 |
|
1116 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>isSprite</code></td>
|
1117 |
|
1118 |
|
1119 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1120 |
|
1121 |
|
1122 | <span class="param-type">boolean</span>
|
1123 |
|
1124 |
|
1125 |
|
1126 |
|
1127 | </td>
|
1128 |
|
1129 |
|
1130 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1131 |
|
1132 | <optional><br>
|
1133 |
|
1134 |
|
1135 |
|
1136 |
|
1137 |
|
1138 | </td>
|
1139 |
|
1140 |
|
1141 |
|
1142 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1143 |
|
1144 | false
|
1145 |
|
1146 | </td>
|
1147 |
|
1148 |
|
1149 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the cursor will be animated (using sprites) or not. If so, the cursorImage must be an image containing sprites horizontally (their individual width is defined by the "cursorImageWidth" parameter). Once the last sprite is reached, it returns to the first one automatically and continues to the next one again (without stopping).</p></td>
|
1150 | </tr>
|
1151 |
|
1152 |
|
1153 |
|
1154 | <tr>
|
1155 |
|
1156 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>numberOfFrames</code></td>
|
1157 |
|
1158 |
|
1159 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1160 |
|
1161 |
|
1162 | <span class="param-type">number</span>
|
1163 |
|
1164 |
|
1165 |
|
1166 |
|
1167 | </td>
|
1168 |
|
1169 |
|
1170 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1171 |
|
1172 | <optional><br>
|
1173 |
|
1174 |
|
1175 |
|
1176 |
|
1177 |
|
1178 | </td>
|
1179 |
|
1180 |
|
1181 |
|
1182 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1183 |
|
1184 | 1
|
1185 |
|
1186 | </td>
|
1187 |
|
1188 |
|
1189 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Number of frames (sprites) being used from the cursor image ("cursorImage" parameter). Used when the "isSprite" parameter is set to true.</p></td>
|
1190 | </tr>
|
1191 |
|
1192 |
|
1193 |
|
1194 | <tr>
|
1195 |
|
1196 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>framesMs</code></td>
|
1197 |
|
1198 |
|
1199 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1200 |
|
1201 |
|
1202 | <span class="param-type">number</span>
|
1203 |
|
1204 |
|
1205 |
|
1206 |
|
1207 | </td>
|
1208 |
|
1209 |
|
1210 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1211 |
|
1212 | <optional><br>
|
1213 |
|
1214 |
|
1215 |
|
1216 |
|
1217 |
|
1218 | </td>
|
1219 |
|
1220 |
|
1221 |
|
1222 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1223 |
|
1224 | 100
|
1225 |
|
1226 | </td>
|
1227 |
|
1228 |
|
1229 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Number of milliseconds between each frame (between one sprite and next one). Used when the "isSprite" parameter is set to true.</p></td>
|
1230 | </tr>
|
1231 |
|
1232 |
|
1233 |
|
1234 | <tr>
|
1235 |
|
1236 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>divElement</code></td>
|
1237 |
|
1238 |
|
1239 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1240 |
|
1241 |
|
1242 | <span class="param-type">Element</span>
|
1243 |
|
1244 |
|
1245 |
|
1246 |
|
1247 | </td>
|
1248 |
|
1249 |
|
1250 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1251 |
|
1252 | <optional><br>
|
1253 |
|
1254 |
|
1255 |
|
1256 |
|
1257 |
|
1258 | </td>
|
1259 |
|
1260 |
|
1261 |
|
1262 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1263 |
|
1264 | CB_Elements.id('CB_fakeCursorImageDiv')
|
1265 |
|
1266 | </td>
|
1267 |
|
1268 |
|
1269 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The ID of the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div">DIV element</a> that will contain the image of the fake cursor (uses a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> with "CB_fakeCursorImageDiv" ID by default).</p></td>
|
1270 | </tr>
|
1271 |
|
1272 |
|
1273 |
|
1274 | <tr>
|
1275 |
|
1276 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>imageElement</code></td>
|
1277 |
|
1278 |
|
1279 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1280 |
|
1281 |
|
1282 | <span class="param-type">Element</span>
|
1283 |
|
1284 |
|
1285 |
|
1286 |
|
1287 | </td>
|
1288 |
|
1289 |
|
1290 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1291 |
|
1292 | <optional><br>
|
1293 |
|
1294 |
|
1295 |
|
1296 |
|
1297 |
|
1298 | </td>
|
1299 |
|
1300 |
|
1301 |
|
1302 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
1303 |
|
1304 | CB_Elements.id('CB_fakeCursorImage')
|
1305 |
|
1306 | </td>
|
1307 |
|
1308 |
|
1309 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The ID of the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img">IMG element</a> that will contain the fake cursor (uses a <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement">DOM element</a> with "CB_fakeCursorImage" ID by default).</p></td>
|
1310 | </tr>
|
1311 |
|
1312 |
|
1313 | </tbody>
|
1314 | </table>
|
1315 |
|
1316 |
|
1317 |
|
1318 |
|
1319 | <dl class="details">
|
1320 |
|
1321 |
|
1322 |
|
1323 |
|
1324 |
|
1325 |
|
1326 |
|
1327 |
|
1328 |
|
1329 |
|
1330 |
|
1331 |
|
1332 |
|
1333 |
|
1334 |
|
1335 |
|
1336 |
|
1337 |
|
1338 |
|
1339 |
|
1340 |
|
1341 |
|
1342 |
|
1343 |
|
1344 |
|
1345 |
|
1346 |
|
1347 |
|
1348 |
|
1349 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1350 | <dd class="tag-source">
|
1351 | <ul class="dummy">
|
1352 | <li>
|
1353 | <a href="CrossBase_input_CB_Mouse.js.html">CrossBase/input/CB_Mouse.js</a>,
|
1354 | <a href="CrossBase_input_CB_Mouse.js.html#sunlight-1-line-1093">line 1093</a>
|
1355 | </li>
|
1356 | </ul>
|
1357 | </dd>
|
1358 |
|
1359 |
|
1360 |
|
1361 |
|
1362 |
|
1363 |
|
1364 |
|
1365 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
1366 | <dd class="tag-todo">
|
1367 | <ul>
|
1368 | <li>Allow defining an "onMove" parameter (a callback) to be able to call the "move" method with non-default parameters, etc.</li>
|
1369 | </ul>
|
1370 | </dd>
|
1371 |
|
1372 | </dl>
|
1373 |
|
1374 |
|
1375 |
|
1376 |
|
1377 |
|
1378 |
|
1379 |
|
1380 |
|
1381 |
|
1382 |
|
1383 |
|
1384 |
|
1385 |
|
1386 |
|
1387 |
|
1388 | </dd>
|
1389 |
|
1390 | </dl>
|
1391 |
|
1392 |
|
1393 |
|
1394 |
|
1395 |
|
1396 | </article>
|
1397 |
|
1398 | </section>
|
1399 |
|
1400 |
|
1401 |
|
1402 |
|
1403 | </div>
|
1404 | </div>
|
1405 |
|
1406 | <div class="clearfix"></div>
|
1407 |
|
1408 |
|
1409 | <div class="col-md-3">
|
1410 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
1411 | </div>
|
1412 |
|
1413 |
|
1414 | </div>
|
1415 | </div>
|
1416 |
|
1417 |
|
1418 | <div class="modal fade" id="searchResults">
|
1419 | <div class="modal-dialog">
|
1420 | <div class="modal-content">
|
1421 | <div class="modal-header">
|
1422 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
1423 | <h4 class="modal-title">Search results</h4>
|
1424 | </div>
|
1425 | <div class="modal-body"></div>
|
1426 | <div class="modal-footer">
|
1427 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
1428 | </div>
|
1429 | </div>
|
1430 | </div>
|
1431 | </div>
|
1432 |
|
1433 |
|
1434 | <footer>
|
1435 |
|
1436 |
|
1437 | <span class="copyright">
|
1438 | <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
|
1439 | </span>
|
1440 |
|
1441 | <span class="jsdoc-message">
|
1442 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
1443 |
|
1444 | on Mon Feb 3rd 2020
|
1445 |
|
1446 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
1447 | </span>
|
1448 | </footer>
|
1449 |
|
1450 | <script src="scripts/docstrap.lib.js"></script>
|
1451 | <script src="scripts/toc.js"></script>
|
1452 |
|
1453 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
1454 |
|
1455 |
|
1456 | <script>
|
1457 | $( function () {
|
1458 | $( "[id*='$']" ).each( function () {
|
1459 | var $this = $( this );
|
1460 |
|
1461 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
1462 | } );
|
1463 |
|
1464 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
1465 | var $this = $( this );
|
1466 |
|
1467 | var example = $this.find( "code" );
|
1468 | exampleText = example.html();
|
1469 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
1470 | if ( lang && lang[1] ) {
|
1471 | exampleText = exampleText.replace( lang[0], "" );
|
1472 | example.html( exampleText );
|
1473 | lang = lang[1];
|
1474 | } else {
|
1475 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
1476 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
1477 | }
|
1478 |
|
1479 | if ( lang ) {
|
1480 |
|
1481 | $this
|
1482 | .addClass( "sunlight-highlight-" + lang )
|
1483 | .addClass( "linenums" )
|
1484 | .html( example.html() );
|
1485 |
|
1486 | }
|
1487 | } );
|
1488 |
|
1489 | Sunlight.highlightAll( {
|
1490 | lineNumbers : true,
|
1491 | showMenu : true,
|
1492 | enableDoclinks : true
|
1493 | } );
|
1494 |
|
1495 | $.catchAnchorLinks( {
|
1496 | navbarOffset: 10
|
1497 | } );
|
1498 | $( "#toc" ).toc( {
|
1499 | anchorName : function ( i, heading, prefix ) {
|
1500 | return $( heading ).attr( "id" ) || ( prefix + i );
|
1501 | },
|
1502 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
1503 | showAndHide : false,
|
1504 | smoothScrolling: true
|
1505 | } );
|
1506 |
|
1507 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
1508 | $( '.dropdown-toggle' ).dropdown();
|
1509 |
|
1510 | $( "table" ).each( function () {
|
1511 | var $this = $( this );
|
1512 | $this.addClass('table');
|
1513 | } );
|
1514 |
|
1515 | } );
|
1516 | </script>
|
1517 |
|
1518 |
|
1519 |
|
1520 |
|
1521 |
|
1522 | <script>
|
1523 | $( function () {
|
1524 | $( '#main' ).localScroll( {
|
1525 | offset : { top : 60 }
|
1526 | } );
|
1527 | $( "dt.name" ).each( function () {
|
1528 | var $this = $( this ).find("h4");
|
1529 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
1530 | var dt = $(this);
|
1531 | var children = dt.next( "dd" );
|
1532 |
|
1533 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
1534 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
1535 |
|
1536 |
|
1537 | children.hide();
|
1538 |
|
1539 | dt.children().on( "click", function () {
|
1540 | children = dt.next( "dd" );
|
1541 | children.slideToggle( "fast", function () {
|
1542 |
|
1543 | if ( children.is( ":visible" ) ) {
|
1544 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
1545 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
1546 | } else {
|
1547 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
1548 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
1549 | }
|
1550 | } );
|
1551 | } );
|
1552 |
|
1553 | } );
|
1554 | } );
|
1555 | </script>
|
1556 |
|
1557 |
|
1558 |
|
1559 |
|
1560 |
|
1561 |
|
1562 | <script type="text/javascript">
|
1563 | $(document).ready(function() {
|
1564 | SearcherDisplay.init();
|
1565 | });
|
1566 | </script>
|
1567 |
|
1568 |
|
1569 | </body>
|
1570 | </html> |
\ | No newline at end of file |