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">GIR File:</td>
 117             <td class="hd-info"><a href="{+data.gir_filename+}">{+data.gir_filename+}</a></td>
 118         </tr>
 119         <tr>
 120             <td class="label">C documentation:</td>
 121             <td class="hd-info">{+new Link().toGnome(data.alias)+}</td>
 122         </tr>
 123         <tr>
 124             <td class="label">{+data.titleType+} :</td>
 125             <td class="hd-info">{+data.name+}</td>
 126         </tr>
 127
 128 <if test="data.implementInterfaces && data.implementInterfaces.length">
 129
 130         <tr>
 131             <td class="label">Implements:</td>
 132             <td class="hd-info">
 133                 {+
 134                         data.implementInterfaces.map(
 135                                 function($) { return new Link().toSymbolLong($.alias); }
 136                         ).join(", ")
 137                 +}
 138             </td>
 139         </tr>
 140
 141 </if>
 142 <if test="data.implementedBy && data.implementedBy.length">
 143         <tr>
 144             <td class="label">Implementations:</td>
 145             <td class="hd-info">
 146                 {+
 147                         data.implementedBy
 148                         .sort()
 149                         .map(
 150                                 function($) { return new Link().toSymbolLong($); }
 151                         ).join(", ")
 152                 +}
 153             </td>
 154         </tr>
 155
 156
 157 </if>
 158 <if test="data.childClasses.length">
 159         <tr>
 160             <td class="label">Subclasses:</td>
 161             <td class="hd-info">
 162                 {+
 163                         data.childClasses
 164                         .sort()
 165                         .map(
 166                                 function($) { return new Link().toSymbolLong($); }
 167                         ).join(", ")
 168                 +}
 169
 170
 171
 172             </td>
 173         </tr>
 174 </if>
 175
 176         <if test="data.extendsClasses.length">
 177
 178                 <tr><td class="label">Extends:</td><td class="hd-info">
 179                         {+
 180                                 new Link().toSymbolLong(data.extendsClasses[data.extendsClasses.length -1].alias)
 181
 182                         +}
 183
 184                 </td></tr>
 185         </if>
 186
 187 <script type="text/javascript">
 188 var display = '';
 189 function toggle() {
 190     display  = display == 'none' ? '': 'none';
 191     Array.prototype.slice.call(
 192        document.getElementsByTagName('tr')
 193     ).forEach(function(tr) {
 194        tr.style.display = '';
 195        if (tr.className.match(/notInherited/)) return;
 196        if (!tr.className.match(/expandable/)) return;
 197        tr.style.display = display;
 198     });
 199 }
 200 </script>
 201
 202     </table>
 203
 204
 205 <!-- ============================== class summary ========================== -->
 206     <div class="description">
 207         {+resolveLinks(data.desc)+}
 208     </div>
 209
 210
 211 <!-- ============================== Class comment block... ========================== -->
 212 <!--
 213 <div class="comments">
 214         <b>Class Comments / Notes</B> =>
 215         <u onclick="parent.CommentDialog.showCommentId = '{+data.name+}';">[Add Your comment/notes about this class]</u>
 216         <br/>
 217         <iframe frameborder="0"  id="comments-{+data.name+}" style="border: none;width:100%;"
 218                 src="http://www.akbkhome.com/blog.php/SeedComments/{+data.ns+}.{+data.name+}.html"></iframe>
 219 </div>
 220 -->
 221
 222 <!-- ============================== enum values ========================== -->
 223
 224
 225        {!
 226
 227
 228
 229
 230                 cfgProperties = data.values ? data.values.sort(makeSortby("name")) : [];
 231
 232
 233
 234
 235
 236         !}
 237
 238     <div class="hr"></div>
 239     <a id="{+data.alias+}-values"></a>
 240
 241     <if test="!cfgProperties.length">
 242
 243
 244     </if>
 245
 246     <if test="cfgProperties.length">
 247
 248       <table cellspacing="0" class="member-table">
 249       <caption>Values </caption>
 250
 251
 252         <tr>
 253             <th class="sig-header" colspan="2">Properties</th>
 254
 255         </tr>
 256
 257
 258
 259         <for each="dtag" in="cfgProperties">
 260
 261                 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ?   " notInherited" : "") +}">
 262                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 263                     <td class="sig">
 264
 265                         <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
 266                         <div class="fixedFont">
 267                 {+(new Link().toSymbolLong(dtag.type))+} {+data.alias+}.<b  class="itemname">{+dtag.name+}</b> : {+dtag.value+}
 268                         </div>
 269
 270                         <div class="mdesc">
 271                             <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
 272                         </div>
 273
 274                         <div class="mdesc">
 275                             <div class="long">{+resolveLinks(dtag.desc)+}</div>
 276                         </div>
 277
 278
 279
 280                     </td>
 281
 282                 </tr>
 283         </for>
 284
 285     </table>
 286   </if>
 287
 288
 289
 290
 291
 292 <!-- ============================== config options ========================== -->
 293
 294
 295        {!
 296
 297
 298
 299
 300                 cfgProperties = data.properties.sort(makeSortby("name"));
 301
 302
 303
 304
 305
 306         !}
 307
 308     <div class="hr"></div>
 309     <a id="{+data.alias+}-configs"></a>
 310
 311     <if test="!cfgProperties.length">
 312
 313      <table cellspacing="0" class="member-table">
 314       <caption class="Empty">Properties</caption>
 315       <tr><td>None</td></tr>
 316      </table>
 317
 318     </if>
 319
 320     <if test="cfgProperties.length">
 321
 322       <table cellspacing="0" class="member-table">
 323       <caption>Properties </caption>
 324
 325
 326         <tr>
 327             <th class="sig-header" colspan="2">Properties</th>
 328
 329             <th class="msource-header">Defined By</th>
 330         </tr>
 331
 332
 333
 334         <for each="dtag" in="cfgProperties">
 335
 336                 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ?   " notInherited" : "") +}">
 337                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 338                     <td class="sig">
 339
 340                         <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
 341                         <div class="fixedFont">
 342                                 <b  class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbolLong(dtag.type)) : "" )+}
 343                  {+ (dtag.flags ? (dtag.flags & 2 ? '' : 'read only') : '')+}
 344
 345                         </div>
 346
 347                         <div class="mdesc">
 348                             <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
 349                         </div>
 350
 351                         <div class="mdesc">
 352                             <div class="long">{+resolveLinks(dtag.desc)+}</div>
 353                         </div>
 354
 355
 356
 357                     </td>
 358                     <td class="msource">
 359                         {# - fixme - add inheritied as link here #}
 360                         {+ (dtag.memberOf == data.alias) ? dtag.memberOf :  new Link().toSymbolLong(dtag.memberOf) +}
 361
 362                     </td>
 363                 </tr>
 364         </for>
 365
 366     </table>
 367   </if>
 368
 369
 370
 371
 372
 373
 374
 375   <!-- ============================== methods summary / details ======================== -->
 376
 377
 378   <a id="{+data.alias+}-methods"></a>
 379         <!-- constructor?? -->
 380         {!
 381
 382
 383
 384                 var ownMethods = [];
 385                 ownMethods.push.apply(ownMethods, data.constructors.sort(makeSortby("name")));
 386                 ownMethods.push.apply(ownMethods, data.functions.sort(makeSortby("name")));
 387                 ownMethods.push.apply(ownMethods, data.methods.sort(makeSortby("name")));
 388
 389         !}
 390     <!-- constructors, then statics, then dynamics -->
 391
 392
 393
 394     <if test="!ownMethods.length">
 395
 396      <table cellspacing="0" class="member-table">
 397       <caption class="Empty">Public Methods</caption>
 398       <tr><td>None</td></tr>
 399      </table>
 400
 401     </if>
 402     <if test="ownMethods.length">
 403
 404       <table cellspacing="0" class="member-table">
 405       <caption>Methods / Constructors</caption>
 406         <tr>
 407             <th class="sig-header" colspan="2">Method / Constructor</th>
 408             <th class="msource-header">Defined By</th>
 409
 410         </tr>
 411
 412
 413
 414
 415
 416         <for each="member" in="ownMethods">
 417
 418           <tr class="method-row config-row-alt{+$member_i % 2+}{!
 419                   if (member.isConstructor && (!member.params || !member.params.length)) {
 420                           output += '';
 421                  } else {
 422                           output += ' expandable';
 423                         }
 424
 425
 426                 if (member.memberOf == data.alias) {
 427                         output += " notInherited";
 428                  }
 429
 430                  !}">
 431             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 432
 433
 434             <td class="sig">
 435                 <a id="{+member.memberOf+}-method-{+member.name+}"   name=".{+member.name+}"></a>
 436                 <div class="fixedFont">
 437                         <span class="attributes">{!
 438                                         if (member.isConstructor) {
 439                                                 output +=  "new  <B>" +
 440                                                      member.memberOf + (!member.name || !member.name.length ? "" : ".") +"</B>";
 441                                         } else {
 442
 443                                                 if (member.isStatic) {
 444                                                         output +=  data.alias + ".";
 445                                                 }
 446                                         }
 447                                 !}</span><b class="itemname">{!
 448                                          output += (!member.name || !member.name.length  ? "" : member.name);
 449                                 !}</b>
 450
 451                                  {+makeSignature(member.params)+}
 452
 453                                 <if test="(member.returns && member.returns.length) || !member.isConstructor">
 454                                          :
 455                                         {!
 456                                            if (member.returns.length > 1) {
 457                                                    output += (new Link().toSymbol("Object"));
 458                                            } else {
 459                                                    output += (new Link().toSymbolLong(member.returns[0].type));
 460                                            }
 461
 462                                          !}
 463
 464                                 </if>
 465
 466                 </div>
 467                 <div class="mdesc">
 468                 <if test="!member.isConstructor">
 469                    <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
 470                  </if>
 471                  <if test="member.isConstructor">
 472                         <div class="short">Create a new {+data.alias +}</div>
 473                  </if>
 474
 475                     <div class="long">
 476                         <if test="!member.isConstructor">
 477                                 {+resolveLinks(member.desc)+}
 478
 479                                 <if test="member.example">
 480                                         <pre class="code">{+member.example+}</pre>
 481                                 </if>
 482                         </if>
 483
 484                         <if test="member.isConstructor">
 485                                 Create a new {+data.alias +}
 486                         </if>
 487                         <if test="member.params && member.params.length">
 488                                 <dl class="detailList">
 489                                 <dt class="heading">Parameters:</dt>
 490                                 <for each="item" in="member.params">
 491                                         <dt>
 492
 493                        <if test="typeof(item.type) == 'object'">
 494                             <span class="fixedFont">{+(new Link().toSymbolLong('Function'))+}</span>
 495                             {+makeSignature(item.type.params)+}
 496
 497
 498                                {!
 499                                    if (member.returns && member.returns.length) {
 500                                        output += ' : ' + (new Link().toSymbolLong(member.returns[0].type)) + ' ';
 501                                    } else {
 502                                        output += ' :  none ';
 503                                    }
 504
 505                                  !}
 506
 507                         </if>
 508                         <if test="typeof(item.type) != 'object'">
 509                             {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
 510                         </if>
 511
 512                         <if test="item.isOptional">
 513                             <i>Optional
 514                             <if test="item.defaultValue">,
 515                                 Default: {+item.defaultValue+}
 516                             </if>
 517                             </i>
 518                         </if>
 519                         <if test="!item.be_null">
 520                             <span style="color:red;">
 521                                Required (not null)
 522                             </span>
 523                         </if>
 524
 525
 526
 527
 528                                         </dt>
 529                                         <dd>
 530                                                 {+resolveLinks(item.desc)+}
 531
 532
 533                                                 <if test="item.properties && item.properties.length">
 534                                                      <dl class="detailList">
 535                                                         <for each="returnitem" in="item.properties">
 536                                                              <dt>
 537                                                                 {+((returnitem.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(returnitem.type))+"</span> " : "")+} <b>{+returnitem.name+}</b>
 538                                                               </dt>
 539                                                               <dd>
 540                                                               {+resolveLinks(returnitem.desc)+}
 541                                                                 </dd>
 542
 543                                                         </for>
 544                                                       </dl>
 545
 546                                                 </if>
 547
 548
 549
 550
 551
 552                                         </dd>
 553
 554
 555
 556                                 </for>
 557                                 </dl>
 558                         </if>
 559                         <if test="member.deprecated">
 560                                 <dl class="detailList">
 561                                 <dt class="heading">Deprecated:</dt>
 562                                 <dt>
 563                                         {+member.deprecated+}
 564                                 </dt>
 565                                 </dl>
 566                         </if>
 567
 568                         <if test="member.exceptions && member.exceptions.length">
 569                                 <dl class="detailList">
 570                                 <dt class="heading">Throws:</dt>
 571                                 <for each="item" in="member.exceptions">
 572                                         <dt>
 573                                                 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
 574                                         </dt>
 575                                         <dd>{+resolveLinks(item.desc)+}</dd>
 576                                 </for>
 577                                 </dl>
 578                         </if>
 579                         <if test="member.returns && member.returns.length">
 580                                 <dl class="detailList">
 581                                 <dt class="heading">Returns:</dt>
 582
 583                                 <if test="member.returns > 1">
 584                                         <dl>An Object with these properties</dl>
 585                                 </if>
 586
 587                                 <for each="item" in="member.returns">
 588                                         <dd>{!
 589                                                 if (member.returns.length > 1) {
 590                                                         output += item.name+ ': ';
 591                                                 }
 592                                                 !}
 593                                          {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}
 594                                             {+resolveLinks(item.desc)+}</dd>
 595                                 </for>
 596                                 </dl>
 597                         </if>
 598
 599
 600
 601                     </div>
 602                 </div>
 603
 604             </td>
 605             <td class="msource">
 606                 <if test="!member.isConstructor">
 607                         {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbolLong(member.memberOf) +}
 608                 </if>&nbsp;
 609             </td>
 610         </tr>
 611         </for>
 612
 613     </table>
 614 </if>
 615
 616   <!-- ============================== events summary / details ======================== -->
 617
 618
 619   <a id="{+data.alias+}-events"></a>
 620
 621
 622         {!
 623
 624
 625                 var ownEvents = data.signals.sort(makeSortby("name"));
 626
 627         !}
 628    <if test="!ownEvents.length">
 629
 630      <table cellspacing="0" class="member-table">
 631       <caption class="Empty">Events</caption>
 632       <tr><td>None</td></tr>
 633      </table>
 634
 635     </if>
 636
 637
 638     <if test="ownEvents.length">
 639
 640       <table cellspacing="0" class="member-table">
 641                 <caption>Events - usage syntax:  this.signals.EVENTNAME.connect( {+(new Link().toSymbolLong('Function' ))+} ) </caption>
 642               <thead>
 643                 <tr>
 644                     <th class="sig-header" colspan="2">Event</th>
 645                     <th class="msource-header">Defined By</th>
 646
 647                 </tr>
 648               </thead>
 649
 650
 651
 652
 653         <for each="member" in="ownEvents">
 654           <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
 655
 656                 if (member.memberOf == data.alias) {
 657                         output += " notInherited";
 658                  }
 659
 660
 661
 662
 663
 664
 665                  !}">
 666             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 667
 668             <td class="sig">
 669                 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
 670
 671                <div class="fixedFont">
 672                 <b class="itemname">{+member.name+}</b> {+makeSignature(member.params)+}
 673                 :
 674                                         {!
 675                                            if (member.returns && member.returns.length) {
 676                                                    output += (new Link().toSymbolLong(member.returns[0].type));
 677                                            } else {
 678                                                    output += 'none';
 679                                            }
 680
 681                                          !}
 682
 683
 684
 685                 </div>
 686
 687                 <div class="mdesc">
 688
 689                    <div class="short">{+resolveLinks(summarize(member.desc))+}
 690
 691                 </div>
 692
 693                     <div class="long">
 694
 695                         {+resolveLinks(member.desc)+}
 696
 697
 698                         <if test="member.params && member.params.length">
 699                                 <dl class="detailList">
 700                                 <dt class="heading">Parameters:</dt>
 701                                 <for each="item" in="member.params">
 702                                         <dt>
 703                                                 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
 704                                                 <if test="item.isOptional"><i>Optional
 705                                                         <if test="item.defaultValue">,
 706                                                         Default: {+item.defaultValue+}
 707                                                 </if></i></if>
 708                                         </dt>
 709                                         <dd>{+resolveLinks(item.desc)+}</dd>
 710                                 </for>
 711                                 </dl>
 712                         </if>
 713
 714                         <if test="member.exceptions.length">
 715                                 <dl class="detailList">
 716                                 <dt class="heading">Throws:</dt>
 717                                 <for each="item" in="member.exceptions">
 718                                         <dt>
 719                                                 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
 720                                         </dt>
 721                                         <dd>{+resolveLinks(item.desc)+}</dd>
 722                                 </for>
 723                                 </dl>
 724                         </if>
 725                         <if test="member.returns && member.returns.length">
 726                                 <dl class="detailList">
 727                                 <dt class="heading">Returns:</dt>
 728                                 <for each="item" in="member.returns">
 729                                         <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
 730                                 </for>
 731                                 </dl>
 732                         </if>
 733
 734
 735
 736
 737                     </div>
 738                 </div>
 739
 740             </td>
 741             <td class="msource">
 742                 {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbolLong(member.memberOf) +}
 743             </td>
 744         </tr>
 745         </for>
 746
 747     </table>
 748 </if>
 749
 750   <a id="{+data.alias+}-references"></a>
 751   <!--references-->
 752 </div>
 753 </div>
 754
 755
 756 <!-- ============================== footer ================================= -->
 757                 <div class="fineprint" style="clear:both">
 758                         <if test="data.copyright">&copy;{+data.copyright+}<br /></if>
 759                         Documentation generated by
 760             <a href="http://git.gnome.org/browse/introspection-doc-generator">Introspection Doc Generator</a>
 761                         Loosely Based on
 762                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}
 763                 </div>
 764         </body>
 765 </html>