1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
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 */ !}
11 <title>JsDoc Reference - {+data.name+}</title>
14 <link rel="stylesheet" type="text/css" href="default.css" />
16 <script type="text/javascript" src="page.js">
23 <body onload="RooDocsPage.onload();">
27 <li id="siteaction-gnome_home" class="home">
28 <a href="http://www.gnome.org/">Home</a>
30 <li id="siteaction-gnome_news">
31 <a href="http://news.gnome.org">
34 <li id="siteaction-gnome_projects">
35 <a href="http://www.gnome.org/projects/">
38 <li id="siteaction-gnome_art">
39 <a href="http://art.gnome.org">
42 <li id="siteaction-gnome_support">
43 <a href="http://www.gnome.org/support/">
46 <li id="siteaction-gnome_development">
47 <a href="http://developer.gnome.org">
50 <li id="siteaction-gnome_community">
51 <a href="http://www.gnome.org/community/">
56 <div id="header-wrap">
58 Un-official Seed Documentation<!-- GNOME Documentation Library--></h1>
61 <form method="get" action="http://www.google.com/custom">
62 <input type="hidden" name="domains" value="library.gnome.org">
64 <input type="hidden" name="sitesearch" value="library.gnome.org">
66 <input type="text" name="q" maxlength="255" size="15" class="searchTerms">
68 <input type="submit" class="searchButton" value="Search">
74 <ul id="portal-globalnav">
75 <li id="portaltab-root">
76 <a href="http://library.gnome.org/">
81 <li id="portaltab-users">
82 <a href="http://library.gnome.org/users/">
87 <li id="portaltab-sysadmins">
88 <a href="http://library.gnome.org/admin/">
93 <li id="portaltab-developers" class="selected">
94 <a href="http://library.gnome.org/devel/">
99 <li id="portaltab-about">
100 <a href="http://library.gnome.org/about/about">
121 <div class="left-class-list" style="width:18%;float:left;">
122 <a href="index.shtml"> Back to Seed Clases </a> <br/><br/>
123 <!--#include virtual="_ix_{+data.ns+}.shtml" -->
126 <div class="body-wrap" style="width:78%;float:left;">
128 <!-- ============================== links to methods. ================================= -->
130 <div class="top-tools">
132 <a class="inner-link" href="#{+data.name+}-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
133 <a class="inner-link" href="#{+data.name+}-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
134 <a class="inner-link" href="#{+data.name+}-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
135 <a class="inner-link" href="#{+data.name+}-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
136 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
144 <!-- ============================== inheritance Block. ================================= -->
145 <if test="data.extendsClasses.length">
146 <div class="inheritance res-block">
147 <pre class="res-block-inner">{!
148 var iblock_indent = 0;
151 data.extendsClasses.reverse().map(
154 output += iblock_indent ? ('<img src="s.gif" height="1" width="' +
155 iblock_indent + '"/><img src="elbow-end.gif" class="elbow"/>') : '';
156 output += new Link().toSymbolLong($.alias) + "\n";
162 !}<img src="s.gif" height="1" width="{+ iblock_indent +}"/><img class="elbow" src="http://www.akbkhome.com/roojs1/images/default/tree/elbow-end.gif"/>{+data.alias+}
168 {+makeImage(data.alias)+}
171 <!-- ============================== class title / details ============================ -->
174 <h1 class="classTitle">
177 {+data.titleType+} {+data.alias+}
180 <table cellspacing="0" class="class-summary-table">
184 <td class="label">Import line:</td>
185 <td class="hd-info">{+data.ns+} = imports.gi.{+data.ns+}; </td>
190 <td class="label">C documentation:</td>
191 <td class="hd-info">{+new Link().toGnome(data.alias)+}</td>
194 <td class="label">{+data.titleType+} :</td>
195 <td class="hd-info">{+data.name+}</td>
198 <if test="data.implementInterfaces && data.implementInterfaces.length">
201 <td class="label">Implements:</td>
204 data.implementInterfaces.map(
205 function($) { return new Link().toSymbolLong($.alias); }
212 <if test="data.implementedBy && data.implementedBy.length">
214 <td class="label">Implementations:</td>
220 function($) { return new Link().toSymbolLong($); }
228 <if test="data.childClasses.length">
230 <td class="label">Subclasses:</td>
236 function($) { return new Link().toSymbolLong($); }
246 <if test="data.extendsClasses.length">
248 <tr><td class="label">Extends:</td><td class="hd-info">
250 new Link().toSymbolLong(data.extendsClasses[data.extendsClasses.length -1].alias)
260 <!-- ============================== class summary ========================== -->
261 <div class="description">
262 {+resolveLinks(data.desc)+}
266 <!-- ============================== Class comment block... ========================== -->
268 <div class="comments">
269 <b>Class Comments / Notes</B> =>
270 <u onclick="parent.CommentDialog.showCommentId = '{+data.name+}';">[Add Your comment/notes about this class]</u>
272 <iframe frameborder="0" id="comments-{+data.name+}" style="border: none;width:100%;"
273 src="http://www.akbkhome.com/blog.php/SeedComments/{+data.ns+}.{+data.name+}.html"></iframe>
277 <!-- ============================== enum values ========================== -->
285 cfgProperties = data.values ? data.values.sort(makeSortby("name")) : [];
293 <div class="hr"></div>
294 <a id="{+data.alias+}-values"></a>
296 <if test="!cfgProperties.length">
301 <if test="cfgProperties.length">
303 <table cellspacing="0" class="member-table">
304 <caption>Values </caption>
308 <th class="sig-header" colspan="2">Properties</th>
314 <for each="dtag" in="cfgProperties">
316 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
317 <td class="micon"><a class="exi" href="#expand"> </a></td>
320 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
321 <div class="fixedFont">
322 {+(new Link().toSymbolLong(dtag.type))+} {+data.alias+}.<b class="itemname">{+dtag.name+}</b> : {+dtag.value+}
326 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
330 <div class="long">{+resolveLinks(dtag.desc)+}</div>
347 <!-- ============================== config options ========================== -->
355 cfgProperties = data.properties.sort(makeSortby("name"));
363 <div class="hr"></div>
364 <a id="{+data.alias+}-configs"></a>
366 <if test="!cfgProperties.length">
368 <table cellspacing="0" class="member-table">
369 <caption class="Empty">Properties- Has None</caption>
374 <if test="cfgProperties.length">
376 <table cellspacing="0" class="member-table">
377 <caption>Properties </caption>
381 <th class="sig-header" colspan="2">Properties</th>
383 <th class="msource-header">Defined By</th>
388 <for each="dtag" in="cfgProperties">
390 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
391 <td class="micon"><a class="exi" href="#expand"> </a></td>
394 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
395 <div class="fixedFont">
396 <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbolLong(dtag.type)) : "" )+}
397 {+ (dtag.flags ? (dtag.flags & 2 ? '' : 'read only') : '')+}
402 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
406 <div class="long">{+resolveLinks(dtag.desc)+}</div>
413 {# - fixme - add inheritied as link here #}
414 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbolLong(dtag.memberOf) +}
429 <!-- ============================== methods summary / details ======================== -->
432 <a id="{+data.alias+}-methods"></a>
433 <!-- constructor?? -->
439 ownMethods.push.apply(ownMethods, data.constructors.sort(makeSortby("name")));
440 ownMethods.push.apply(ownMethods, data.functions.sort(makeSortby("name")));
441 ownMethods.push.apply(ownMethods, data.methods.sort(makeSortby("name")));
449 <!-- then dynamics first -->
453 <if test="!ownMethods.length">
455 <table cellspacing="0" class="member-table">
456 <caption class="Empty">Methods - Has None</caption>
460 <if test="ownMethods.length">
462 <table cellspacing="0" class="member-table">
463 <caption>Methods / Constructors</caption>
465 <th class="sig-header" colspan="2">Method / Constructor</th>
466 <th class="msource-header">Defined By</th>
474 <for each="member" in="ownMethods">
476 <tr class="method-row config-row-alt{+$member_i % 2+}{!
477 if (member.isConstructor && (!member.params || !member.params.length)) {
480 output += ' expandable';
484 if (member.memberOf == data.alias) {
485 output += " notInherited";
489 <td class="micon"><a class="exi" href="#expand"> </a></td>
493 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
494 <div class="fixedFont">
495 <span class="attributes">{!
496 if (member.isConstructor) {
497 output += "new <B>" +
498 member.memberOf + (!member.name || !member.name.length ? "" : ".") +"</B>";
501 if (member.isStatic) {
502 output += data.alias + ".";
505 !}</span><b class="itemname">{!
506 output += (!member.name || !member.name.length ? "" : member.name);
509 {+makeSignature(member.params)+}
511 <if test="(member.returns && member.returns.length) || !member.isConstructor">
514 if (member.returns.length > 1) {
515 output += (new Link().toSymbol("Object"));
517 output += (new Link().toSymbolLong(member.returns[0].type));
526 <if test="!member.isConstructor">
527 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
529 <if test="member.isConstructor">
530 <div class="short">Create a new {+data.alias +}</div>
534 <if test="!member.isConstructor">
535 {+resolveLinks(member.desc)+}
537 <if test="member.example">
538 <pre class="code">{+member.example+}</pre>
542 <if test="member.isConstructor">
543 Create a new {+data.alias +}
545 <if test="member.params && member.params.length">
546 <dl class="detailList">
547 <dt class="heading">Parameters:</dt>
548 <for each="item" in="member.params">
551 <if test="typeof(item.type) == 'object'">
552 <span class="fixedFont">{+(new Link().toSymbolLong('Function'))+}</span>
553 {+makeSignature(item.type.params)+}
557 if (member.returns && member.returns.length) {
558 output += ' : ' + (new Link().toSymbolLong(member.returns[0].type)) + ' ';
560 output += ' : none ';
566 <if test="typeof(item.type) != 'object'">
567 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
570 <if test="item.isOptional">
572 <if test="item.defaultValue">,
573 Default: {+item.defaultValue+}
577 <if test="!item.be_null">
578 <span style="color:red;">
588 {+resolveLinks(item.desc)+}
591 <if test="item.properties && item.properties.length">
592 <dl class="detailList">
593 <for each="returnitem" in="item.properties">
595 {+((returnitem.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(returnitem.type))+"</span> " : "")+} <b>{+returnitem.name+}</b>
598 {+resolveLinks(returnitem.desc)+}
617 <if test="member.deprecated">
618 <dl class="detailList">
619 <dt class="heading">Deprecated:</dt>
621 {+member.deprecated+}
626 <if test="member.exceptions && member.exceptions.length">
627 <dl class="detailList">
628 <dt class="heading">Throws:</dt>
629 <for each="item" in="member.exceptions">
631 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
633 <dd>{+resolveLinks(item.desc)+}</dd>
637 <if test="member.returns && member.returns.length">
638 <dl class="detailList">
639 <dt class="heading">Returns:</dt>
641 <if test="member.returns > 1">
642 <dl>An Object with these properties</dl>
645 <for each="item" in="member.returns">
647 if (member.returns.length > 1) {
648 output += item.name+ ': ';
651 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}
652 {+resolveLinks(item.desc)+}</dd>
664 <if test="!member.isConstructor">
665 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}
674 <!-- ============================== events summary / details ======================== -->
677 <a id="{+data.alias+}-events"></a>
683 var ownEvents = data.signals.sort(makeSortby("name"));
686 <if test="!ownEvents.length">
688 <table cellspacing="0" class="member-table">
689 <caption class="Empty">Events - Has None</caption>
695 <if test="ownEvents.length">
697 <table cellspacing="0" class="member-table">
698 <caption>Events - usage syntax: this.signals.EVENTNAME.connect( {+(new Link().toSymbolLong('Function' ))+} ) </caption>
701 <th class="sig-header" colspan="2">Event</th>
702 <th class="msource-header">Defined By</th>
710 <for each="member" in="ownEvents">
711 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
713 if (member.memberOf == data.alias) {
714 output += " notInherited";
723 <td class="micon"><a class="exi" href="#expand"> </a></td>
726 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
728 <div class="fixedFont">
729 <b class="itemname">{+member.name+}</b> {+makeSignature(member.params)+}
732 if (member.returns && member.returns.length) {
733 output += (new Link().toSymbolLong(member.returns[0].type));
746 <div class="short">{+resolveLinks(summarize(member.desc))+}
752 {+resolveLinks(member.desc)+}
755 <if test="member.params && member.params.length">
756 <dl class="detailList">
757 <dt class="heading">Parameters:</dt>
758 <for each="item" in="member.params">
760 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
761 <if test="item.isOptional"><i>Optional
762 <if test="item.defaultValue">,
763 Default: {+item.defaultValue+}
766 <dd>{+resolveLinks(item.desc)+}</dd>
771 <if test="member.exceptions.length">
772 <dl class="detailList">
773 <dt class="heading">Throws:</dt>
774 <for each="item" in="member.exceptions">
776 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
778 <dd>{+resolveLinks(item.desc)+}</dd>
782 <if test="member.returns && member.returns.length">
783 <dl class="detailList">
784 <dt class="heading">Returns:</dt>
785 <for each="item" in="member.returns">
786 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
799 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}
807 <a id="{+data.alias+}-references"></a>
808 <!--#include virtual="references.{+data.alias+}.html" -->
812 <!-- ============================== footer ================================= -->
813 <div class="fineprint" style="clear:both">
814 <if test="data.copyright">©{+data.copyright+}<br /></if>
815 Documentation generated by <a href="http://www.akbkhome.com/svn/seed/JSDOC">Seed/Jstoolkit</a>
817 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}