lib/paintweb/docs/api-ref/symbols/pwlib.tools.pencil.html

   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.pencil</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.pencil
 326                         </h1>
 327
 328 <!-- ============================== class summary ========================== -->
 329                         <p class="description">
 330
 331
 332                                 The drawing pencil.
 333
 334
 335                                         <br /><i>Defined in: </i> <a href="../symbols/src/src_tools_pencil.js.html">pencil.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.pencil.">
 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.pencil.html#constructor">pwlib.tools.pencil</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.pencil.">
 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.pencil.html#-points">points</a></b>
 382                                                                 </div>
 383                                                                 <div class="description">Holds the points needed to be drawn.</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.pencil.html#-timer">timer</a></b>
 392                                                                 </div>
 393                                                                 <div class="description">The interval ID used for running the pencil drawing operation every few
 394 milliseconds.</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.pencil.html#-x0">x0</a></b>
 403                                                                 </div>
 404                                                                 <div class="description">Holds the last point on the <var>x</var> axis of the image, for the current
 405 drawing operation.</div>
 406                                                         </td>
 407                                                 </tr>
 408
 409                                                 <tr>
 410                                                         <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
 411                                                         <td class="nameDescription">
 412                                                                 <div class="fixedFont">
 413                                                                 <b><a href="../symbols/pwlib.tools.pencil.html#-y0">y0</a></b>
 414                                                                 </div>
 415                                                                 <div class="description">Holds the last point on the <var>y</var> axis of the image, for the current
 416 drawing operation.</div>
 417                                                         </td>
 418                                                 </tr>
 419
 420                                         </tbody>
 421                                 </table>
 422
 423
 424
 425
 426
 427 <!-- ============================== methods summary ======================== -->
 428
 429
 430
 431                                 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.tools.pencil.">
 432                                         <caption>Method Summary</caption>
 433                                         <thead>
 434                                                 <tr>
 435                                                         <th scope="col">Method Attributes</th>
 436                                                         <th scope="col">Method Name and Description</th>
 437                                                 </tr>
 438                                         </thead>
 439                                         <tbody>
 440
 441                                                 <tr>
 442                                                         <td class="attributes">&nbsp;</td>
 443                                                         <td class="nameDescription">
 444                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.pencil.html#deactivate">deactivate</a></b>()
 445                                                                 </div>
 446                                                                 <div class="description">Tool deactivation event handler.</div>
 447                                                         </td>
 448                                                 </tr>
 449
 450                                                 <tr>
 451                                                         <td class="attributes">&nbsp;</td>
 452                                                         <td class="nameDescription">
 453                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.pencil.html#draw">draw</a></b>()
 454                                                                 </div>
 455                                                                 <div class="description">Draw the points in the stack.</div>
 456                                                         </td>
 457                                                 </tr>
 458
 459                                                 <tr>
 460                                                         <td class="attributes">&nbsp;</td>
 461                                                         <td class="nameDescription">
 462                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.pencil.html#keydown">keydown</a></b>(ev)
 463                                                                 </div>
 464                                                                 <div class="description">Allows the user to press <kbd>Escape</kbd> to cancel the drawing operation.</div>
 465                                                         </td>
 466                                                 </tr>
 467
 468                                                 <tr>
 469                                                         <td class="attributes">&nbsp;</td>
 470                                                         <td class="nameDescription">
 471                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.pencil.html#mousedown">mousedown</a></b>()
 472                                                                 </div>
 473                                                                 <div class="description">Initialize the drawing operation.</div>
 474                                                         </td>
 475                                                 </tr>
 476
 477                                                 <tr>
 478                                                         <td class="attributes">&nbsp;</td>
 479                                                         <td class="nameDescription">
 480                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.pencil.html#mousemove">mousemove</a></b>()
 481                                                                 </div>
 482                                                                 <div class="description">Save the mouse coordinates in the array.</div>
 483                                                         </td>
 484                                                 </tr>
 485
 486                                                 <tr>
 487                                                         <td class="attributes">&nbsp;</td>
 488                                                         <td class="nameDescription">
 489                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.pencil.html#mouseup">mouseup</a></b>()
 490                                                                 </div>
 491                                                                 <div class="description">End the drawing operation, once the user releases the mouse button.</div>
 492                                                         </td>
 493                                                 </tr>
 494
 495                                         </tbody>
 496                                 </table>
 497
 498
 499
 500
 501 <!-- ============================== events summary ======================== -->
 502
 503
 504 <!-- ============================== constructor details ==================== -->
 505
 506                         <div class="details"><a name="constructor"> </a>
 507                                 <div class="sectionTitle">
 508                                         Class Detail
 509                                 </div>
 510
 511                                 <div class="fixedFont">
 512                                                 <b>pwlib.tools.pencil</b>(app)
 513                                 </div>
 514
 515                                 <div class="description">
 516
 517
 518                                 </div>
 519
 520
 521
 522
 523
 524                                                 <dl class="detailList">
 525                                                 <dt class="heading">Parameters:</dt>
 526
 527                                                         <dt>
 528                                                                 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span>  <b>app</b>
 529
 530                                                         </dt>
 531                                                                 <dd>Reference to the main paint application object.</dd>
 532
 533                                                 </dl>
 534
 535
 536
 537
 538
 539
 540
 541
 542                         </div>
 543
 544
 545 <!-- ============================== field details ========================== -->
 546
 547                                 <div class="sectionTitle">
 548                                         Field Detail
 549                                 </div>
 550
 551                                         <a name="-points"> </a>
 552                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 553
 554                                         <span class="light">{Array}</span>
 555                                         <b>points</b>
 556
 557                                         </div>
 558                                         <div class="description">
 559                                                 Holds the points needed to be drawn. Each point is added by the
 560 <code>mousemove</code> event handler.
 561
 562
 563                                         </div>
 564
 565
 566
 567
 568
 569
 570
 571
 572                                         <hr />
 573
 574                                         <a name="-timer"> </a>
 575                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 576
 577
 578                                         <b>timer</b>
 579
 580                                         </div>
 581                                         <div class="description">
 582                                                 The interval ID used for running the pencil drawing operation every few
 583 milliseconds.
 584
 585
 586                                         </div>
 587
 588
 589
 590
 591
 592
 593                                                         <dl class="detailList">
 594                                                         <dt class="heading">See:</dt>
 595
 596                                                         <dd>PaintWeb.config.toolDrawDelay</dd>
 597
 598                                                         </dl>
 599
 600
 601
 602                                         <hr />
 603
 604                                         <a name="-x0"> </a>
 605                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 606
 607                                         <span class="light">{Number}</span>
 608                                         <b>x0</b>
 609
 610                                         </div>
 611                                         <div class="description">
 612                                                 Holds the last point on the <var>x</var> axis of the image, for the current
 613 drawing operation.
 614
 615
 616                                         </div>
 617
 618
 619
 620
 621
 622
 623
 624
 625                                         <hr />
 626
 627                                         <a name="-y0"> </a>
 628                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 629
 630                                         <span class="light">{Number}</span>
 631                                         <b>y0</b>
 632
 633                                         </div>
 634                                         <div class="description">
 635                                                 Holds the last point on the <var>y</var> axis of the image, for the current
 636 drawing operation.
 637
 638
 639                                         </div>
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652 <!-- ============================== method details ========================= -->
 653
 654                                 <div class="sectionTitle">
 655                                         Method Detail
 656                                 </div>
 657
 658                                         <a name="deactivate"> </a>
 659                                         <div class="fixedFont">
 660
 661
 662                                         <b>deactivate</b>()
 663
 664                                         </div>
 665                                         <div class="description">
 666                                                 Tool deactivation event handler.
 667
 668
 669                                         </div>
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681                                         <hr />
 682
 683                                         <a name="draw"> </a>
 684                                         <div class="fixedFont">
 685
 686
 687                                         <b>draw</b>()
 688
 689                                         </div>
 690                                         <div class="description">
 691                                                 Draw the points in the stack. This function is called every few
 692 milliseconds.
 693
 694
 695                                         </div>
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706                                                         <dl class="detailList">
 707                                                         <dt class="heading">See:</dt>
 708
 709                                                                 <dd>PaintWeb.config.toolDrawDelay</dd>
 710
 711                                                         </dl>
 712
 713
 714                                         <hr />
 715
 716                                         <a name="keydown"> </a>
 717                                         <div class="fixedFont">
 718
 719                                         <span class="light">{Boolean}</span>
 720                                         <b>keydown</b>(ev)
 721
 722                                         </div>
 723                                         <div class="description">
 724                                                 Allows the user to press <kbd>Escape</kbd> to cancel the drawing operation.
 725
 726
 727                                         </div>
 728
 729
 730
 731
 732                                                         <dl class="detailList">
 733                                                         <dt class="heading">Parameters:</dt>
 734
 735                                                                 <dt>
 736                                                                         <span class="light fixedFont">{Event}</span> <b>ev</b>
 737
 738                                                                 </dt>
 739                                                                 <dd>The DOM Event object.</dd>
 740
 741                                                         </dl>
 742
 743
 744
 745
 746
 747                                                         <dl class="detailList">
 748                                                         <dt class="heading">Returns:</dt>
 749
 750                                                                 <dd><span class="light fixedFont">{Boolean}</span> True if the drawing operation was cancelled, or false if
 751 not.</dd>
 752
 753                                                         </dl>
 754
 755
 756
 757
 758                                         <hr />
 759
 760                                         <a name="mousedown"> </a>
 761                                         <div class="fixedFont">
 762
 763
 764                                         <b>mousedown</b>()
 765
 766                                         </div>
 767                                         <div class="description">
 768                                                 Initialize the drawing operation.
 769
 770
 771                                         </div>
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783                                         <hr />
 784
 785                                         <a name="mousemove"> </a>
 786                                         <div class="fixedFont">
 787
 788
 789                                         <b>mousemove</b>()
 790
 791                                         </div>
 792                                         <div class="description">
 793                                                 Save the mouse coordinates in the array.
 794
 795
 796                                         </div>
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808                                         <hr />
 809
 810                                         <a name="mouseup"> </a>
 811                                         <div class="fixedFont">
 812
 813
 814                                         <b>mouseup</b>()
 815
 816                                         </div>
 817                                         <div class="description">
 818                                                 End the drawing operation, once the user releases the mouse button.
 819
 820
 821                                         </div>
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837 <!-- ============================== event details ========================= -->
 838
 839
 840                         <hr />
 841                 </div>
 842
 843
 844 <!-- ============================== footer ================================= -->
 845                 <div class="fineprint" style="clear:both">
 846
 847                         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)
 848                 </div>
 849         </body>
 850 </html>