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">Note:</td>
117 <td class="hd-info"><b style="color:red">This documentation is generated from the HEAD of most
118 libraries (and some experimental libs at times) - and may not be exactly the same as your
119 installed .gir files - you may want to download the generator and install on your machine
120 to find out what you have.<b/></td>
123 <td class="label">C documentation:</td>
124 <td class="hd-info">{+new Link().toGnome(data.alias)+}</td>
127 <td class="label">{+data.titleType+} :</td>
128 <td class="hd-info">{+data.name+}</td>
131 <if test="data.implementInterfaces && data.implementInterfaces.length">
134 <td class="label">Implements:</td>
137 data.implementInterfaces.map(
138 function($) { return new Link().toSymbolLong($.alias); }
145 <if test="data.implementedBy && data.implementedBy.length">
147 <td class="label">Implementations:</td>
153 function($) { return new Link().toSymbolLong($); }
161 <if test="data.childClasses.length">
163 <td class="label">Subclasses:</td>
169 function($) { return new Link().toSymbolLong($); }
179 <if test="data.extendsClasses.length">
181 <tr><td class="label">Extends:</td><td class="hd-info">
183 new Link().toSymbolLong(data.extendsClasses[data.extendsClasses.length -1].alias)
193 <!-- ============================== class summary ========================== -->
194 <div class="description">
195 {+resolveLinks(data.desc)+}
199 <!-- ============================== Class comment block... ========================== -->
201 <div class="comments">
202 <b>Class Comments / Notes</B> =>
203 <u onclick="parent.CommentDialog.showCommentId = '{+data.name+}';">[Add Your comment/notes about this class]</u>
205 <iframe frameborder="0" id="comments-{+data.name+}" style="border: none;width:100%;"
206 src="http://www.akbkhome.com/blog.php/SeedComments/{+data.ns+}.{+data.name+}.html"></iframe>
210 <!-- ============================== enum values ========================== -->
218 cfgProperties = data.values ? data.values.sort(makeSortby("name")) : [];
226 <div class="hr"></div>
227 <a id="{+data.alias+}-values"></a>
229 <if test="!cfgProperties.length">
234 <if test="cfgProperties.length">
236 <table cellspacing="0" class="member-table">
237 <caption>Values </caption>
241 <th class="sig-header" colspan="2">Properties</th>
247 <for each="dtag" in="cfgProperties">
249 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
250 <td class="micon"><a class="exi" href="#expand"> </a></td>
253 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
254 <div class="fixedFont">
255 {+(new Link().toSymbolLong(dtag.type))+} {+data.alias+}.<b class="itemname">{+dtag.name+}</b> : {+dtag.value+}
259 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
263 <div class="long">{+resolveLinks(dtag.desc)+}</div>
280 <!-- ============================== config options ========================== -->
288 cfgProperties = data.properties.sort(makeSortby("name"));
296 <div class="hr"></div>
297 <a id="{+data.alias+}-configs"></a>
299 <if test="!cfgProperties.length">
301 <table cellspacing="0" class="member-table">
302 <caption class="Empty">Properties</caption>
303 <tr><td>None</td></tr>
308 <if test="cfgProperties.length">
310 <table cellspacing="0" class="member-table">
311 <caption>Properties </caption>
315 <th class="sig-header" colspan="2">Properties</th>
317 <th class="msource-header">Defined By</th>
322 <for each="dtag" in="cfgProperties">
324 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
325 <td class="micon"><a class="exi" href="#expand"> </a></td>
328 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
329 <div class="fixedFont">
330 <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbolLong(dtag.type)) : "" )+}
331 {+ (dtag.flags ? (dtag.flags & 2 ? '' : 'read only') : '')+}
336 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
340 <div class="long">{+resolveLinks(dtag.desc)+}</div>
347 {# - fixme - add inheritied as link here #}
348 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbolLong(dtag.memberOf) +}
363 <!-- ============================== methods summary / details ======================== -->
366 <a id="{+data.alias+}-methods"></a>
367 <!-- constructor?? -->
373 ownMethods.push.apply(ownMethods, data.constructors.sort(makeSortby("name")));
374 ownMethods.push.apply(ownMethods, data.functions.sort(makeSortby("name")));
375 ownMethods.push.apply(ownMethods, data.methods.sort(makeSortby("name")));
378 <!-- constructors, then statics, then dynamics -->
382 <if test="!ownMethods.length">
384 <table cellspacing="0" class="member-table">
385 <caption class="Empty">Public Methods</caption>
386 <tr><td>None</td></tr>
390 <if test="ownMethods.length">
392 <table cellspacing="0" class="member-table">
393 <caption>Methods / Constructors</caption>
395 <th class="sig-header" colspan="2">Method / Constructor</th>
396 <th class="msource-header">Defined By</th>
404 <for each="member" in="ownMethods">
406 <tr class="method-row config-row-alt{+$member_i % 2+}{!
407 if (member.isConstructor && (!member.params || !member.params.length)) {
410 output += ' expandable';
414 if (member.memberOf == data.alias) {
415 output += " notInherited";
419 <td class="micon"><a class="exi" href="#expand"> </a></td>
423 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
424 <div class="fixedFont">
425 <span class="attributes">{!
426 if (member.isConstructor) {
427 output += "new <B>" +
428 member.memberOf + (!member.name || !member.name.length ? "" : ".") +"</B>";
431 if (member.isStatic) {
432 output += data.alias + ".";
435 !}</span><b class="itemname">{!
436 output += (!member.name || !member.name.length ? "" : member.name);
439 {+makeSignature(member.params)+}
441 <if test="(member.returns && member.returns.length) || !member.isConstructor">
444 if (member.returns.length > 1) {
445 output += (new Link().toSymbol("Object"));
447 output += (new Link().toSymbolLong(member.returns[0].type));
456 <if test="!member.isConstructor">
457 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
459 <if test="member.isConstructor">
460 <div class="short">Create a new {+data.alias +}</div>
464 <if test="!member.isConstructor">
465 {+resolveLinks(member.desc)+}
467 <if test="member.example">
468 <pre class="code">{+member.example+}</pre>
472 <if test="member.isConstructor">
473 Create a new {+data.alias +}
475 <if test="member.params && member.params.length">
476 <dl class="detailList">
477 <dt class="heading">Parameters:</dt>
478 <for each="item" in="member.params">
481 <if test="typeof(item.type) == 'object'">
482 <span class="fixedFont">{+(new Link().toSymbolLong('Function'))+}</span>
483 {+makeSignature(item.type.params)+}
487 if (member.returns && member.returns.length) {
488 output += ' : ' + (new Link().toSymbolLong(member.returns[0].type)) + ' ';
490 output += ' : none ';
496 <if test="typeof(item.type) != 'object'">
497 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
500 <if test="item.isOptional">
502 <if test="item.defaultValue">,
503 Default: {+item.defaultValue+}
507 <if test="!item.be_null">
508 <span style="color:red;">
518 {+resolveLinks(item.desc)+}
521 <if test="item.properties && item.properties.length">
522 <dl class="detailList">
523 <for each="returnitem" in="item.properties">
525 {+((returnitem.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(returnitem.type))+"</span> " : "")+} <b>{+returnitem.name+}</b>
528 {+resolveLinks(returnitem.desc)+}
547 <if test="member.deprecated">
548 <dl class="detailList">
549 <dt class="heading">Deprecated:</dt>
551 {+member.deprecated+}
556 <if test="member.exceptions && member.exceptions.length">
557 <dl class="detailList">
558 <dt class="heading">Throws:</dt>
559 <for each="item" in="member.exceptions">
561 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
563 <dd>{+resolveLinks(item.desc)+}</dd>
567 <if test="member.returns && member.returns.length">
568 <dl class="detailList">
569 <dt class="heading">Returns:</dt>
571 <if test="member.returns > 1">
572 <dl>An Object with these properties</dl>
575 <for each="item" in="member.returns">
577 if (member.returns.length > 1) {
578 output += item.name+ ': ';
581 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}
582 {+resolveLinks(item.desc)+}</dd>
594 <if test="!member.isConstructor">
595 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}
604 <!-- ============================== events summary / details ======================== -->
607 <a id="{+data.alias+}-events"></a>
613 var ownEvents = data.signals.sort(makeSortby("name"));
616 <if test="!ownEvents.length">
618 <table cellspacing="0" class="member-table">
619 <caption class="Empty">Events</caption>
620 <tr><td>None</td></tr>
626 <if test="ownEvents.length">
628 <table cellspacing="0" class="member-table">
629 <caption>Events - usage syntax: this.signals.EVENTNAME.connect( {+(new Link().toSymbolLong('Function' ))+} ) </caption>
632 <th class="sig-header" colspan="2">Event</th>
633 <th class="msource-header">Defined By</th>
641 <for each="member" in="ownEvents">
642 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
644 if (member.memberOf == data.alias) {
645 output += " notInherited";
654 <td class="micon"><a class="exi" href="#expand"> </a></td>
657 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
659 <div class="fixedFont">
660 <b class="itemname">{+member.name+}</b> {+makeSignature(member.params)+}
663 if (member.returns && member.returns.length) {
664 output += (new Link().toSymbolLong(member.returns[0].type));
677 <div class="short">{+resolveLinks(summarize(member.desc))+}
683 {+resolveLinks(member.desc)+}
686 <if test="member.params && member.params.length">
687 <dl class="detailList">
688 <dt class="heading">Parameters:</dt>
689 <for each="item" in="member.params">
691 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbolLong(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
692 <if test="item.isOptional"><i>Optional
693 <if test="item.defaultValue">,
694 Default: {+item.defaultValue+}
697 <dd>{+resolveLinks(item.desc)+}</dd>
702 <if test="member.exceptions.length">
703 <dl class="detailList">
704 <dt class="heading">Throws:</dt>
705 <for each="item" in="member.exceptions">
707 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
709 <dd>{+resolveLinks(item.desc)+}</dd>
713 <if test="member.returns && member.returns.length">
714 <dl class="detailList">
715 <dt class="heading">Returns:</dt>
716 <for each="item" in="member.returns">
717 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbolLong(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
730 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}
738 <a id="{+data.alias+}-references"></a>
744 <!-- ============================== footer ================================= -->
745 <div class="fineprint" style="clear:both">
746 <if test="data.copyright">©{+data.copyright+}<br /></if>
747 Documentation generated by
748 <a href="http://git.gnome.org/browse/introspection-doc-generator">Introspection Doc Generator</a>
750 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}