git.roojs.org Git - gnome.introspection-doc-generator/blob - docs/class.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:roo="http://www.akbkhome.com/roojs1/" xml:lang="en" lang="en">
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9                 {! Link.base = "../"; /* all generated links will be relative to this */ !}
  10
  11                 <title>JsDoc Reference - {+data.name+}</title>
  12
  13         <script type="text/javascript" src="page.js"></script>
  14
  15         <link rel="stylesheet" type="text/css" href="default.css" />
  16         <link rel="stylesheet" type="text/css" href="library_gnome.css"></link>
  17         <link media="print" rel="stylesheet" type="text/css" href="library_gnome_print.css"></link>
  18
  19
  20         </head>
  21
  22         <body onload="RooDocsPage.onload();">
  23
  24         <div id="page">
  25
  26         <div id="header">
  27             <div id="header-wrap">
  28                 <h1>
  29                     Un-official Seed Documentation<!-- GNOME Documentation Library-->
  30                 </h1>
  31
  32             </div>
  33         </div>
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45         <div class="left-class-list"  style="width:18%;float:left;">
  46             <a href="index.html"> Back to Seed Clases </a>
  47             <br/><br/>
  48             {+data.left_bar+}
  49         </div>
  50
  51  <div class="body-wrap" style="width:78%;float:left;">
  52
  53     <!-- ============================== links to methods. ================================= -->
  54
  55     <div class="top-tools">
  56     <!--
  57         <a class="inner-link" href="#{+data.name+}-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  58         <a class="inner-link" href="#{+data.name+}-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  59         <a class="inner-link" href="#{+data.name+}-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  60         <a class="inner-link" href="#{+data.name+}-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  61         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  62         -->
  63     </div>
  64
  65
  66
  67
  68
  69 <!-- ============================== inheritance Block. ================================= -->
  70         <if test="data.extendsClasses.length">
  71                 <div class="inheritance res-block">
  72                    <p class="res-block-inner">{!
  73                                 var iblock_indent = 0;
  74
  75
  76                                  data.extendsClasses.reverse().map(
  77                                         function($) {
  78
  79                                                 output += (iblock_indent ? '<img src="elbow-end.gif" class="elbow elbow_indent' +
  80                             + iblock_indent + '" alt="parent-child marker"/>' : '');
  81                                                 output += new Link().toSymbolLong($.alias);
  82                                                 output += "\n<br/>";
  83                                                 iblock_indent += 1;
  84
  85                                         }
  86                                 )
  87
  88                         !}<img class="elbow elbow_indent{+iblock_indent+}" src="elbow-end.gif" alt="parent-child marker"/>
  89                 {+data.alias+}
  90
  91                    </p>
  92                 </div>
  93        </if>
  94
  95        {+makeImage(data.alias)+}
  96
  97
  98 <!-- ============================== class title / details ============================ -->
  99
 100
 101     <h1 class="classTitle">
 102
 103
 104          {+data.titleType+} {+data.alias+}
 105                         </h1>
 106
 107     <table cellspacing="0" class="class-summary-table">
 108
 109 <if test="data.ns">
 110         <tr>
 111             <td class="label">Import line:</td>
 112             <td class="hd-info">{+data.ns+} = imports.gi.{+data.ns+}; </td>
 113        </tr>
 114 </if>
 115      <tr>
 116             <td class="label">Note:</td>
 117             <td class="hd-info"><b style="color:red">This documentation is generated from the HEAD of most
 118             libraries (and some experimental libs at times) - and may not be exactly the same as your
 119             installed .gir files - you may want to download the generator and install on your machine
 120             to find out what you have.<b/></td>
 121         </tr>
 122         <tr>
 123             <td class="label">C documentation:</td>
 124             <td class="hd-info">{+new Link().toGnome(data.alias)+}</td>
 125         </tr>
 126         <tr>
 127             <td class="label">{+data.titleType+} :</td>
 128             <td class="hd-info">{+data.name+}</td>
 129         </tr>
 130
 131 <if test="data.implementInterfaces && data.implementInterfaces.length">
 132
 133         <tr>
 134             <td class="label">Implements:</td>
 135             <td class="hd-info">
 136                 {+
 137                         data.implementInterfaces.map(
 138                                 function($) { return new Link().toSymbolLong($.alias); }
 139                         ).join(", ")
 140                 +}
 141             </td>
 142         </tr>
 143
 144 </if>
 145 <if test="data.implementedBy && data.implementedBy.length">
 146         <tr>
 147             <td class="label">Implementations:</td>
 148             <td class="hd-info">
 149                 {+
 150                         data.implementedBy
 151                         .sort()
 152                         .map(
 153                                 function($) { return new Link().toSymbolLong($); }
 154                         ).join(", ")
 155                 +}
 156             </td>
 157         </tr>
 158
 159
 160 </if>
 161 <if test="data.childClasses.length">
 162         <tr>
 163             <td class="label">Subclasses:</td>
 164             <td class="hd-info">
 165                 {+
 166                         data.childClasses
 167                         .sort()
 168                         .map(
 169                                 function($) { return new Link().toSymbolLong($); }
 170                         ).join(", ")
 171                 +}
 172
 173
 174
 175             </td>
 176         </tr>
 177 </if>
 178
 179         <if test="data.extendsClasses.length">
 180
 181                 <tr><td class="label">Extends:</td><td class="hd-info">
 182                         {+
 183                                 new Link().toSymbolLong(data.extendsClasses[data.extendsClasses.length -1].alias)
 184
 185                         +}
 186
 187                 </td></tr>
 188         </if>
 189
 190     </table>
 191
 192
 193 <!-- ============================== class summary ========================== -->
 194     <div class="description">
 195         {+resolveLinks(data.desc)+}
 196     </div>
 197
 198
 199 <!-- ============================== Class comment block... ========================== -->
 200 <!--
 201 <div class="comments">
 202         <b>Class Comments / Notes</B> =>
 203         <u onclick="parent.CommentDialog.showCommentId = '{+data.name+}';">[Add Your comment/notes about this class]</u>
 204         <br/>
 205         <iframe frameborder="0"  id="comments-{+data.name+}" style="border: none;width:100%;"
 206                 src="http://www.akbkhome.com/blog.php/SeedComments/{+data.ns+}.{+data.name+}.html"></iframe>
 207 </div>
 208 -->
 209
 210 <!-- ============================== enum values ========================== -->
 211
 212
 213        {!
 214
 215
 216
 217
 218                 cfgProperties = data.values ? data.values.sort(makeSortby("name")) : [];
 219
 220
 221
 222
 223
 224         !}
 225
 226     <div class="hr"></div>
 227     <a id="{+data.alias+}-values"></a>
 228
 229     <if test="!cfgProperties.length">
 230
 231
 232     </if>
 233
 234     <if test="cfgProperties.length">
 235
 236       <table cellspacing="0" class="member-table">
 237       <caption>Values </caption>
 238
 239
 240         <tr>
 241             <th class="sig-header" colspan="2">Properties</th>
 242
 243         </tr>
 244
 245
 246
 247         <for each="dtag" in="cfgProperties">
 248
 249                 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ?   " notInherited" : "") +}">
 250                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 251                     <td class="sig">
 252
 253                         <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
 254                         <div class="fixedFont">
 255                 {+(new Link().toSymbolLong(dtag.type))+} {+data.alias+}.<b  class="itemname">{+dtag.name+}</b> : {+dtag.value+}
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">{+resolveLinks(dtag.desc)+}</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269
 270                 </tr>
 271         </for>
 272
 273     </table>
 274   </if>
 275
 276
 277
 278
 279
 280 <!-- ============================== config options ========================== -->
 281
 282
 283        {!
 284
 285
 286
 287
 288                 cfgProperties = data.properties.sort(makeSortby("name"));
 289
 290
 291
 292
 293
 294         !}
 295
 296     <div class="hr"></div>
 297     <a id="{+data.alias+}-configs"></a>
 298
 299     <if test="!cfgProperties.length">
 300
 301      <table cellspacing="0" class="member-table">
 302       <caption class="Empty">Properties</caption>
 303       <tr><td>None</td></tr>
 304      </table>
 305
 306     </if>
 307
 308     <if test="cfgProperties.length">
 309
 310       <table cellspacing="0" class="member-table">
 311       <caption>Properties </caption>
 312
 313
 314         <tr>
 315             <th class="sig-header" colspan="2">Properties</th>
 316
 317             <th class="msource-header">Defined By</th>
 318         </tr>
 319
 320
 321
 322         <for each="dtag" in="cfgProperties">
 323
 324                 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ?   " notInherited" : "") +}">
 325                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 326                     <td class="sig">
 327
 328                         <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
 329                         <div class="fixedFont">
 330                                 <b  class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbolLong(dtag.type)) : "" )+}
 331                  {+ (dtag.flags ? (dtag.flags & 2 ? '' : 'read only') : '')+}
 332
 333                         </div>
 334
 335                         <div class="mdesc">
 336                             <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
 337                         </div>
 338
 339                         <div class="mdesc">
 340                             <div class="long">{+resolveLinks(dtag.desc)+}</div>
 341                         </div>
 342
 343
 344
 345                     </td>
 346                     <td class="msource">
 347                         {# - fixme - add inheritied as link here #}
 348                         {+ (dtag.memberOf == data.alias) ? dtag.memberOf :  new Link().toSymbolLong(dtag.memberOf) +}
 349
 350                     </td>
 351                 </tr>
 352         </for>
 353
 354     </table>
 355   </if>
 356
 357
 358
 359
 360
 361
 362
 363   <!-- ============================== methods summary / details ======================== -->
 364
 365
 366   <a id="{+data.alias+}-methods"></a>
 367         <!-- constructor?? -->
 368         {!
 369
 370
 371
 372                 var ownMethods = [];
 373                 ownMethods.push.apply(ownMethods, data.constructors.sort(makeSortby("name")));
 374                 ownMethods.push.apply(ownMethods, data.functions.sort(makeSortby("name")));
 375                 ownMethods.push.apply(ownMethods, data.methods.sort(makeSortby("name")));
 376
 377         !}
 378     <!-- constructors, then statics, then dynamics -->
 379
 380
 381
 382     <if test="!ownMethods.length">
 383
 384      <table cellspacing="0" class="member-table">
 385       <caption class="Empty">Public Methods</caption>
 386       <tr><td>None</td></tr>
 387      </table>
 388
 389     </if>
 390     <if test="ownMethods.length">
 391
 392       <table cellspacing="0" class="member-table">
 393       <caption>Methods / Constructors</caption>
 394         <tr>
 395             <th class="sig-header" colspan="2">Method / Constructor</th>
 396             <th class="msource-header">Defined By</th>
 397
 398         </tr>
 399
 400
 401
 402
 403
 404         <for each="member" in="ownMethods">
 405
 406           <tr class="method-row config-row-alt{+$member_i % 2+}{!
 407                   if (member.isConstructor && (!member.params || !member.params.length)) {
 408                           output += '';
 409                  } else {
 410                           output += ' expandable';
 411                         }
 412
 413
 414                 if (member.memberOf == data.alias) {
 415                         output += " notInherited";
 416                  }
 417
 418                  !}">
 419             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 420
 421
 422             <td class="sig">
 423                 <a id="{+member.memberOf+}-method-{+member.name+}"   name=".{+member.name+}"></a>
 424                 <div class="fixedFont">
 425                         <span class="attributes">{!
 426                                         if (member.isConstructor) {
 427                                                 output +=  "new  <B>" +
 428                                                      member.memberOf + (!member.name || !member.name.length ? "" : ".") +"</B>";
 429                                         } else {
 430
 431                                                 if (member.isStatic) {
 432                                                         output +=  data.alias + ".";
 433                                                 }
 434                                         }
 435                                 !}</span><b class="itemname">{!
 436                                          output += (!member.name || !member.name.length  ? "" : member.name);
 437                                 !}</b>
 438
 439                                  {+makeSignature(member.params)+}
 440
 441                                 <if test="(member.returns && member.returns.length) || !member.isConstructor">
 442                                          :
 443                                         {!
 444                                            if (member.returns.length > 1) {
 445                                                    output += (new Link().toSymbol("Object"));
 446                                            } else {
 447                                                    output += (new Link().toSymbolLong(member.returns[0].type));
 448                                            }
 449
 450                                          !}
 451
 452                                 </if>
 453
 454                 </div>
 455                 <div class="mdesc">
 456                 <if test="!member.isConstructor">
 457                    <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
 458                  </if>
 459                  <if test="member.isConstructor">
 460                         <div class="short">Create a new {+data.alias +}</div>
 461                  </if>
 462
 463                     <div class="long">
 464                         <if test="!member.isConstructor">
 465                                 {+resolveLinks(member.desc)+}
 466
 467                                 <if test="member.example">
 468                                         <pre class="code">{+member.example+}</pre>
 469                                 </if>
 470                         </if>
 471
 472                         <if test="member.isConstructor">
 473                                 Create a new {+data.alias +}
 474                         </if>
 475                         <if test="member.params && member.params.length">
 476                                 <dl class="detailList">
 477                                 <dt class="heading">Parameters:</dt>
 478                                 <for each="item" in="member.params">
 479                                         <dt>
 480
 481                        <if test="typeof(item.type) == 'object'">
 482                             <span class="fixedFont">{+(new Link().toSymbolLong('Function'))+}</span>
 483                             {+makeSignature(item.type.params)+}
 484
 485
 486                                {!
 487                                    if (member.returns && member.returns.length) {
 488                                        output += ' : ' + (new Link().toSymbolLong(member.returns[0].type)) + ' ';
 489                                    } else {
 490                                        output += ' :  none ';
 491                                    }
 492
 493                                  !}
 494
 495                         </if>
 496                         <if test="typeof(item.type) != 'object'">
 497                             {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
 498                         </if>
 499
 500                         <if test="item.isOptional">
 501                             <i>Optional
 502                             <if test="item.defaultValue">,
 503                                 Default: {+item.defaultValue+}
 504                             </if>
 505                             </i>
 506                         </if>
 507                         <if test="!item.be_null">
 508                             <span style="color:red;">
 509                                Required (not null)
 510                             </span>
 511                         </if>
 512
 513
 514
 515
 516                                         </dt>
 517                                         <dd>
 518                                                 {+resolveLinks(item.desc)+}
 519
 520
 521                                                 <if test="item.properties && item.properties.length">
 522                                                      <dl class="detailList">
 523                                                         <for each="returnitem" in="item.properties">
 524                                                              <dt>
 525                                                                 {+((returnitem.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(returnitem.type))+"</span> " : "")+} <b>{+returnitem.name+}</b>
 526                                                               </dt>
 527                                                               <dd>
 528                                                               {+resolveLinks(returnitem.desc)+}
 529                                                                 </dd>
 530
 531                                                         </for>
 532                                                       </dl>
 533
 534                                                 </if>
 535
 536
 537
 538
 539
 540                                         </dd>
 541
 542
 543
 544                                 </for>
 545                                 </dl>
 546                         </if>
 547                         <if test="member.deprecated">
 548                                 <dl class="detailList">
 549                                 <dt class="heading">Deprecated:</dt>
 550                                 <dt>
 551                                         {+member.deprecated+}
 552                                 </dt>
 553                                 </dl>
 554                         </if>
 555
 556                         <if test="member.exceptions && member.exceptions.length">
 557                                 <dl class="detailList">
 558                                 <dt class="heading">Throws:</dt>
 559                                 <for each="item" in="member.exceptions">
 560                                         <dt>
 561                                                 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
 562                                         </dt>
 563                                         <dd>{+resolveLinks(item.desc)+}</dd>
 564                                 </for>
 565                                 </dl>
 566                         </if>
 567                         <if test="member.returns && member.returns.length">
 568                                 <dl class="detailList">
 569                                 <dt class="heading">Returns:</dt>
 570
 571                                 <if test="member.returns > 1">
 572                                         <dl>An Object with these properties</dl>
 573                                 </if>
 574
 575                                 <for each="item" in="member.returns">
 576                                         <dd>{!
 577                                                 if (member.returns.length > 1) {
 578                                                         output += item.name+ ': ';
 579                                                 }
 580                                                 !}
 581                                          {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}
 582                                             {+resolveLinks(item.desc)+}</dd>
 583                                 </for>
 584                                 </dl>
 585                         </if>
 586
 587
 588
 589                     </div>
 590                 </div>
 591
 592             </td>
 593             <td class="msource">
 594                 <if test="!member.isConstructor">
 595                         {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbolLong(member.memberOf) +}
 596                 </if>&nbsp;
 597             </td>
 598         </tr>
 599         </for>
 600
 601     </table>
 602 </if>
 603
 604   <!-- ============================== events summary / details ======================== -->
 605
 606
 607   <a id="{+data.alias+}-events"></a>
 608
 609
 610         {!
 611
 612
 613                 var ownEvents = data.signals.sort(makeSortby("name"));
 614
 615         !}
 616    <if test="!ownEvents.length">
 617
 618      <table cellspacing="0" class="member-table">
 619       <caption class="Empty">Events</caption>
 620       <tr><td>None</td></tr>
 621      </table>
 622
 623     </if>
 624
 625
 626     <if test="ownEvents.length">
 627
 628       <table cellspacing="0" class="member-table">
 629                 <caption>Events - usage syntax:  this.signals.EVENTNAME.connect( {+(new Link().toSymbolLong('Function' ))+} ) </caption>
 630               <thead>
 631                 <tr>
 632                     <th class="sig-header" colspan="2">Event</th>
 633                     <th class="msource-header">Defined By</th>
 634
 635                 </tr>
 636               </thead>
 637
 638
 639
 640
 641         <for each="member" in="ownEvents">
 642           <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
 643
 644                 if (member.memberOf == data.alias) {
 645                         output += " notInherited";
 646                  }
 647
 648
 649
 650
 651
 652
 653                  !}">
 654             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 655
 656             <td class="sig">
 657                 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
 658
 659                <div class="fixedFont">
 660                 <b class="itemname">{+member.name+}</b> {+makeSignature(member.params)+}
 661                 :
 662                                         {!
 663                                            if (member.returns && member.returns.length) {
 664                                                    output += (new Link().toSymbolLong(member.returns[0].type));
 665                                            } else {
 666                                                    output += 'none';
 667                                            }
 668
 669                                          !}
 670
 671
 672
 673                 </div>
 674
 675                 <div class="mdesc">
 676
 677                    <div class="short">{+resolveLinks(summarize(member.desc))+}
 678
 679                 </div>
 680
 681                     <div class="long">
 682
 683                         {+resolveLinks(member.desc)+}
 684
 685
 686                         <if test="member.params && member.params.length">
 687                                 <dl class="detailList">
 688                                 <dt class="heading">Parameters:</dt>
 689                                 <for each="item" in="member.params">
 690                                         <dt>
 691                                                 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
 692                                                 <if test="item.isOptional"><i>Optional
 693                                                         <if test="item.defaultValue">,
 694                                                         Default: {+item.defaultValue+}
 695                                                 </if></i></if>
 696                                         </dt>
 697                                         <dd>{+resolveLinks(item.desc)+}</dd>
 698                                 </for>
 699                                 </dl>
 700                         </if>
 701
 702                         <if test="member.exceptions.length">
 703                                 <dl class="detailList">
 704                                 <dt class="heading">Throws:</dt>
 705                                 <for each="item" in="member.exceptions">
 706                                         <dt>
 707                                                 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
 708                                         </dt>
 709                                         <dd>{+resolveLinks(item.desc)+}</dd>
 710                                 </for>
 711                                 </dl>
 712                         </if>
 713                         <if test="member.returns && member.returns.length">
 714                                 <dl class="detailList">
 715                                 <dt class="heading">Returns:</dt>
 716                                 <for each="item" in="member.returns">
 717                                         <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
 718                                 </for>
 719                                 </dl>
 720                         </if>
 721
 722
 723
 724
 725                     </div>
 726                 </div>
 727
 728             </td>
 729             <td class="msource">
 730                 {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbolLong(member.memberOf) +}
 731             </td>
 732         </tr>
 733         </for>
 734
 735     </table>
 736 </if>
 737
 738   <a id="{+data.alias+}-references"></a>
 739   <!--references-->
 740 </div>
 741 </div>
 742
 743
 744 <!-- ============================== footer ================================= -->
 745                 <div class="fineprint" style="clear:both">
 746                         <if test="data.copyright">&copy;{+data.copyright+}<br /></if>
 747                         Documentation generated by
 748             <a href="http://git.gnome.org/browse/introspection-doc-generator">Introspection Doc Generator</a>
 749                         Loosely Based on
 750                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}
 751                 </div>
 752         </body>
 753 </html>