?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Worked on image save as a file in Moodle.
[moodle/mihaisucan.git] / lib / paintweb / docs / api-ref / symbols / pwlib.tools.hand.html
blob3550da54813b66ef73315250e02f1828b9eb681e
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6 <meta name="generator" content="JsDoc Toolkit" />
7
8 <title>JsDoc Reference - pwlib.tools.hand</title>
9
10 <style type="text/css">
11 /* default.css */
12 body
13 {
14 font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15 width: 800px;
16 }
17
18 .header
19 {
20 clear: both;
21 background-color: #ccc;
22 padding: 8px;
23 }
24
25 h1
26 {
27 font-size: 150%;
28 font-weight: bold;
29 padding: 0;
30 margin: 1em 0 0 .3em;
31 }
32
33 hr
34 {
35 border: none 0;
36 border-top: 1px solid #7F8FB1;
37 height: 1px;
38 }
39
40 pre.code
41 {
42 display: block;
43 padding: 8px;
44 border: 1px dashed #ccc;
45 }
46
47 #index
48 {
49 margin-top: 24px;
50 float: left;
51 width: 160px;
52 position: absolute;
53 left: 8px;
54 background-color: #F3F3F3;
55 padding: 8px;
56 }
57
58 #content
59 {
60 margin-left: 190px;
61 width: 600px;
62 }
63
64 .classList
65 {
66 list-style-type: none;
67 padding: 0;
68 margin: 0 0 0 8px;
69 font-family: arial, sans-serif;
70 font-size: 1em;
71 overflow: auto;
72 }
73
74 .classList li
75 {
76 padding: 0;
77 margin: 0 0 8px 0;
78 }
79
80 .summaryTable { width: 100%; }
81
82 h1.classTitle
83 {
84 font-size:170%;
85 line-height:130%;
86 }
87
88 h2 { font-size: 110%; }
89 caption, div.sectionTitle
90 {
91 background-color: #7F8FB1;
92 color: #fff;
93 font-size:130%;
94 text-align: left;
95 padding: 2px 6px 2px 6px;
96 border: 1px #7F8FB1 solid;
97 }
98
99 div.sectionTitle { margin-bottom: 8px; }
100 .summaryTable thead { display: none; }
101
102 .summaryTable td
103 {
104 vertical-align: top;
105 padding: 4px;
106 border-bottom: 1px #7F8FB1 solid;
107 border-right: 1px #7F8FB1 solid;
108 }
109
110 /*col#summaryAttributes {}*/
111 .summaryTable td.attributes
112 {
113 border-left: 1px #7F8FB1 solid;
114 width: 140px;
115 text-align: right;
116 }
117
118 td.attributes, .fixedFont
119 {
120 line-height: 15px;
121 color: #002EBE;
122 font-family: "Courier New",Courier,monospace;
123 font-size: 13px;
124 }
125
126 .summaryTable td.nameDescription
127 {
128 text-align: left;
129 font-size: 13px;
130 line-height: 15px;
131 }
132
133 .summaryTable td.nameDescription, .description
134 {
135 line-height: 15px;
136 padding: 4px;
137 padding-left: 4px;
138 }
139
140 .summaryTable { margin-bottom: 8px; }
141
142 ul.inheritsList
143 {
144 list-style: square;
145 margin-left: 20px;
146 padding-left: 0;
147 }
148
149 .detailList {
150 margin-left: 20px;
151 line-height: 15px;
152 }
153 .detailList dt { margin-left: 20px; }
154
155 .detailList .heading
156 {
157 font-weight: bold;
158 padding-bottom: 6px;
159 margin-left: 0;
160 }
161
162 .light, td.attributes, .light a:link, .light a:visited
163 {
164 color: #777;
165 font-style: italic;
166 }
167
168 .fineprint
169 {
170 text-align: right;
171 font-size: 10px;
172 }
173 </style>
174 </head>
175
176 <body>
177 <!-- ============================== header ================================= -->
178 <!-- begin static/header.html -->
179 <div id="header">
180 </div>
181 <!-- end static/header.html -->
182
183 <!-- ============================== classes index ============================ -->
184 <div id="index">
185 <!-- begin publish.classesIndex -->
186 <div align="center"><a href="../index.html">Class Index</a>
187 | <a href="../files.html">File Index</a></div>
188 <hr />
189 <h2>Classes</h2>
190 <ul class="classList">
191
192 <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
193
194 <li><a href="../symbols/PaintWeb.html">PaintWeb</a></li>
195
196 <li><a href="../symbols/pwlib.html">pwlib</a></li>
197
198 <li><a href="../symbols/pwlib.appEvent.html">pwlib.appEvent</a></li>
199
200 <li><a href="../symbols/pwlib.appEvent.appDestroy.html">pwlib.appEvent.appDestroy</a></li>
201
202 <li><a href="../symbols/pwlib.appEvent.appInit.html">pwlib.appEvent.appInit</a></li>
203
204 <li><a href="../symbols/pwlib.appEvent.canvasSizeChange.html">pwlib.appEvent.canvasSizeChange</a></li>
205
206 <li><a href="../symbols/pwlib.appEvent.clipboardUpdate.html">pwlib.appEvent.clipboardUpdate</a></li>
207
208 <li><a href="../symbols/pwlib.appEvent.commandRegister.html">pwlib.appEvent.commandRegister</a></li>
209
210 <li><a href="../symbols/pwlib.appEvent.commandUnregister.html">pwlib.appEvent.commandUnregister</a></li>
211
212 <li><a href="../symbols/pwlib.appEvent.configChange.html">pwlib.appEvent.configChange</a></li>
213
214 <li><a href="../symbols/pwlib.appEvent.extensionRegister.html">pwlib.appEvent.extensionRegister</a></li>
215
216 <li><a href="../symbols/pwlib.appEvent.extensionUnregister.html">pwlib.appEvent.extensionUnregister</a></li>
217
218 <li><a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a></li>
219
220 <li><a href="../symbols/pwlib.appEvent.guiHide.html">pwlib.appEvent.guiHide</a></li>
221
222 <li><a href="../symbols/pwlib.appEvent.guiResizeEnd.html">pwlib.appEvent.guiResizeEnd</a></li>
223
224 <li><a href="../symbols/pwlib.appEvent.guiResizeStart.html">pwlib.appEvent.guiResizeStart</a></li>
225
226 <li><a href="../symbols/pwlib.appEvent.guiShow.html">pwlib.appEvent.guiShow</a></li>
227
228 <li><a href="../symbols/pwlib.appEvent.guiTabActivate.html">pwlib.appEvent.guiTabActivate</a></li>
229
230 <li><a href="../symbols/pwlib.appEvent.historyUpdate.html">pwlib.appEvent.historyUpdate</a></li>
231
232 <li><a href="../symbols/pwlib.appEvent.imageCrop.html">pwlib.appEvent.imageCrop</a></li>
233
234 <li><a href="../symbols/pwlib.appEvent.imageSave.html">pwlib.appEvent.imageSave</a></li>
235
236 <li><a href="../symbols/pwlib.appEvent.imageSaveResult.html">pwlib.appEvent.imageSaveResult</a></li>
237
238 <li><a href="../symbols/pwlib.appEvent.imageSizeChange.html">pwlib.appEvent.imageSizeChange</a></li>
239
240 <li><a href="../symbols/pwlib.appEvent.imageZoom.html">pwlib.appEvent.imageZoom</a></li>
241
242 <li><a href="../symbols/pwlib.appEvent.selectionChange.html">pwlib.appEvent.selectionChange</a></li>
243
244 <li><a href="../symbols/pwlib.appEvent.shadowAllow.html">pwlib.appEvent.shadowAllow</a></li>
245
246 <li><a href="../symbols/pwlib.appEvent.toolActivate.html">pwlib.appEvent.toolActivate</a></li>
247
248 <li><a href="../symbols/pwlib.appEvent.toolPreactivate.html">pwlib.appEvent.toolPreactivate</a></li>
249
250 <li><a href="../symbols/pwlib.appEvent.toolRegister.html">pwlib.appEvent.toolRegister</a></li>
251
252 <li><a href="../symbols/pwlib.appEvent.toolUnregister.html">pwlib.appEvent.toolUnregister</a></li>
253
254 <li><a href="../symbols/pwlib.appEvents.html">pwlib.appEvents</a></li>
255
256 <li><a href="../symbols/pwlib.browser.html">pwlib.browser</a></li>
257
258 <li><a href="../symbols/pwlib.dom.html">pwlib.dom</a></li>
259
260 <li><a href="../symbols/pwlib.dom.KeyboardEventListener.html">pwlib.dom.KeyboardEventListener</a></li>
261
262 <li><a href="../symbols/pwlib.dom.keyCodes.html">pwlib.dom.keyCodes</a></li>
263
264 <li><a href="../symbols/pwlib.dom.keyCodes_fixes.html">pwlib.dom.keyCodes_fixes</a></li>
265
266 <li><a href="../symbols/pwlib.dom.keyCodes_Safari2.html">pwlib.dom.keyCodes_Safari2</a></li>
267
268 <li><a href="../symbols/pwlib.dom.keyNames.html">pwlib.dom.keyNames</a></li>
269
270 <li><a href="../symbols/pwlib.extensions.html">pwlib.extensions</a></li>
271
272 <li><a href="../symbols/pwlib.extensions.colormixer.html">pwlib.extensions.colormixer</a></li>
273
274 <li><a href="../symbols/pwlib.extensions.moodle.html">pwlib.extensions.moodle</a></li>
275
276 <li><a href="../symbols/pwlib.extensions.mousekeys.html">pwlib.extensions.mousekeys</a></li>
277
278 <li><a href="../symbols/pwlib.fileCache.html">pwlib.fileCache</a></li>
279
280 <li><a href="../symbols/pwlib.gui.html">pwlib.gui</a></li>
281
282 <li><a href="../symbols/pwlib.guiColorInput.html">pwlib.guiColorInput</a></li>
283
284 <li><a href="../symbols/pwlib.guiFloatingPanel.html">pwlib.guiFloatingPanel</a></li>
285
286 <li><a href="../symbols/pwlib.guiResizer.html">pwlib.guiResizer</a></li>
287
288 <li><a href="../symbols/pwlib.guiTabPanel.html">pwlib.guiTabPanel</a></li>
289
290 <li><a href="../symbols/pwlib.tools.html">pwlib.tools</a></li>
291
292 <li><a href="../symbols/pwlib.tools.bcurve.html">pwlib.tools.bcurve</a></li>
293
294 <li><a href="../symbols/pwlib.tools.cpicker.html">pwlib.tools.cpicker</a></li>
295
296 <li><a href="../symbols/pwlib.tools.ellipse.html">pwlib.tools.ellipse</a></li>
297
298 <li><a href="../symbols/pwlib.tools.eraser.html">pwlib.tools.eraser</a></li>
299
300 <li><a href="../symbols/pwlib.tools.hand.html">pwlib.tools.hand</a></li>
301
302 <li><a href="../symbols/pwlib.tools.insertimg.html">pwlib.tools.insertimg</a></li>
303
304 <li><a href="../symbols/pwlib.tools.line.html">pwlib.tools.line</a></li>
305
306 <li><a href="../symbols/pwlib.tools.pencil.html">pwlib.tools.pencil</a></li>
307
308 <li><a href="../symbols/pwlib.tools.polygon.html">pwlib.tools.polygon</a></li>
309
310 <li><a href="../symbols/pwlib.tools.rectangle.html">pwlib.tools.rectangle</a></li>
311
312 <li><a href="../symbols/pwlib.tools.selection.html">pwlib.tools.selection</a></li>
313
314 <li><a href="../symbols/pwlib.tools.text.html">pwlib.tools.text</a></li>
315
316 </ul>
317 <hr />
318 <!-- end publish.classesIndex -->
319 </div>
320
321 <div id="content">
322 <!-- ============================== class title ============================ -->
323 <h1 class="classTitle">
324
325 Class pwlib.tools.hand
326 </h1>
327
328 <!-- ============================== class summary ========================== -->
329 <p class="description">
330
331
332 The hand tool. This tool allows the user to drag the image canvas
333 inside the viewport.
334
335
336 <br /><i>Defined in: </i> <a href="../symbols/src/src_tools_hand.js.html">hand.js</a>.
337
338 </p>
339
340 <!-- ============================== constructor summary ==================== -->
341
342 <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pwlib.tools.hand.">
343 <caption>Class Summary</caption>
344 <thead>
345 <tr>
346 <th scope="col">Constructor Attributes</th>
347 <th scope="col">Constructor Name and Description</th>
348 </tr>
349 </thead>
350 <tbody>
351 <tr>
352 <td class="attributes">&nbsp;</td>
353 <td class="nameDescription" >
354 <div class="fixedFont">
355 <b><a href="../symbols/pwlib.tools.hand.html#constructor">pwlib.tools.hand</a></b>(app)
356 </div>
357 <div class="description"></div>
358 </td>
359 </tr>
360 </tbody>
361 </table>
362
363
364 <!-- ============================== properties summary ===================== -->
365
366
367
368 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class pwlib.tools.hand.">
369 <caption>Field Summary</caption>
370 <thead>
371 <tr>
372 <th scope="col">Field Attributes</th>
373 <th scope="col">Field Name and Description</th>
374 </tr>
375 </thead>
376 <tbody>
377
378 <tr>
379 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
380 <td class="nameDescription">
381 <div class="fixedFont">
382 <b><a href="../symbols/pwlib.tools.hand.html#-needsScroll">needsScroll</a></b>
383 </div>
384 <div class="description">Tells if the viewport needs to be scrolled.</div>
385 </td>
386 </tr>
387
388 <tr>
389 <td class="attributes">&lt;private&gt; &nbsp;</td>
390 <td class="nameDescription">
391 <div class="fixedFont">
392 <b><a href="../symbols/pwlib.tools.hand.html#prevTool">prevTool</a></b>
393 </div>
394 <div class="description">Holds the previous tool ID.</div>
395 </td>
396 </tr>
397
398 <tr>
399 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
400 <td class="nameDescription">
401 <div class="fixedFont">
402 <b><a href="../symbols/pwlib.tools.hand.html#-timer">timer</a></b>
403 </div>
404 <div class="description">The interval ID used for invoking the viewport drag operation every few
405 milliseconds.</div>
406 </td>
407 </tr>
408
409 </tbody>
410 </table>
411
412
413
414
415
416 <!-- ============================== methods summary ======================== -->
417
418
419
420 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.tools.hand.">
421 <caption>Method Summary</caption>
422 <thead>
423 <tr>
424 <th scope="col">Method Attributes</th>
425 <th scope="col">Method Name and Description</th>
426 </tr>
427 </thead>
428 <tbody>
429
430 <tr>
431 <td class="attributes">&nbsp;</td>
432 <td class="nameDescription">
433 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#activate">activate</a></b>()
434 </div>
435 <div class="description">Tool activation event handler.</div>
436 </td>
437 </tr>
438
439 <tr>
440 <td class="attributes">&nbsp;</td>
441 <td class="nameDescription">
442 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#deactivate">deactivate</a></b>(ev)
443 </div>
444 <div class="description">Tool deactivation event handler.</div>
445 </td>
446 </tr>
447
448 <tr>
449 <td class="attributes">&lt;inner&gt; &nbsp;</td>
450 <td class="nameDescription">
451 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#-ev_mousemove">ev_mousemove</a></b>(ev)
452 </div>
453 <div class="description">The <code>mousemove</code> event handler.</div>
454 </td>
455 </tr>
456
457 <tr>
458 <td class="attributes">&lt;inner&gt; &nbsp;</td>
459 <td class="nameDescription">
460 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#-ev_mouseup">ev_mouseup</a></b>(ev)
461 </div>
462 <div class="description">The <code>mouseup</code> event handler.</div>
463 </td>
464 </tr>
465
466 <tr>
467 <td class="attributes">&nbsp;</td>
468 <td class="nameDescription">
469 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#keydown">keydown</a></b>(ev)
470 </div>
471 <div class="description">Allows the user to press <kbd>Escape</kbd> to stop dragging the canvas, and
472 to return to the previous tool.</div>
473 </td>
474 </tr>
475
476 <tr>
477 <td class="attributes">&nbsp;</td>
478 <td class="nameDescription">
479 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#mousedown">mousedown</a></b>(ev)
480 </div>
481 <div class="description">Initialize the canvas drag.</div>
482 </td>
483 </tr>
484
485 <tr>
486 <td class="attributes">&nbsp;</td>
487 <td class="nameDescription">
488 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#preActivate">preActivate</a></b>()
489 </div>
490 <div class="description">Tool preactivation event handler.</div>
491 </td>
492 </tr>
493
494 <tr>
495 <td class="attributes">&lt;inner&gt; &nbsp;</td>
496 <td class="nameDescription">
497 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.hand.html#-viewportScroll">viewportScroll</a></b>()
498 </div>
499 <div class="description">Perform the canvas drag operation.</div>
500 </td>
501 </tr>
502
503 </tbody>
504 </table>
505
506
507
508
509 <!-- ============================== events summary ======================== -->
510
511
512 <!-- ============================== constructor details ==================== -->
513
514 <div class="details"><a name="constructor"> </a>
515 <div class="sectionTitle">
516 Class Detail
517 </div>
518
519 <div class="fixedFont">
520 <b>pwlib.tools.hand</b>(app)
521 </div>
522
523 <div class="description">
524
525
526 </div>
527
528
529
530
531
532 <dl class="detailList">
533 <dt class="heading">Parameters:</dt>
534
535 <dt>
536 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span> <b>app</b>
537
538 </dt>
539 <dd>Reference to the main paint application object.</dd>
540
541 </dl>
542
543
544
545
546
547
548
549
550 </div>
551
552
553 <!-- ============================== field details ========================== -->
554
555 <div class="sectionTitle">
556 Field Detail
557 </div>
558
559 <a name="-needsScroll"> </a>
560 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
561
562 <span class="light">{Boolean}</span>
563 <b>needsScroll</b>
564
565 </div>
566 <div class="description">
567 Tells if the viewport needs to be scrolled.
568
569
570 </div>
571
572
573
574
575
576
577
578 <dl class="detailList">
579 <dt class="heading">Default Value:</dt>
580 <dd>
581 false
582 </dd>
583 </dl>
584
585
586 <hr />
587
588 <a name="prevTool"> </a>
589 <div class="fixedFont">&lt;private&gt;
590
591 <span class="light">{String}</span>
592 <b>prevTool</b>
593
594 </div>
595 <div class="description">
596 Holds the previous tool ID.
597
598
599 </div>
600
601
602
603
604
605
606
607
608 <hr />
609
610 <a name="-timer"> </a>
611 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
612
613
614 <b>timer</b>
615
616 </div>
617 <div class="description">
618 The interval ID used for invoking the viewport drag operation every few
619 milliseconds.
620
621
622 </div>
623
624
625
626
627
628
629 <dl class="detailList">
630 <dt class="heading">See:</dt>
631
632 <dd>PaintWeb.config.toolDrawDelay</dd>
633
634 </dl>
635
636
637
638
639
640
641
642 <!-- ============================== method details ========================= -->
643
644 <div class="sectionTitle">
645 Method Detail
646 </div>
647
648 <a name="activate"> </a>
649 <div class="fixedFont">
650
651
652 <b>activate</b>()
653
654 </div>
655 <div class="description">
656 Tool activation event handler.
657
658
659 </div>
660
661
662
663
664
665
666
667
668
669
670
671 <hr />
672
673 <a name="deactivate"> </a>
674 <div class="fixedFont">
675
676
677 <b>deactivate</b>(ev)
678
679 </div>
680 <div class="description">
681 Tool deactivation event handler.
682
683
684 </div>
685
686
687
688
689 <dl class="detailList">
690 <dt class="heading">Parameters:</dt>
691
692 <dt>
693 <b>ev</b>
694
695 </dt>
696 <dd></dd>
697
698 </dl>
699
700
701
702
703
704
705
706
707 <hr />
708
709 <a name="-ev_mousemove"> </a>
710 <div class="fixedFont">&lt;inner&gt;
711
712
713 <b>ev_mousemove</b>(ev)
714
715 </div>
716 <div class="description">
717 The <code>mousemove</code> event handler. This simply stores the current
718 mouse location.
719
720
721 </div>
722
723
724
725
726 <dl class="detailList">
727 <dt class="heading">Parameters:</dt>
728
729 <dt>
730 <span class="light fixedFont">{Event}</span> <b>ev</b>
731
732 </dt>
733 <dd>The DOM Event object.</dd>
734
735 </dl>
736
737
738
739
740
741
742
743
744 <hr />
745
746 <a name="-ev_mouseup"> </a>
747 <div class="fixedFont">&lt;inner&gt;
748
749
750 <b>ev_mouseup</b>(ev)
751
752 </div>
753 <div class="description">
754 The <code>mouseup</code> event handler.
755
756
757 </div>
758
759
760
761
762 <dl class="detailList">
763 <dt class="heading">Parameters:</dt>
764
765 <dt>
766 <b>ev</b>
767
768 </dt>
769 <dd></dd>
770
771 </dl>
772
773
774
775
776
777
778
779
780 <hr />
781
782 <a name="keydown"> </a>
783 <div class="fixedFont">
784
785 <span class="light">{Boolean}</span>
786 <b>keydown</b>(ev)
787
788 </div>
789 <div class="description">
790 Allows the user to press <kbd>Escape</kbd> to stop dragging the canvas, and
791 to return to the previous tool.
792
793
794 </div>
795
796
797
798
799 <dl class="detailList">
800 <dt class="heading">Parameters:</dt>
801
802 <dt>
803 <span class="light fixedFont">{Event}</span> <b>ev</b>
804
805 </dt>
806 <dd>The DOM Event object.</dd>
807
808 </dl>
809
810
811
812
813
814 <dl class="detailList">
815 <dt class="heading">Returns:</dt>
816
817 <dd><span class="light fixedFont">{Boolean}</span> True if the key was recognized, or false if not.</dd>
818
819 </dl>
820
821
822
823
824 <hr />
825
826 <a name="mousedown"> </a>
827 <div class="fixedFont">
828
829
830 <b>mousedown</b>(ev)
831
832 </div>
833 <div class="description">
834 Initialize the canvas drag.
835
836
837 </div>
838
839
840
841
842 <dl class="detailList">
843 <dt class="heading">Parameters:</dt>
844
845 <dt>
846 <span class="light fixedFont">{Event}</span> <b>ev</b>
847
848 </dt>
849 <dd>The DOM event object.</dd>
850
851 </dl>
852
853
854
855
856
857
858
859
860 <hr />
861
862 <a name="preActivate"> </a>
863 <div class="fixedFont">
864
865 <span class="light">{Boolean}</span>
866 <b>preActivate</b>()
867
868 </div>
869 <div class="description">
870 Tool preactivation event handler.
871
872
873 </div>
874
875
876
877
878
879
880
881
882 <dl class="detailList">
883 <dt class="heading">Returns:</dt>
884
885 <dd><span class="light fixedFont">{Boolean}</span> True if the tool can become active, or false if not.</dd>
886
887 </dl>
888
889
890
891
892 <hr />
893
894 <a name="-viewportScroll"> </a>
895 <div class="fixedFont">&lt;inner&gt;
896
897
898 <b>viewportScroll</b>()
899
900 </div>
901 <div class="description">
902 Perform the canvas drag operation. This function is called every few
903 milliseconds.
904
905 <p>Press <kbd>Escape</kbd> to stop dragging and to get back to the previous
906 tool.
907
908
909 </div>
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925 <!-- ============================== event details ========================= -->
926
927
928 <hr />
929 </div>
930
931
932 <!-- ============================== footer ================================= -->
933 <div class="fineprint" style="clear:both">
934
935 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Mon Jul 27 2009 14:56:59 GMT+0300 (EEST)
936 </div>
937 </body>
938 </html>
Mihai Sucan's work on Moodle