lib/paintweb/docs/api-ref/symbols/pwlib.extensions.moodle.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.moodle</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.moodle
 326                         </h1>
 327
 328 <!-- ============================== class summary ========================== -->
 329                         <p class="description">
 330
 331
 332                                 The Moodle extension for PaintWeb. This extension handles the Moodle
 333 integration inside the PaintWeb code.
 334
 335
 336                                         <br /><i>Defined in: </i> <a href="../symbols/src/src_extensions_moodle.js.html">moodle.js</a>.
 337
 338                         </p>
 339
 340 <!-- ============================== constructor summary ==================== -->
 341
 342                         <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pwlib.extensions.moodle.">
 343                                 <caption>Class Summary</caption>
 344                                 <thead>
 345                                         <tr>
 346                                                 <th scope="col">Constructor Attributes</th>
 347                                                 <th scope="col">Constructor Name and Description</th>
 348                                         </tr>
 349                                 </thead>
 350                                 <tbody>
 351                                         <tr>
 352                                                 <td class="attributes">&nbsp;</td>
 353                                                 <td class="nameDescription" >
 354                                                         <div class="fixedFont">
 355                                                                 <b><a href="../symbols/pwlib.extensions.moodle.html#constructor">pwlib.extensions.moodle</a></b>(app)
 356                                                         </div>
 357                                                         <div class="description"></div>
 358                                                 </td>
 359                                         </tr>
 360                                 </tbody>
 361                         </table>
 362
 363
 364 <!-- ============================== properties summary ===================== -->
 365
 366
 367 <!-- ============================== methods summary ======================== -->
 368
 369
 370
 371                                 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.extensions.moodle.">
 372                                         <caption>Method Summary</caption>
 373                                         <thead>
 374                                                 <tr>
 375                                                         <th scope="col">Method Attributes</th>
 376                                                         <th scope="col">Method Name and Description</th>
 377                                                 </tr>
 378                                         </thead>
 379                                         <tbody>
 380
 381                                                 <tr>
 382                                                         <td class="attributes">&nbsp;</td>
 383                                                         <td class="nameDescription">
 384                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.moodle.html#extensionRegister">extensionRegister</a></b>()
 385                                                                 </div>
 386                                                                 <div class="description">The <code>extensionRegister</code> event handler.</div>
 387                                                         </td>
 388                                                 </tr>
 389
 390                                                 <tr>
 391                                                         <td class="attributes">&nbsp;</td>
 392                                                         <td class="nameDescription">
 393                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.moodle.html#extensionUnregister">extensionUnregister</a></b>()
 394                                                                 </div>
 395                                                                 <div class="description">The <code>extensionUnregister</code> event handler.</div>
 396                                                         </td>
 397                                                 </tr>
 398
 399                                                 <tr>
 400                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 401                                                         <td class="nameDescription">
 402                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.moodle.html#guiHide">guiHide</a></b>()
 403                                                                 </div>
 404                                                                 <div class="description">The <code>guiHide</code> application event handler.</div>
 405                                                         </td>
 406                                                 </tr>
 407
 408                                                 <tr>
 409                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 410                                                         <td class="nameDescription">
 411                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.moodle.html#guiShow">guiShow</a></b>()
 412                                                                 </div>
 413                                                                 <div class="description">The <code>guiShow</code> application event handler.</div>
 414                                                         </td>
 415                                                 </tr>
 416
 417                                                 <tr>
 418                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 419                                                         <td class="nameDescription">
 420                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.moodle.html#imageSave">imageSave</a></b>(ev)
 421                                                                 </div>
 422                                                                 <div class="description">The <code>imageSave</code> application event handler.</div>
 423                                                         </td>
 424                                                 </tr>
 425
 426                                                 <tr>
 427                                                         <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
 428                                                         <td class="nameDescription">
 429                                                                 <div class="fixedFont"><b><a href="../symbols/pwlib.extensions.moodle.html#-imageSaveReady">imageSaveReady</a></b>(xhr)
 430                                                                 </div>
 431                                                                 <div class="description">The image save <code>onreadystatechange</code> event handler for the
 432 <code>XMLHttpRequest</code> which performs the image save.</div>
 433                                                         </td>
 434                                                 </tr>
 435
 436                                         </tbody>
 437                                 </table>
 438
 439
 440
 441
 442 <!-- ============================== events summary ======================== -->
 443
 444
 445 <!-- ============================== constructor details ==================== -->
 446
 447                         <div class="details"><a name="constructor"> </a>
 448                                 <div class="sectionTitle">
 449                                         Class Detail
 450                                 </div>
 451
 452                                 <div class="fixedFont">
 453                                                 <b>pwlib.extensions.moodle</b>(app)
 454                                 </div>
 455
 456                                 <div class="description">
 457
 458
 459                                 </div>
 460
 461
 462
 463
 464
 465                                                 <dl class="detailList">
 466                                                 <dt class="heading">Parameters:</dt>
 467
 468                                                         <dt>
 469                                                                 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span>  <b>app</b>
 470
 471                                                         </dt>
 472                                                                 <dd>Reference to the main paint application object.</dd>
 473
 474                                                 </dl>
 475
 476
 477
 478
 479
 480
 481
 482
 483                         </div>
 484
 485
 486 <!-- ============================== field details ========================== -->
 487
 488
 489 <!-- ============================== method details ========================= -->
 490
 491                                 <div class="sectionTitle">
 492                                         Method Detail
 493                                 </div>
 494
 495                                         <a name="extensionRegister"> </a>
 496                                         <div class="fixedFont">
 497
 498                                         <span class="light">{Boolean}</span>
 499                                         <b>extensionRegister</b>()
 500
 501                                         </div>
 502                                         <div class="description">
 503                                                 The <code>extensionRegister</code> event handler.
 504
 505
 506                                         </div>
 507
 508
 509
 510
 511
 512
 513
 514
 515                                                         <dl class="detailList">
 516                                                         <dt class="heading">Returns:</dt>
 517
 518                                                                 <dd><span class="light fixedFont">{Boolean}</span> True if the extension initialized successfully, or false
 519 if not.</dd>
 520
 521                                                         </dl>
 522
 523
 524
 525
 526                                         <hr />
 527
 528                                         <a name="extensionUnregister"> </a>
 529                                         <div class="fixedFont">
 530
 531
 532                                         <b>extensionUnregister</b>()
 533
 534                                         </div>
 535                                         <div class="description">
 536                                                 The <code>extensionUnregister</code> event handler.
 537
 538
 539                                         </div>
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551                                         <hr />
 552
 553                                         <a name="guiHide"> </a>
 554                                         <div class="fixedFont">&lt;private&gt;
 555
 556
 557                                         <b>guiHide</b>()
 558
 559                                         </div>
 560                                         <div class="description">
 561                                                 The <code>guiHide</code> application event handler. When the PaintWeb GUI
 562 is hidden, we must show again the textarea icons for the current textarea
 563 element, inside a Moodle page.
 564
 565
 566                                         </div>
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578                                         <hr />
 579
 580                                         <a name="guiShow"> </a>
 581                                         <div class="fixedFont">&lt;private&gt;
 582
 583
 584                                         <b>guiShow</b>()
 585
 586                                         </div>
 587                                         <div class="description">
 588                                                 The <code>guiShow</code> application event handler. When the PaintWeb GUI
 589 is shown, we must hide the textarea icons for the current textarea element,
 590 inside a Moodle page.
 591
 592
 593                                         </div>
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605                                         <hr />
 606
 607                                         <a name="imageSave"> </a>
 608                                         <div class="fixedFont">&lt;private&gt;
 609
 610
 611                                         <b>imageSave</b>(ev)
 612
 613                                         </div>
 614                                         <div class="description">
 615                                                 The <code>imageSave</code> application event handler. When the user
 616 attempts to save an image, this extension handles the event by sending the
 617 image data to the Moodle server, to perform the actual save operation.
 618
 619
 620                                         </div>
 621
 622
 623
 624
 625                                                         <dl class="detailList">
 626                                                         <dt class="heading">Parameters:</dt>
 627
 628                                                                 <dt>
 629                                                                         <span class="light fixedFont">{<a href="../symbols/pwlib.appEvent.imageSave.html">pwlib.appEvent.imageSave</a>}</span> <b>ev</b>
 630
 631                                                                 </dt>
 632                                                                 <dd>The application event object.</dd>
 633
 634                                                         </dl>
 635
 636
 637
 638
 639
 640
 641
 642
 643                                         <hr />
 644
 645                                         <a name="-imageSaveReady"> </a>
 646                                         <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
 647
 648
 649                                         <b>imageSaveReady</b>(xhr)
 650
 651                                         </div>
 652                                         <div class="description">
 653                                                 The image save <code>onreadystatechange</code> event handler for the
 654 <code>XMLHttpRequest</code> which performs the image save. This function
 655 uses the reply to determine if the image save operation is successful or
 656 not.
 657
 658 <p>The <a href="../symbols/pwlib.appEvent.imageSaveResult.html">pwlib.appEvent.imageSaveResult</a> application event is
 659 dispatched.
 660
 661 <p>The server-side script must reply with a JSON object with the following
 662 properties:
 663
 664 <ul>
 665   <li><var>successful</var> which tells if the image save operation was
 666   successful or not;
 667
 668   <li><var>url</var> which must tell the same URL as the image we just
 669   saved (sanity/security check);
 670
 671   <li><var>urlNew</var> is optional. This allows the server-side script to
 672   change the image URL;
 673
 674   <li><var>errorMessage</var> is optional. When the image save was not
 675   successful, an error message can be displayed.
 676 </ul>
 677
 678
 679                                         </div>
 680
 681
 682
 683
 684                                                         <dl class="detailList">
 685                                                         <dt class="heading">Parameters:</dt>
 686
 687                                                                 <dt>
 688                                                                         <span class="light fixedFont">{XMLHttpRequest}</span> <b>xhr</b>
 689
 690                                                                 </dt>
 691                                                                 <dd>The XMLHttpRequest object.</dd>
 692
 693                                                         </dl>
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706 <!-- ============================== event details ========================= -->
 707
 708
 709                         <hr />
 710                 </div>
 711
 712
 713 <!-- ============================== footer ================================= -->
 714                 <div class="fineprint" style="clear:both">
 715
 716                         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)
 717                 </div>
 718         </body>
 719 </html>