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