lib/paintweb/docs/api-ref/symbols/pwlib.extensions.mousekeys.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.extensions.mousekeys</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.extensions.mousekeys
 326                         </h1>
 327
 328 <!-- ============================== class summary ========================== -->
 329                         <p class="description">
 330
 331
 332                                 The MouseKeys extension.
 333
 334
 335                                         <br /><i>Defined in: </i> <a href="../symbols/src/src_extensions_mousekeys.js.html">mousekeys.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.extensions.mousekeys.">
 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.extensions.mousekeys.html#constructor">pwlib.extensions.mousekeys</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.extensions.mousekeys.">
 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.extensions.mousekeys.html#-accel">accel</a></b>
 382                                                                 </div>
 383                                                                 <div class="description">Holds the current mouse movement acceleration, taken from the
 384 configuration.</div>
 385                                                         </td>
 386                                                 </tr>
 387
 388                                                 <tr>
 389                                                         <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
 390                                                         <td class="nameDescription">
 391                                                                 <div class="fixedFont">
 392                                                                 <b><a href="../symbols/pwlib.extensions.mousekeys.html#-pointer">pointer</a></b>
 393                                                                 </div>
 394                                                                 <div class="description">Holds a reference to the DOM element representing the pointer on top of the
 395 canvas element.</div>
 396                                                         </td>
 397                                                 </tr>
 398
 399                                                 <tr>
 400                                                         <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
 401                                                         <td class="nameDescription">
 402                                                                 <div class="fixedFont">
 403                                                                 <b><a href="../symbols/pwlib.extensions.mousekeys.html#-speed">speed</a></b>
 404                                                                 </div>
 405                                                                 <div class="description">Holds the current mouse movement speed in pixels.</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.extensions.mousekeys.">
 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.extensions.mousekeys.html#extensionRegister">extensionRegister</a></b>()
 434                                                                 </div>
 435                                                                 <div class="description">The <code>extensionRegister</code> 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.extensions.mousekeys.html#extensionUnregister">extensionUnregister</a></b>()
 443                                                                 </div>
 444                                                                 <div class="description">The <code>extensionUnregister</code> event handler.</div>
 445                                                         </td>
 446                                                 </tr>
 447
 448                                                 <tr>
 449                                                         <td class="attributes">&nbsp;</td>
 450                                                         <td class="nameDescription">
 451                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.mousekeys.html#keydown">keydown</a></b>(ev)
 452                                                                 </div>
 453                                                                 <div class="description">The <code>keydown</code> event handler.</div>
 454                                                         </td>
 455                                                 </tr>
 456
 457                                                 <tr>
 458                                                         <td class="attributes">&nbsp;</td>
 459                                                         <td class="nameDescription">
 460                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.mousekeys.html#keypress">keypress</a></b>(ev)
 461                                                                 </div>
 462                                                                 <div class="description">The <code>keypress</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.extensions.mousekeys.html#keyup">keyup</a></b>(ev)
 470                                                                 </div>
 471                                                                 <div class="description">The <code>keyup</code> event handler.</div>
 472                                                         </td>
 473                                                 </tr>
 474
 475                                                 <tr>
 476                                                         <td class="attributes">&lt;inner&gt; &nbsp;</td>
 477                                                         <td class="nameDescription">
 478                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.mousekeys.html#-pointerMousemove">pointerMousemove</a></b>(ev)
 479                                                                 </div>
 480                                                                 <div class="description">Track the virtual pointer coordinates, by updating the position of the
 481 <var>pointer</var> element.</div>
 482                                                         </td>
 483                                                 </tr>
 484
 485                                         </tbody>
 486                                 </table>
 487
 488
 489
 490
 491 <!-- ============================== events summary ======================== -->
 492
 493
 494 <!-- ============================== constructor details ==================== -->
 495
 496                         <div class="details"><a name="constructor"> </a>
 497                                 <div class="sectionTitle">
 498                                         Class Detail
 499                                 </div>
 500
 501                                 <div class="fixedFont">
 502                                                 <b>pwlib.extensions.mousekeys</b>(app)
 503                                 </div>
 504
 505                                 <div class="description">
 506
 507
 508                                 </div>
 509
 510
 511
 512
 513
 514                                                 <dl class="detailList">
 515                                                 <dt class="heading">Parameters:</dt>
 516
 517                                                         <dt>
 518                                                                 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span>  <b>app</b>
 519
 520                                                         </dt>
 521                                                                 <dd>Reference to the main paint application object.</dd>
 522
 523                                                 </dl>
 524
 525
 526
 527
 528
 529
 530
 531
 532                         </div>
 533
 534
 535 <!-- ============================== field details ========================== -->
 536
 537                                 <div class="sectionTitle">
 538                                         Field Detail
 539                                 </div>
 540
 541                                         <a name="-accel"> </a>
 542                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 543
 544                                         <span class="light">{Number}</span>
 545                                         <b>accel</b>
 546
 547                                         </div>
 548                                         <div class="description">
 549                                                 Holds the current mouse movement acceleration, taken from the
 550 configuration.
 551
 552
 553                                         </div>
 554
 555
 556
 557
 558
 559
 560                                                         <dl class="detailList">
 561                                                         <dt class="heading">See:</dt>
 562
 563                                                         <dd>PaintWeb.config.mousekeys.accel The mouse keys acceleration setting.</dd>
 564
 565                                                         </dl>
 566
 567
 568
 569                                         <hr />
 570
 571                                         <a name="-pointer"> </a>
 572                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 573
 574                                         <span class="light">{Element}</span>
 575                                         <b>pointer</b>
 576
 577                                         </div>
 578                                         <div class="description">
 579                                                 Holds a reference to the DOM element representing the pointer on top of the
 580 canvas element.
 581
 582
 583                                         </div>
 584
 585
 586
 587
 588
 589
 590
 591
 592                                         <hr />
 593
 594                                         <a name="-speed"> </a>
 595                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 596
 597                                         <span class="light">{Number}</span>
 598                                         <b>speed</b>
 599
 600                                         </div>
 601                                         <div class="description">
 602                                                 Holds the current mouse movement speed in pixels.
 603
 604
 605                                         </div>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618 <!-- ============================== method details ========================= -->
 619
 620                                 <div class="sectionTitle">
 621                                         Method Detail
 622                                 </div>
 623
 624                                         <a name="extensionRegister"> </a>
 625                                         <div class="fixedFont">
 626
 627                                         <span class="light">{Boolean}</span>
 628                                         <b>extensionRegister</b>()
 629
 630                                         </div>
 631                                         <div class="description">
 632                                                 The <code>extensionRegister</code> event handler. This initializes the
 633 extension by adding the pointer DOM element and by setting up the keyboard
 634 shortcuts.
 635
 636
 637                                         </div>
 638
 639
 640
 641
 642
 643
 644
 645
 646                                                         <dl class="detailList">
 647                                                         <dt class="heading">Returns:</dt>
 648
 649                                                                 <dd><span class="light fixedFont">{Boolean}</span> True if the extension initialized successfully, or false
 650 if not.</dd>
 651
 652                                                         </dl>
 653
 654
 655
 656
 657                                         <hr />
 658
 659                                         <a name="extensionUnregister"> </a>
 660                                         <div class="fixedFont">
 661
 662
 663                                         <b>extensionUnregister</b>()
 664
 665                                         </div>
 666                                         <div class="description">
 667                                                 The <code>extensionUnregister</code> event handler. This will remove the
 668 pointer DOM element and the canvas event listener.
 669
 670
 671                                         </div>
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683                                         <hr />
 684
 685                                         <a name="keydown"> </a>
 686                                         <div class="fixedFont">
 687
 688                                         <span class="light">{Boolean}</span>
 689                                         <b>keydown</b>(ev)
 690
 691                                         </div>
 692                                         <div class="description">
 693                                                 The <code>keydown</code> event handler.
 694
 695 <p>This method requires a DOM Event object which has the
 696 <var>ev.kobj_</var> object reference from the keyboard shortcuts
 697 configuration. The <var>kobj_</var> object must have the <var>action</var>
 698 property. Support for the "ButtonToggle" and the "ButtonClick" actions is
 699 implemented.
 700
 701 <p>The "ButtonToggle" action essentially means that a mouse event will be
 702 generated, either <code>mousedown</code> or <code>mouseup</code>. By
 703 alternating these two events, this method allows the user to start and stop
 704 the drawing operation at any moment using the keyboard shortcut they have
 705 configured.
 706
 707 <p>Under typical usage, the "ButtonClick" action translates the
 708 <code>keydown</code> event to <code>mousedown</code>. The
 709 <code>keyup</code> event handler will also fire the <code>mouseup</code>
 710 event. This allows the user to simulate holding down the mouse button,
 711 while he/she holds down a key.
 712
 713 <p>A <code>click</code> event is always fired after the firing of
 714 a <code>mouseup</code> event.
 715
 716 <p>Irrespective of the key the user pressed, this method does always reset
 717 the speed and acceleration of the pointer movement.
 718
 719
 720                                         </div>
 721
 722
 723
 724
 725                                                         <dl class="detailList">
 726                                                         <dt class="heading">Parameters:</dt>
 727
 728                                                                 <dt>
 729                                                                         <span class="light fixedFont">{Event}</span> <b>ev</b>
 730
 731                                                                 </dt>
 732                                                                 <dd>The DOM Event object.</dd>
 733
 734                                                         </dl>
 735
 736
 737
 738
 739
 740                                                         <dl class="detailList">
 741                                                         <dt class="heading">Returns:</dt>
 742
 743                                                                 <dd><span class="light fixedFont">{Boolean}</span> True if the keyboard shortcut was recognized, or false
 744 if not.</dd>
 745
 746                                                         </dl>
 747
 748
 749
 750                                                         <dl class="detailList">
 751                                                         <dt class="heading">See:</dt>
 752
 753                                                                 <dd>PaintWeb.config.mousekeys.actions The keyboard shortcuts configuration
 754 object.</dd>
 755
 756                                                         </dl>
 757
 758
 759                                         <hr />
 760
 761                                         <a name="keypress"> </a>
 762                                         <div class="fixedFont">
 763
 764                                         <span class="light">{Boolean}</span>
 765                                         <b>keypress</b>(ev)
 766
 767                                         </div>
 768                                         <div class="description">
 769                                                 The <code>keypress</code> event handler.
 770
 771 <p>This method requires a DOM Event object with a <var>ev.kobj_</var>
 772 object reference to the keyboard shortcut configuration. The keyboard
 773 shortcut configuration object must have the <var>action</var> property.
 774
 775 <p>This event handler implements support for the following <var>param</var>
 776 values: "SouthWest", "South", "SouthEast", "West", "East", "NorthWest",
 777 "North" and "NorthEast", All of these values indicate the movement
 778 direction. This method generates synthetic <var>movemove</var> events based
 779 on the direction desired, effectively emulating the use of a real pointing
 780 device.
 781
 782
 783                                         </div>
 784
 785
 786
 787
 788                                                         <dl class="detailList">
 789                                                         <dt class="heading">Parameters:</dt>
 790
 791                                                                 <dt>
 792                                                                         <span class="light fixedFont">{Event}</span> <b>ev</b>
 793
 794                                                                 </dt>
 795                                                                 <dd>The DOM Event object.</dd>
 796
 797                                                         </dl>
 798
 799
 800
 801
 802
 803                                                         <dl class="detailList">
 804                                                         <dt class="heading">Returns:</dt>
 805
 806                                                                 <dd><span class="light fixedFont">{Boolean}</span> True if the keyboard shortcut was recognized, or false
 807 if not.</dd>
 808
 809                                                         </dl>
 810
 811
 812
 813                                                         <dl class="detailList">
 814                                                         <dt class="heading">See:</dt>
 815
 816                                                                 <dd>PaintWeb.config.mousekeys.actions The keyboard shortcuts configuration
 817 object.</dd>
 818
 819                                                         </dl>
 820
 821
 822                                         <hr />
 823
 824                                         <a name="keyup"> </a>
 825                                         <div class="fixedFont">
 826
 827                                         <span class="light">{Boolean}</span>
 828                                         <b>keyup</b>(ev)
 829
 830                                         </div>
 831                                         <div class="description">
 832                                                 The <code>keyup</code> event handler.
 833
 834 <p>This method requires a DOM Event object which has the
 835 <var>ev.kobj_</var> object reference from the keyboard shortcuts
 836 configuration. The <var>kobj_</var> object must have the <var>action</var>
 837 property. Support for the "ButtonClick" action is implemented.
 838
 839 <p>Under typical usage, the "ButtonClick" action translates the
 840 <code>keydown</code> event to <code>mousedown</code>. This event handler
 841 fires the <code>mouseup</code> event. This allows the user to simulate
 842 holding down the mouse button, while he/she holds down a key.
 843
 844 <p>A <code>click</code> event is always fired after the firing of the
 845 <code>mouseup</code> event.
 846
 847
 848                                         </div>
 849
 850
 851
 852
 853                                                         <dl class="detailList">
 854                                                         <dt class="heading">Parameters:</dt>
 855
 856                                                                 <dt>
 857                                                                         <span class="light fixedFont">{Event}</span> <b>ev</b>
 858
 859                                                                 </dt>
 860                                                                 <dd>The DOM Event object.</dd>
 861
 862                                                         </dl>
 863
 864
 865
 866
 867
 868                                                         <dl class="detailList">
 869                                                         <dt class="heading">Returns:</dt>
 870
 871                                                                 <dd><span class="light fixedFont">{Boolean}</span> True if the keyboard shortcut was recognized, or false
 872 if not.</dd>
 873
 874                                                         </dl>
 875
 876
 877
 878                                                         <dl class="detailList">
 879                                                         <dt class="heading">See:</dt>
 880
 881                                                                 <dd>PaintWeb.config.mousekeys.actions The keyboard shortcuts configuration
 882 object.</dd>
 883
 884                                                         </dl>
 885
 886
 887                                         <hr />
 888
 889                                         <a name="-pointerMousemove"> </a>
 890                                         <div class="fixedFont">&lt;inner&gt;
 891
 892
 893                                         <b>pointerMousemove</b>(ev)
 894
 895                                         </div>
 896                                         <div class="description">
 897                                                 Track the virtual pointer coordinates, by updating the position of the
 898 <var>pointer</var> element. This allows the keyboard users to see where
 899 they moved the virtual pointer.
 900
 901
 902                                         </div>
 903
 904
 905
 906
 907                                                         <dl class="detailList">
 908                                                         <dt class="heading">Parameters:</dt>
 909
 910                                                                 <dt>
 911                                                                         <span class="light fixedFont">{Event}</span> <b>ev</b>
 912
 913                                                                 </dt>
 914                                                                 <dd>The DOM Event object.</dd>
 915
 916                                                         </dl>
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929 <!-- ============================== event details ========================= -->
 930
 931
 932                         <hr />
 933                 </div>
 934
 935
 936 <!-- ============================== footer ================================= -->
 937                 <div class="fineprint" style="clear:both">
 938
 939                         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:22 GMT+0300 (EEST)
 940                 </div>
 941         </body>
 942 </html>