Worked on image save as a file in Moodle.
[moodle/mihaisucan.git] / lib / paintweb / docs / api-ref / symbols / pwlib.tools.ellipse.html
blob1da5a95c91420fd577926957cdb20bc267afc838
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" />
8 <title>JsDoc Reference - pwlib.tools.ellipse</title>
10 <style type="text/css">
11 /* default.css */
12 body
14 font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15 width: 800px;
18 .header
20 clear: both;
21 background-color: #ccc;
22 padding: 8px;
27 font-size: 150%;
28 font-weight: bold;
29 padding: 0;
30 margin: 1em 0 0 .3em;
35 border: none 0;
36 border-top: 1px solid #7F8FB1;
37 height: 1px;
40 pre.code
42 display: block;
43 padding: 8px;
44 border: 1px dashed #ccc;
47 #index
49 margin-top: 24px;
50 float: left;
51 width: 160px;
52 position: absolute;
53 left: 8px;
54 background-color: #F3F3F3;
55 padding: 8px;
58 #content
60 margin-left: 190px;
61 width: 600px;
64 .classList
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;
74 .classList li
76 padding: 0;
77 margin: 0 0 8px 0;
80 .summaryTable { width: 100%; }
82 h1.classTitle
84 font-size:170%;
85 line-height:130%;
88 h2 { font-size: 110%; }
89 caption, div.sectionTitle
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;
99 div.sectionTitle { margin-bottom: 8px; }
100 .summaryTable thead { display: none; }
102 .summaryTable td
104 vertical-align: top;
105 padding: 4px;
106 border-bottom: 1px #7F8FB1 solid;
107 border-right: 1px #7F8FB1 solid;
110 /*col#summaryAttributes {}*/
111 .summaryTable td.attributes
113 border-left: 1px #7F8FB1 solid;
114 width: 140px;
115 text-align: right;
118 td.attributes, .fixedFont
120 line-height: 15px;
121 color: #002EBE;
122 font-family: "Courier New",Courier,monospace;
123 font-size: 13px;
126 .summaryTable td.nameDescription
128 text-align: left;
129 font-size: 13px;
130 line-height: 15px;
133 .summaryTable td.nameDescription, .description
135 line-height: 15px;
136 padding: 4px;
137 padding-left: 4px;
140 .summaryTable { margin-bottom: 8px; }
142 ul.inheritsList
144 list-style: square;
145 margin-left: 20px;
146 padding-left: 0;
149 .detailList {
150 margin-left: 20px;
151 line-height: 15px;
153 .detailList dt { margin-left: 20px; }
155 .detailList .heading
157 font-weight: bold;
158 padding-bottom: 6px;
159 margin-left: 0;
162 .light, td.attributes, .light a:link, .light a:visited
164 color: #777;
165 font-style: italic;
168 .fineprint
170 text-align: right;
171 font-size: 10px;
173 </style>
174 </head>
176 <body>
177 <!-- ============================== header ================================= -->
178 <!-- begin static/header.html -->
179 <div id="header">
180 </div>
181 <!-- end static/header.html -->
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">
192 <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
194 <li><a href="../symbols/PaintWeb.html">PaintWeb</a></li>
196 <li><a href="../symbols/pwlib.html">pwlib</a></li>
198 <li><a href="../symbols/pwlib.appEvent.html">pwlib.appEvent</a></li>
200 <li><a href="../symbols/pwlib.appEvent.appDestroy.html">pwlib.appEvent.appDestroy</a></li>
202 <li><a href="../symbols/pwlib.appEvent.appInit.html">pwlib.appEvent.appInit</a></li>
204 <li><a href="../symbols/pwlib.appEvent.canvasSizeChange.html">pwlib.appEvent.canvasSizeChange</a></li>
206 <li><a href="../symbols/pwlib.appEvent.clipboardUpdate.html">pwlib.appEvent.clipboardUpdate</a></li>
208 <li><a href="../symbols/pwlib.appEvent.commandRegister.html">pwlib.appEvent.commandRegister</a></li>
210 <li><a href="../symbols/pwlib.appEvent.commandUnregister.html">pwlib.appEvent.commandUnregister</a></li>
212 <li><a href="../symbols/pwlib.appEvent.configChange.html">pwlib.appEvent.configChange</a></li>
214 <li><a href="../symbols/pwlib.appEvent.extensionRegister.html">pwlib.appEvent.extensionRegister</a></li>
216 <li><a href="../symbols/pwlib.appEvent.extensionUnregister.html">pwlib.appEvent.extensionUnregister</a></li>
218 <li><a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a></li>
220 <li><a href="../symbols/pwlib.appEvent.guiHide.html">pwlib.appEvent.guiHide</a></li>
222 <li><a href="../symbols/pwlib.appEvent.guiResizeEnd.html">pwlib.appEvent.guiResizeEnd</a></li>
224 <li><a href="../symbols/pwlib.appEvent.guiResizeStart.html">pwlib.appEvent.guiResizeStart</a></li>
226 <li><a href="../symbols/pwlib.appEvent.guiShow.html">pwlib.appEvent.guiShow</a></li>
228 <li><a href="../symbols/pwlib.appEvent.guiTabActivate.html">pwlib.appEvent.guiTabActivate</a></li>
230 <li><a href="../symbols/pwlib.appEvent.historyUpdate.html">pwlib.appEvent.historyUpdate</a></li>
232 <li><a href="../symbols/pwlib.appEvent.imageCrop.html">pwlib.appEvent.imageCrop</a></li>
234 <li><a href="../symbols/pwlib.appEvent.imageSave.html">pwlib.appEvent.imageSave</a></li>
236 <li><a href="../symbols/pwlib.appEvent.imageSaveResult.html">pwlib.appEvent.imageSaveResult</a></li>
238 <li><a href="../symbols/pwlib.appEvent.imageSizeChange.html">pwlib.appEvent.imageSizeChange</a></li>
240 <li><a href="../symbols/pwlib.appEvent.imageZoom.html">pwlib.appEvent.imageZoom</a></li>
242 <li><a href="../symbols/pwlib.appEvent.selectionChange.html">pwlib.appEvent.selectionChange</a></li>
244 <li><a href="../symbols/pwlib.appEvent.shadowAllow.html">pwlib.appEvent.shadowAllow</a></li>
246 <li><a href="../symbols/pwlib.appEvent.toolActivate.html">pwlib.appEvent.toolActivate</a></li>
248 <li><a href="../symbols/pwlib.appEvent.toolPreactivate.html">pwlib.appEvent.toolPreactivate</a></li>
250 <li><a href="../symbols/pwlib.appEvent.toolRegister.html">pwlib.appEvent.toolRegister</a></li>
252 <li><a href="../symbols/pwlib.appEvent.toolUnregister.html">pwlib.appEvent.toolUnregister</a></li>
254 <li><a href="../symbols/pwlib.appEvents.html">pwlib.appEvents</a></li>
256 <li><a href="../symbols/pwlib.browser.html">pwlib.browser</a></li>
258 <li><a href="../symbols/pwlib.dom.html">pwlib.dom</a></li>
260 <li><a href="../symbols/pwlib.dom.KeyboardEventListener.html">pwlib.dom.KeyboardEventListener</a></li>
262 <li><a href="../symbols/pwlib.dom.keyCodes.html">pwlib.dom.keyCodes</a></li>
264 <li><a href="../symbols/pwlib.dom.keyCodes_fixes.html">pwlib.dom.keyCodes_fixes</a></li>
266 <li><a href="../symbols/pwlib.dom.keyCodes_Safari2.html">pwlib.dom.keyCodes_Safari2</a></li>
268 <li><a href="../symbols/pwlib.dom.keyNames.html">pwlib.dom.keyNames</a></li>
270 <li><a href="../symbols/pwlib.extensions.html">pwlib.extensions</a></li>
272 <li><a href="../symbols/pwlib.extensions.colormixer.html">pwlib.extensions.colormixer</a></li>
274 <li><a href="../symbols/pwlib.extensions.moodle.html">pwlib.extensions.moodle</a></li>
276 <li><a href="../symbols/pwlib.extensions.mousekeys.html">pwlib.extensions.mousekeys</a></li>
278 <li><a href="../symbols/pwlib.fileCache.html">pwlib.fileCache</a></li>
280 <li><a href="../symbols/pwlib.gui.html">pwlib.gui</a></li>
282 <li><a href="../symbols/pwlib.guiColorInput.html">pwlib.guiColorInput</a></li>
284 <li><a href="../symbols/pwlib.guiFloatingPanel.html">pwlib.guiFloatingPanel</a></li>
286 <li><a href="../symbols/pwlib.guiResizer.html">pwlib.guiResizer</a></li>
288 <li><a href="../symbols/pwlib.guiTabPanel.html">pwlib.guiTabPanel</a></li>
290 <li><a href="../symbols/pwlib.tools.html">pwlib.tools</a></li>
292 <li><a href="../symbols/pwlib.tools.bcurve.html">pwlib.tools.bcurve</a></li>
294 <li><a href="../symbols/pwlib.tools.cpicker.html">pwlib.tools.cpicker</a></li>
296 <li><a href="../symbols/pwlib.tools.ellipse.html">pwlib.tools.ellipse</a></li>
298 <li><a href="../symbols/pwlib.tools.eraser.html">pwlib.tools.eraser</a></li>
300 <li><a href="../symbols/pwlib.tools.hand.html">pwlib.tools.hand</a></li>
302 <li><a href="../symbols/pwlib.tools.insertimg.html">pwlib.tools.insertimg</a></li>
304 <li><a href="../symbols/pwlib.tools.line.html">pwlib.tools.line</a></li>
306 <li><a href="../symbols/pwlib.tools.pencil.html">pwlib.tools.pencil</a></li>
308 <li><a href="../symbols/pwlib.tools.polygon.html">pwlib.tools.polygon</a></li>
310 <li><a href="../symbols/pwlib.tools.rectangle.html">pwlib.tools.rectangle</a></li>
312 <li><a href="../symbols/pwlib.tools.selection.html">pwlib.tools.selection</a></li>
314 <li><a href="../symbols/pwlib.tools.text.html">pwlib.tools.text</a></li>
316 </ul>
317 <hr />
318 <!-- end publish.classesIndex -->
319 </div>
321 <div id="content">
322 <!-- ============================== class title ============================ -->
323 <h1 class="classTitle">
325 Class pwlib.tools.ellipse
326 </h1>
328 <!-- ============================== class summary ========================== -->
329 <p class="description">
332 The ellipse tool.
335 <br /><i>Defined in: </i> <a href="../symbols/src/src_tools_ellipse.js.html">ellipse.js</a>.
337 </p>
339 <!-- ============================== constructor summary ==================== -->
341 <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pwlib.tools.ellipse.">
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.ellipse.html#constructor">pwlib.tools.ellipse</a></b>(app)
355 </div>
356 <div class="description"></div>
357 </td>
358 </tr>
359 </tbody>
360 </table>
363 <!-- ============================== properties summary ===================== -->
367 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class pwlib.tools.ellipse.">
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>
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.ellipse.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>
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.ellipse.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>
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.ellipse.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>
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.ellipse.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>
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.ellipse.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>
430 </tbody>
431 </table>
437 <!-- ============================== methods summary ======================== -->
441 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.tools.ellipse.">
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>
451 <tr>
452 <td class="attributes">&nbsp;</td>
453 <td class="nameDescription">
454 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.ellipse.html#deactivate">deactivate</a></b>()
455 </div>
456 <div class="description">Tool deactivation event handler.</div>
457 </td>
458 </tr>
460 <tr>
461 <td class="attributes">&nbsp;</td>
462 <td class="nameDescription">
463 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.ellipse.html#draw">draw</a></b>()
464 </div>
465 <div class="description">Perform the drawing operation.</div>
466 </td>
467 </tr>
469 <tr>
470 <td class="attributes">&nbsp;</td>
471 <td class="nameDescription">
472 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.ellipse.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>
478 <tr>
479 <td class="attributes">&nbsp;</td>
480 <td class="nameDescription">
481 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.ellipse.html#mousedown">mousedown</a></b>(ev)
482 </div>
483 <div class="description">Initialize the drawing operation.</div>
484 </td>
485 </tr>
487 <tr>
488 <td class="attributes">&nbsp;</td>
489 <td class="nameDescription">
490 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.ellipse.html#mousemove">mousemove</a></b>(ev)
491 </div>
492 <div class="description">Store the <kbd>Shift</kbd> key state which is used by the drawing function.</div>
493 </td>
494 </tr>
496 <tr>
497 <td class="attributes">&nbsp;</td>
498 <td class="nameDescription">
499 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.ellipse.html#mouseup">mouseup</a></b>(ev)
500 </div>
501 <div class="description">End the drawing operation, once the user releases the mouse button.</div>
502 </td>
503 </tr>
505 </tbody>
506 </table>
511 <!-- ============================== events summary ======================== -->
514 <!-- ============================== constructor details ==================== -->
516 <div class="details"><a name="constructor"> </a>
517 <div class="sectionTitle">
518 Class Detail
519 </div>
521 <div class="fixedFont">
522 <b>pwlib.tools.ellipse</b>(app)
523 </div>
525 <div class="description">
528 </div>
534 <dl class="detailList">
535 <dt class="heading">Parameters:</dt>
537 <dt>
538 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span> <b>app</b>
540 </dt>
541 <dd>Reference to the main paint application object.</dd>
543 </dl>
552 </div>
555 <!-- ============================== field details ========================== -->
557 <div class="sectionTitle">
558 Field Detail
559 </div>
561 <a name="-needsRedraw"> </a>
562 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
564 <span class="light">{Boolean}</span>
565 <b>needsRedraw</b>
567 </div>
568 <div class="description">
569 Tells if the drawing canvas needs to be updated or not.
572 </div>
580 <dl class="detailList">
581 <dt class="heading">Default Value:</dt>
582 <dd>
583 false
584 </dd>
585 </dl>
588 <hr />
590 <a name="-shiftKey"> </a>
591 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
593 <span class="light">{Boolean}</span>
594 <b>shiftKey</b>
596 </div>
597 <div class="description">
598 Tells if the <kbd>Shift</kbd> key is down or not. This is used by the
599 drawing function.
602 </div>
610 <dl class="detailList">
611 <dt class="heading">Default Value:</dt>
612 <dd>
613 false
614 </dd>
615 </dl>
618 <hr />
620 <a name="-timer"> </a>
621 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
624 <b>timer</b>
626 </div>
627 <div class="description">
628 The interval ID used for invoking the drawing operation every few
629 milliseconds.
632 </div>
639 <dl class="detailList">
640 <dt class="heading">See:</dt>
642 <dd>PaintWeb.config.toolDrawDelay</dd>
644 </dl>
648 <hr />
650 <a name="-x0"> </a>
651 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
653 <span class="light">{Number}</span>
654 <b>x0</b>
656 </div>
657 <div class="description">
658 Holds the starting point on the <var>x</var> axis of the image, for the
659 current drawing operation.
662 </div>
671 <hr />
673 <a name="-y0"> </a>
674 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
676 <span class="light">{Number}</span>
677 <b>y0</b>
679 </div>
680 <div class="description">
681 Holds the starting point on the <var>y</var> axis of the image, for the
682 current drawing operation.
685 </div>
698 <!-- ============================== method details ========================= -->
700 <div class="sectionTitle">
701 Method Detail
702 </div>
704 <a name="deactivate"> </a>
705 <div class="fixedFont">
708 <b>deactivate</b>()
710 </div>
711 <div class="description">
712 Tool deactivation event handler.
715 </div>
727 <hr />
729 <a name="draw"> </a>
730 <div class="fixedFont">
733 <b>draw</b>()
735 </div>
736 <div class="description">
737 Perform the drawing operation. This function is called every few
738 milliseconds.
740 <p>Hold down the <kbd>Shift</kbd> key to draw a circle.
741 <p>Press <kbd>Escape</kbd> to cancel the drawing operation.
744 </div>
755 <dl class="detailList">
756 <dt class="heading">See:</dt>
758 <dd>PaintWeb.config.toolDrawDelay</dd>
760 </dl>
763 <hr />
765 <a name="keydown"> </a>
766 <div class="fixedFont">
768 <span class="light">{Boolean}</span>
769 <b>keydown</b>(ev)
771 </div>
772 <div class="description">
773 Allows the user to press <kbd>Escape</kbd> to cancel the drawing operation.
776 </div>
781 <dl class="detailList">
782 <dt class="heading">Parameters:</dt>
784 <dt>
785 <span class="light fixedFont">{Event}</span> <b>ev</b>
787 </dt>
788 <dd>The DOM Event object.</dd>
790 </dl>
796 <dl class="detailList">
797 <dt class="heading">Returns:</dt>
799 <dd><span class="light fixedFont">{Boolean}</span> True if the drawing operation was cancelled, or false if
800 not.</dd>
802 </dl>
807 <hr />
809 <a name="mousedown"> </a>
810 <div class="fixedFont">
813 <b>mousedown</b>(ev)
815 </div>
816 <div class="description">
817 Initialize the drawing operation.
820 </div>
825 <dl class="detailList">
826 <dt class="heading">Parameters:</dt>
828 <dt>
829 <span class="light fixedFont">{Event}</span> <b>ev</b>
831 </dt>
832 <dd>The DOM Event object.</dd>
834 </dl>
843 <hr />
845 <a name="mousemove"> </a>
846 <div class="fixedFont">
849 <b>mousemove</b>(ev)
851 </div>
852 <div class="description">
853 Store the <kbd>Shift</kbd> key state which is used by the drawing function.
856 </div>
861 <dl class="detailList">
862 <dt class="heading">Parameters:</dt>
864 <dt>
865 <span class="light fixedFont">{Event}</span> <b>ev</b>
867 </dt>
868 <dd>The DOM Event object.</dd>
870 </dl>
879 <hr />
881 <a name="mouseup"> </a>
882 <div class="fixedFont">
885 <b>mouseup</b>(ev)
887 </div>
888 <div class="description">
889 End the drawing operation, once the user releases the mouse button.
892 </div>
897 <dl class="detailList">
898 <dt class="heading">Parameters:</dt>
900 <dt>
901 <span class="light fixedFont">{Event}</span> <b>ev</b>
903 </dt>
904 <dd>The DOM Event object.</dd>
906 </dl>
919 <!-- ============================== event details ========================= -->
922 <hr />
923 </div>
926 <!-- ============================== footer ================================= -->
927 <div class="fineprint" style="clear:both">
929 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:58 GMT+0300 (EEST)
930 </div>
931 </body>
932 </html>