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