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