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