?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Updated PaintWeb to the latest snapshot.
[moodle/mihaisucan.git] / lib / paintweb / docs / api-ref / symbols / pwlib.tools.line.html
blobbb81212d7ecaf80f50e5fd51d0c88c8ac7062bc9
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.line</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.line
326 </h1>
327
328 <!-- ============================== class summary ========================== -->
329 <p class="description">
330
331
332 The line tool.
333
334
335 <br /><i>Defined in: </i> <a href="../symbols/src/src_tools_line.js.html">line.js</a>.
336
337 </p>
338
339 <!-- ============================== constructor summary ==================== -->
340
341 <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pwlib.tools.line.">
342 <caption>Class Summary</caption>
343 <thead>
344 <tr>
345 <th scope="col">Constructor Attributes</th>
346 <th scope="col">Constructor Name and Description</th>
347 </tr>
348 </thead>
349 <tbody>
350 <tr>
351 <td class="attributes">&nbsp;</td>
352 <td class="nameDescription" >
353 <div class="fixedFont">
354 <b><a href="../symbols/pwlib.tools.line.html#constructor">pwlib.tools.line</a></b>(app)
355 </div>
356 <div class="description"></div>
357 </td>
358 </tr>
359 </tbody>
360 </table>
361
362
363 <!-- ============================== properties summary ===================== -->
364
365
366
367 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class pwlib.tools.line.">
368 <caption>Field Summary</caption>
369 <thead>
370 <tr>
371 <th scope="col">Field Attributes</th>
372 <th scope="col">Field Name and Description</th>
373 </tr>
374 </thead>
375 <tbody>
376
377 <tr>
378 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
379 <td class="nameDescription">
380 <div class="fixedFont">
381 <b><a href="../symbols/pwlib.tools.line.html#-needsRedraw">needsRedraw</a></b>
382 </div>
383 <div class="description">Tells if the drawing canvas needs to be updated or not.</div>
384 </td>
385 </tr>
386
387 <tr>
388 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
389 <td class="nameDescription">
390 <div class="fixedFont">
391 <b><a href="../symbols/pwlib.tools.line.html#-shiftKey">shiftKey</a></b>
392 </div>
393 <div class="description">Tells if the <kbd>Shift</kbd> key is down or not.</div>
394 </td>
395 </tr>
396
397 <tr>
398 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
399 <td class="nameDescription">
400 <div class="fixedFont">
401 <b><a href="../symbols/pwlib.tools.line.html#-timer">timer</a></b>
402 </div>
403 <div class="description">The interval ID used for invoking the drawing operation every few
404 milliseconds.</div>
405 </td>
406 </tr>
407
408 <tr>
409 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
410 <td class="nameDescription">
411 <div class="fixedFont">
412 <b><a href="../symbols/pwlib.tools.line.html#-x0">x0</a></b>
413 </div>
414 <div class="description">Holds the starting point on the <var>x</var> axis of the image, for the
415 current drawing operation.</div>
416 </td>
417 </tr>
418
419 <tr>
420 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
421 <td class="nameDescription">
422 <div class="fixedFont">
423 <b><a href="../symbols/pwlib.tools.line.html#-y0">y0</a></b>
424 </div>
425 <div class="description">Holds the starting point on the <var>y</var> axis of the image, for the
426 current drawing operation.</div>
427 </td>
428 </tr>
429
430 </tbody>
431 </table>
432
433
434
435
436
437 <!-- ============================== methods summary ======================== -->
438
439
440
441 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.tools.line.">
442 <caption>Method Summary</caption>
443 <thead>
444 <tr>
445 <th scope="col">Method Attributes</th>
446 <th scope="col">Method Name and Description</th>
447 </tr>
448 </thead>
449 <tbody>
450
451 <tr>
452 <td class="attributes">&nbsp;</td>
453 <td class="nameDescription">
454 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.line.html#deactivate">deactivate</a></b>()
455 </div>
456 <div class="description">Tool deactivation event handler.</div>
457 </td>
458 </tr>
459
460 <tr>
461 <td class="attributes">&nbsp;</td>
462 <td class="nameDescription">
463 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.line.html#draw">draw</a></b>()
464 </div>
465 <div class="description">Perform the drawing operation.</div>
466 </td>
467 </tr>
468
469 <tr>
470 <td class="attributes">&nbsp;</td>
471 <td class="nameDescription">
472 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.line.html#keydown">keydown</a></b>(ev)
473 </div>
474 <div class="description">Allows the user to press <kbd>Escape</kbd> to cancel the drawing operation.</div>
475 </td>
476 </tr>
477
478 <tr>
479 <td class="attributes">&nbsp;</td>
480 <td class="nameDescription">
481 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.line.html#mousedown">mousedown</a></b>(ev)
482 </div>
483 <div class="description">Initialize the drawing operation, by storing the location of the pointer,
484 the start position.</div>
485 </td>
486 </tr>
487
488 <tr>
489 <td class="attributes">&nbsp;</td>
490 <td class="nameDescription">
491 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.line.html#mousemove">mousemove</a></b>(ev)
492 </div>
493 <div class="description">Store the <kbd>Shift</kbd> key state which is used by the drawing function.</div>
494 </td>
495 </tr>
496
497 <tr>
498 <td class="attributes">&nbsp;</td>
499 <td class="nameDescription">
500 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.line.html#mouseup">mouseup</a></b>(ev)
501 </div>
502 <div class="description">End the drawing operation, once the user releases the mouse button.</div>
503 </td>
504 </tr>
505
506 </tbody>
507 </table>
508
509
510
511
512 <!-- ============================== events summary ======================== -->
513
514
515 <!-- ============================== constructor details ==================== -->
516
517 <div class="details"><a name="constructor"> </a>
518 <div class="sectionTitle">
519 Class Detail
520 </div>
521
522 <div class="fixedFont">
523 <b>pwlib.tools.line</b>(app)
524 </div>
525
526 <div class="description">
527
528
529 </div>
530
531
532
533
534
535 <dl class="detailList">
536 <dt class="heading">Parameters:</dt>
537
538 <dt>
539 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span> <b>app</b>
540
541 </dt>
542 <dd>Reference to the main paint application object.</dd>
543
544 </dl>
545
546
547
548
549
550
551
552
553 </div>
554
555
556 <!-- ============================== field details ========================== -->
557
558 <div class="sectionTitle">
559 Field Detail
560 </div>
561
562 <a name="-needsRedraw"> </a>
563 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
564
565 <span class="light">{Boolean}</span>
566 <b>needsRedraw</b>
567
568 </div>
569 <div class="description">
570 Tells if the drawing canvas needs to be updated or not.
571
572
573 </div>
574
575
576
577
578
579
580
581 <dl class="detailList">
582 <dt class="heading">Default Value:</dt>
583 <dd>
584 false
585 </dd>
586 </dl>
587
588
589 <hr />
590
591 <a name="-shiftKey"> </a>
592 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
593
594 <span class="light">{Boolean}</span>
595 <b>shiftKey</b>
596
597 </div>
598 <div class="description">
599 Tells if the <kbd>Shift</kbd> key is down or not. This is used by the
600 drawing function.
601
602
603 </div>
604
605
606
607
608
609
610
611 <dl class="detailList">
612 <dt class="heading">Default Value:</dt>
613 <dd>
614 false
615 </dd>
616 </dl>
617
618
619 <hr />
620
621 <a name="-timer"> </a>
622 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
623
624
625 <b>timer</b>
626
627 </div>
628 <div class="description">
629 The interval ID used for invoking the drawing operation every few
630 milliseconds.
631
632
633 </div>
634
635
636
637
638
639
640 <dl class="detailList">
641 <dt class="heading">See:</dt>
642
643 <dd>PaintWeb.config.toolDrawDelay</dd>
644
645 </dl>
646
647
648
649 <hr />
650
651 <a name="-x0"> </a>
652 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
653
654 <span class="light">{Number}</span>
655 <b>x0</b>
656
657 </div>
658 <div class="description">
659 Holds the starting point on the <var>x</var> axis of the image, for the
660 current drawing operation.
661
662
663 </div>
664
665
666
667
668
669
670
671
672 <hr />
673
674 <a name="-y0"> </a>
675 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
676
677 <span class="light">{Number}</span>
678 <b>y0</b>
679
680 </div>
681 <div class="description">
682 Holds the starting point on the <var>y</var> axis of the image, for the
683 current drawing operation.
684
685
686 </div>
687
688
689
690
691
692
693
694
695
696
697
698
699 <!-- ============================== method details ========================= -->
700
701 <div class="sectionTitle">
702 Method Detail
703 </div>
704
705 <a name="deactivate"> </a>
706 <div class="fixedFont">
707
708
709 <b>deactivate</b>()
710
711 </div>
712 <div class="description">
713 Tool deactivation event handler.
714
715
716 </div>
717
718
719
720
721
722
723
724
725
726
727
728 <hr />
729
730 <a name="draw"> </a>
731 <div class="fixedFont">
732
733
734 <b>draw</b>()
735
736 </div>
737 <div class="description">
738 Perform the drawing operation. This function is called every few
739 milliseconds.
740
741 <p>Hold down the <kbd>Shift</kbd> key to draw a straight
742 horizontal/vertical line.
743 <p>Press <kbd>Escape</kbd> to cancel the drawing operation.
744
745
746 </div>
747
748
749
750
751
752
753
754
755
756
757 <dl class="detailList">
758 <dt class="heading">See:</dt>
759
760 <dd>PaintWeb.config.toolDrawDelay</dd>
761
762 </dl>
763
764
765 <hr />
766
767 <a name="keydown"> </a>
768 <div class="fixedFont">
769
770 <span class="light">{Boolean}</span>
771 <b>keydown</b>(ev)
772
773 </div>
774 <div class="description">
775 Allows the user to press <kbd>Escape</kbd> to cancel the drawing operation.
776
777
778 </div>
779
780
781
782
783 <dl class="detailList">
784 <dt class="heading">Parameters:</dt>
785
786 <dt>
787 <span class="light fixedFont">{Event}</span> <b>ev</b>
788
789 </dt>
790 <dd>The DOM Event object.</dd>
791
792 </dl>
793
794
795
796
797
798 <dl class="detailList">
799 <dt class="heading">Returns:</dt>
800
801 <dd><span class="light fixedFont">{Boolean}</span> True if the drawing operation was cancelled, or false if
802 not.</dd>
803
804 </dl>
805
806
807
808
809 <hr />
810
811 <a name="mousedown"> </a>
812 <div class="fixedFont">
813
814
815 <b>mousedown</b>(ev)
816
817 </div>
818 <div class="description">
819 Initialize the drawing operation, by storing the location of the pointer,
820 the start position.
821
822
823 </div>
824
825
826
827
828 <dl class="detailList">
829 <dt class="heading">Parameters:</dt>
830
831 <dt>
832 <span class="light fixedFont">{Event}</span> <b>ev</b>
833
834 </dt>
835 <dd>The DOM Event object.</dd>
836
837 </dl>
838
839
840
841
842
843
844
845
846 <hr />
847
848 <a name="mousemove"> </a>
849 <div class="fixedFont">
850
851
852 <b>mousemove</b>(ev)
853
854 </div>
855 <div class="description">
856 Store the <kbd>Shift</kbd> key state which is used by the drawing function.
857
858
859 </div>
860
861
862
863
864 <dl class="detailList">
865 <dt class="heading">Parameters:</dt>
866
867 <dt>
868 <span class="light fixedFont">{Event}</span> <b>ev</b>
869
870 </dt>
871 <dd>The DOM Event object.</dd>
872
873 </dl>
874
875
876
877
878
879
880
881
882 <hr />
883
884 <a name="mouseup"> </a>
885 <div class="fixedFont">
886
887
888 <b>mouseup</b>(ev)
889
890 </div>
891 <div class="description">
892 End the drawing operation, once the user releases the mouse button.
893
894
895 </div>
896
897
898
899
900 <dl class="detailList">
901 <dt class="heading">Parameters:</dt>
902
903 <dt>
904 <span class="light fixedFont">{Event}</span> <b>ev</b>
905
906 </dt>
907 <dd>The DOM Event object.</dd>
908
909 </dl>
910
911
912
913
914
915
916
917
918
919
920
921
922 <!-- ============================== event details ========================= -->
923
924
925 <hr />
926 </div>
927
928
929 <!-- ============================== footer ================================= -->
930 <div class="fineprint" style="clear:both">
931
932 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Fri Jul 31 2009 20:23:24 GMT+0300 (EEST)
933 </div>
934 </body>
935 </html>
Mihai Sucan's work on Moodle