1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:roo="http://www.akbkhome.com/roojs1/" 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>
13 <script type="text/javascript" src="page.js"></script>
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>
22 <body onload="RooDocsPage.onload();">
27 <div id="header-wrap">
29 Un-official Seed Documentation<!-- GNOME Documentation Library-->
45 <div class="left-class-list" style="width:18%;float:left;">
46 <a href="index.html"> Back to Seed Clases </a>
51 <div class="body-wrap" style="width:78%;float:left;">
53 <!-- ============================== links to methods. ================================= -->
55 <div class="top-tools">
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>
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;
76 data.extendsClasses.reverse().map(
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);
88 !}<img class="elbow elbow_indent{+iblock_indent+}" src="elbow-end.gif" alt="parent-child marker"/>
95 {+makeImage(data.alias)+}
98 <!-- ============================== class title / details ============================ -->
101 <h1 class="classTitle">
104 {+data.titleType+} {+data.alias+}
107 <table cellspacing="0" class="class-summary-table">
111 <td class="label">Import line:</td>
112 <td class="hd-info">{+data.ns+} = imports.gi.{+data.ns+}; </td>
116 <td class="label">GIR File:</td>
117 <td class="hd-info"><a href="{+data.gir_filename+}">{+data.gir_filename+}</a></td>
120 <td class="label">C documentation:</td>
121 <td class="hd-info">{+new Link().toGnome(data.alias)+}</td>
124 <td class="label">{+data.titleType+} :</td>
125 <td class="hd-info">{+data.name+}</td>
128 <if test="data.implementInterfaces && data.implementInterfaces.length">
131 <td class="label">Implements:</td>
134 data.implementInterfaces.map(
135 function($) { return new Link().toSymbolLong($.alias); }
142 <if test="data.implementedBy && data.implementedBy.length">
144 <td class="label">Implementations:</td>
150 function($) { return new Link().toSymbolLong($); }
158 <if test="data.childClasses.length">
160 <td class="label">Subclasses:</td>
166 function($) { return new Link().toSymbolLong($); }
176 <if test="data.extendsClasses.length">
178 <tr><td class="label">Extends:</td><td class="hd-info">
180 new Link().toSymbolLong(data.extendsClasses[data.extendsClasses.length -1].alias)
187 <script type="text/javascript">
190 display = display == 'none' ? '': 'none';
191 Array.prototype.slice.call(
192 document.getElementsByTagName('tr')
193 ).forEach(function(tr) {
194 tr.style.display = '';
195 if (tr.className.match(/notInherited/)) return;
196 if (!tr.className.match(/expandable/)) return;
197 tr.style.display = display;
204 <!-- ============================== class summary ========================== -->
205 <div class="description">
206 {+resolveLinks(data.desc)+}
210 <!-- ============================== Class comment block... ========================== -->
212 <div class="comments">
213 <b>Class Comments / Notes</B> =>
214 <u onclick="parent.CommentDialog.showCommentId = '{+data.name+}';">[Add Your comment/notes about this class]</u>
216 <iframe frameborder="0" id="comments-{+data.name+}" style="border: none;width:100%;"
217 src="http://www.akbkhome.com/blog.php/SeedComments/{+data.ns+}.{+data.name+}.html"></iframe>
221 <!-- ============================== enum values ========================== -->
229 cfgProperties = data.values ? data.values.sort(makeSortby("name")) : [];
237 <div class="hr"></div>
238 <a id="{+data.alias+}-values"></a>
240 <if test="!cfgProperties.length">
245 <if test="cfgProperties.length">
247 <table cellspacing="0" class="member-table">
248 <caption>Values </caption>
252 <th class="sig-header" colspan="2">Properties</th>
258 <for each="dtag" in="cfgProperties">
260 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
261 <td class="micon"><a class="exi" href="#expand"> </a></td>
264 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
265 <div class="fixedFont">
266 {+(new Link().toSymbolLong(dtag.type))+} {+data.alias+}.<b class="itemname">{+dtag.name+}</b> : {+dtag.value+}
270 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
274 <div class="long">{+resolveLinks(dtag.desc)+}</div>
291 <!-- ============================== config options ========================== -->
299 cfgProperties = data.properties.sort(makeSortby("name"));
307 <div class="hr"></div>
308 <a id="{+data.alias+}-configs"></a>
310 <if test="!cfgProperties.length">
312 <table cellspacing="0" class="member-table">
313 <caption class="Empty">Properties</caption>
314 <tr><td>None</td></tr>
319 <if test="cfgProperties.length">
321 <table cellspacing="0" class="member-table">
322 <caption>Properties </caption>
326 <th class="sig-header" colspan="2">Properties</th>
328 <th class="msource-header">Defined By</th>
333 <for each="dtag" in="cfgProperties">
335 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
336 <td class="micon"><a class="exi" href="#expand"> </a></td>
339 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
340 <div class="fixedFont">
341 <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbolLong(dtag.type)) : "" )+}
342 {+ (dtag.flags ? (dtag.flags & 2 ? '' : 'read only') : '')+}
347 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
351 <div class="long">{+resolveLinks(dtag.desc)+}</div>
358 {# - fixme - add inheritied as link here #}
359 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbolLong(dtag.memberOf) +}
374 <!-- ============================== methods summary / details ======================== -->
377 <a id="{+data.alias+}-methods"></a>
378 <!-- constructor?? -->
384 ownMethods.push.apply(ownMethods, data.constructors.sort(makeSortby("name")));
385 ownMethods.push.apply(ownMethods, data.functions.sort(makeSortby("name")));
386 ownMethods.push.apply(ownMethods, data.methods.sort(makeSortby("name")));
389 <!-- constructors, then statics, then dynamics -->
393 <if test="!ownMethods.length">
395 <table cellspacing="0" class="member-table">
396 <caption class="Empty">Public Methods</caption>
397 <tr><td>None</td></tr>
401 <if test="ownMethods.length">
403 <table cellspacing="0" class="member-table">
404 <caption>Methods / Constructors</caption>
406 <th class="sig-header" colspan="2">Method / Constructor</th>
407 <th class="msource-header">Defined By</th>
415 <for each="member" in="ownMethods">
417 <tr class="method-row config-row-alt{+$member_i % 2+}{!
418 if (member.isConstructor && (!member.params || !member.params.length)) {
421 output += ' expandable';
425 if (member.memberOf == data.alias) {
426 output += " notInherited";
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
434 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
435 <div class="fixedFont">
436 <span class="attributes">{!
437 if (member.isConstructor) {
438 output += "new <B>" +
439 member.memberOf + (!member.name || !member.name.length ? "" : ".") +"</B>";
442 if (member.isStatic) {
443 output += data.alias + ".";
446 !}</span><b class="itemname">{!
447 output += (!member.name || !member.name.length ? "" : member.name);
450 {+makeSignature(member.params)+}
452 <if test="(member.returns && member.returns.length) || !member.isConstructor">
455 if (member.returns.length > 1) {
456 output += (new Link().toSymbol("Object"));
458 output += (new Link().toSymbolLong(member.returns[0].type));
467 <if test="!member.isConstructor">
468 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
470 <if test="member.isConstructor">
471 <div class="short">Create a new {+data.alias +}</div>
475 <if test="!member.isConstructor">
476 {+resolveLinks(member.desc)+}
478 <if test="member.example">
479 <pre class="code">{+member.example+}</pre>
483 <if test="member.isConstructor">
484 Create a new {+data.alias +}
486 <if test="member.params && member.params.length">
487 <dl class="detailList">
488 <dt class="heading">Parameters:</dt>
489 <for each="item" in="member.params">
492 <if test="typeof(item.type) == 'object'">
493 <span class="fixedFont">{+(new Link().toSymbolLong('Function'))+}</span>
494 {+makeSignature(item.type.params)+}
498 if (member.returns && member.returns.length) {
499 output += ' : ' + (new Link().toSymbolLong(member.returns[0].type)) + ' ';
501 output += ' : none ';
507 <if test="typeof(item.type) != 'object'">
508 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
511 <if test="item.isOptional">
513 <if test="item.defaultValue">,
514 Default: {+item.defaultValue+}
518 <if test="!item.be_null">
519 <span style="color:red;">
529 {+resolveLinks(item.desc)+}
532 <if test="item.properties && item.properties.length">
533 <dl class="detailList">
534 <for each="returnitem" in="item.properties">
536 {+((returnitem.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(returnitem.type))+"</span> " : "")+} <b>{+returnitem.name+}</b>
539 {+resolveLinks(returnitem.desc)+}
558 <if test="member.deprecated">
559 <dl class="detailList">
560 <dt class="heading">Deprecated:</dt>
562 {+member.deprecated+}
567 <if test="member.exceptions && member.exceptions.length">
568 <dl class="detailList">
569 <dt class="heading">Throws:</dt>
570 <for each="item" in="member.exceptions">
572 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
574 <dd>{+resolveLinks(item.desc)+}</dd>
578 <if test="member.returns && member.returns.length">
579 <dl class="detailList">
580 <dt class="heading">Returns:</dt>
582 <if test="member.returns > 1">
583 <dl>An Object with these properties</dl>
586 <for each="item" in="member.returns">
588 if (member.returns.length > 1) {
589 output += item.name+ ': ';
592 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}
593 {+resolveLinks(item.desc)+}</dd>
605 <if test="!member.isConstructor">
606 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}
615 <!-- ============================== events summary / details ======================== -->
618 <a id="{+data.alias+}-events"></a>
624 var ownEvents = data.signals.sort(makeSortby("name"));
627 <if test="!ownEvents.length">
629 <table cellspacing="0" class="member-table">
630 <caption class="Empty">Events</caption>
631 <tr><td>None</td></tr>
637 <if test="ownEvents.length">
639 <table cellspacing="0" class="member-table">
640 <caption>Events - usage syntax: this.signals.EVENTNAME.connect( {+(new Link().toSymbolLong('Function' ))+} ) </caption>
643 <th class="sig-header" colspan="2">Event</th>
644 <th class="msource-header">Defined By</th>
652 <for each="member" in="ownEvents">
653 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
655 if (member.memberOf == data.alias) {
656 output += " notInherited";
665 <td class="micon"><a class="exi" href="#expand"> </a></td>
668 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
670 <div class="fixedFont">
671 <b class="itemname">{+member.name+}</b> {+makeSignature(member.params)+}
674 if (member.returns && member.returns.length) {
675 output += (new Link().toSymbolLong(member.returns[0].type));
688 <div class="short">{+resolveLinks(summarize(member.desc))+}
694 {+resolveLinks(member.desc)+}
697 <if test="member.params && member.params.length">
698 <dl class="detailList">
699 <dt class="heading">Parameters:</dt>
700 <for each="item" in="member.params">
702 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
703 <if test="item.isOptional"><i>Optional
704 <if test="item.defaultValue">,
705 Default: {+item.defaultValue+}
708 <dd>{+resolveLinks(item.desc)+}</dd>
713 <if test="member.exceptions.length">
714 <dl class="detailList">
715 <dt class="heading">Throws:</dt>
716 <for each="item" in="member.exceptions">
718 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
720 <dd>{+resolveLinks(item.desc)+}</dd>
724 <if test="member.returns && member.returns.length">
725 <dl class="detailList">
726 <dt class="heading">Returns:</dt>
727 <for each="item" in="member.returns">
728 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
741 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}
749 <a id="{+data.alias+}-references"></a>
755 <!-- ============================== footer ================================= -->
756 <div class="fineprint" style="clear:both">
757 <if test="data.copyright">©{+data.copyright+}<br /></if>
758 Documentation generated by
759 <a href="http://git.gnome.org/browse/introspection-doc-generator">Introspection Doc Generator</a>
761 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}