lib/paintweb/docs/api-ref/symbols/pwlib.browser.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.browser</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                                 Namespace pwlib.browser
 326                         </h1>
 327
 328 <!-- ============================== class summary ========================== -->
 329                         <p class="description">
 330
 331
 332                                 Holds browser information.
 333
 334
 335                                         <br /><i>Defined in: </i> <a href="../symbols/src/src_includes_lib.js.html">lib.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.browser.">
 342                                 <caption>Namespace 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.browser.html#constructor">pwlib.browser</a></b>
 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.browser.">
 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;static&gt; &nbsp;</td>
 379                                                         <td class="nameDescription">
 380                                                                 <div class="fixedFont">
 381                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.firefox">firefox</a></b>
 382                                                                 </div>
 383                                                                 <div class="description">Firefox uses the Gecko render engine.</div>
 384                                                         </td>
 385                                                 </tr>
 386
 387                                                 <tr>
 388                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 389                                                         <td class="nameDescription">
 390                                                                 <div class="fixedFont">
 391                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.gecko">gecko</a></b>
 392                                                                 </div>
 393                                                                 <div class="description">Gecko is the render engine used by Firefox and related products.</div>
 394                                                         </td>
 395                                                 </tr>
 396
 397                                                 <tr>
 398                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 399                                                         <td class="nameDescription">
 400                                                                 <div class="fixedFont">
 401                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.msie">msie</a></b>
 402                                                                 </div>
 403                                                                 <div class="description">Microsoft Internet Explorer.</div>
 404                                                         </td>
 405                                                 </tr>
 406
 407                                                 <tr>
 408                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 409                                                         <td class="nameDescription">
 410                                                                 <div class="fixedFont">
 411                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.olpcxo">olpcxo</a></b>
 412                                                                 </div>
 413                                                                 <div class="description">Tells if the browser is running on an OLPC XO.</div>
 414                                                         </td>
 415                                                 </tr>
 416
 417                                                 <tr>
 418                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 419                                                         <td class="nameDescription">
 420                                                                 <div class="fixedFont">
 421                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.opera">opera</a></b>
 422                                                                 </div>
 423                                                                 <div class="description"></div>
 424                                                         </td>
 425                                                 </tr>
 426
 427                                                 <tr>
 428                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 429                                                         <td class="nameDescription">
 430                                                                 <div class="fixedFont">
 431                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.os">os</a></b>
 432                                                                 </div>
 433                                                                 <div class="description">Browser operating system</div>
 434                                                         </td>
 435                                                 </tr>
 436
 437                                                 <tr>
 438                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 439                                                         <td class="nameDescription">
 440                                                                 <div class="fixedFont">
 441                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.presto">presto</a></b>
 442                                                                 </div>
 443                                                                 <div class="description">Presto is the render engine used by Opera.</div>
 444                                                         </td>
 445                                                 </tr>
 446
 447                                                 <tr>
 448                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 449                                                         <td class="nameDescription">
 450                                                                 <div class="fixedFont">
 451                                                                 pwlib.browser.<b><a href="../symbols/pwlib.browser.html#.webkit">webkit</a></b>
 452                                                                 </div>
 453                                                                 <div class="description">Webkit is the render engine used primarily by Safari.</div>
 454                                                         </td>
 455                                                 </tr>
 456
 457                                         </tbody>
 458                                 </table>
 459
 460
 461
 462
 463
 464 <!-- ============================== methods summary ======================== -->
 465
 466 <!-- ============================== events summary ======================== -->
 467
 468
 469 <!-- ============================== constructor details ==================== -->
 470
 471                         <div class="details"><a name="constructor"> </a>
 472                                 <div class="sectionTitle">
 473                                         Namespace Detail
 474                                 </div>
 475
 476                                 <div class="fixedFont">
 477                                                 <b>pwlib.browser</b>
 478                                 </div>
 479
 480                                 <div class="description">
 481
 482
 483                                 </div>
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496                         </div>
 497
 498
 499 <!-- ============================== field details ========================== -->
 500
 501                                 <div class="sectionTitle">
 502                                         Field Detail
 503                                 </div>
 504
 505                                         <a name=".firefox"> </a>
 506                                         <div class="fixedFont">&lt;static&gt;
 507
 508                                         <span class="light">{Boolean}</span>
 509                                         <span class="light">pwlib.browser.</span><b>firefox</b>
 510
 511                                         </div>
 512                                         <div class="description">
 513                                                 Firefox uses the Gecko render engine.
 514
 515
 516                                         </div>
 517
 518
 519
 520
 521
 522
 523
 524
 525                                         <hr />
 526
 527                                         <a name=".gecko"> </a>
 528                                         <div class="fixedFont">&lt;static&gt;
 529
 530                                         <span class="light">{Boolean}</span>
 531                                         <span class="light">pwlib.browser.</span><b>gecko</b>
 532
 533                                         </div>
 534                                         <div class="description">
 535                                                 Gecko is the render engine used by Firefox and related products.
 536
 537
 538                                         </div>
 539
 540
 541
 542
 543
 544
 545
 546
 547                                         <hr />
 548
 549                                         <a name=".msie"> </a>
 550                                         <div class="fixedFont">&lt;static&gt;
 551
 552                                         <span class="light">{Boolean}</span>
 553                                         <span class="light">pwlib.browser.</span><b>msie</b>
 554
 555                                         </div>
 556                                         <div class="description">
 557                                                 Microsoft Internet Explorer. The future of computing.
 558
 559
 560                                         </div>
 561
 562
 563
 564
 565
 566
 567
 568
 569                                         <hr />
 570
 571                                         <a name=".olpcxo"> </a>
 572                                         <div class="fixedFont">&lt;static&gt;
 573
 574                                         <span class="light">{Boolean}</span>
 575                                         <span class="light">pwlib.browser.</span><b>olpcxo</b>
 576
 577                                         </div>
 578                                         <div class="description">
 579                                                 Tells if the browser is running on an OLPC XO. Typically, only the default
 580 Gecko-based browser includes the OLPC XO tokens in the user agent string.
 581
 582
 583                                         </div>
 584
 585
 586
 587
 588
 589
 590
 591
 592                                         <hr />
 593
 594                                         <a name=".opera"> </a>
 595                                         <div class="fixedFont">&lt;static&gt;
 596
 597                                         <span class="light">{Boolean}</span>
 598                                         <span class="light">pwlib.browser.</span><b>opera</b>
 599
 600                                         </div>
 601                                         <div class="description">
 602
 603
 604
 605                                         </div>
 606
 607
 608
 609
 610
 611
 612
 613
 614                                         <hr />
 615
 616                                         <a name=".os"> </a>
 617                                         <div class="fixedFont">&lt;static&gt;
 618
 619                                         <span class="light">{String}</span>
 620                                         <span class="light">pwlib.browser.</span><b>os</b>
 621
 622                                         </div>
 623                                         <div class="description">
 624                                                 Browser operating system
 625
 626
 627                                         </div>
 628
 629
 630
 631
 632
 633
 634
 635
 636                                         <hr />
 637
 638                                         <a name=".presto"> </a>
 639                                         <div class="fixedFont">&lt;static&gt;
 640
 641                                         <span class="light">{Boolean}</span>
 642                                         <span class="light">pwlib.browser.</span><b>presto</b>
 643
 644                                         </div>
 645                                         <div class="description">
 646                                                 Presto is the render engine used by Opera.
 647
 648
 649                                         </div>
 650
 651
 652
 653
 654
 655
 656
 657
 658                                         <hr />
 659
 660                                         <a name=".webkit"> </a>
 661                                         <div class="fixedFont">&lt;static&gt;
 662
 663                                         <span class="light">{Boolean}</span>
 664                                         <span class="light">pwlib.browser.</span><b>webkit</b>
 665
 666                                         </div>
 667                                         <div class="description">
 668                                                 Webkit is the render engine used primarily by Safari. It's also used by
 669 Google Chrome and GNOME Epiphany.
 670
 671
 672                                         </div>
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685 <!-- ============================== method details ========================= -->
 686
 687
 688 <!-- ============================== event details ========================= -->
 689
 690
 691                         <hr />
 692                 </div>
 693
 694
 695 <!-- ============================== footer ================================= -->
 696                 <div class="fineprint" style="clear:both">
 697
 698                         Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Mon Jul 27 2009 14:56:56 GMT+0300 (EEST)
 699                 </div>
 700         </body>
 701 </html>