{! Link.base = "../"; /* all generated links will be relative to this */ !} JsDoc Reference - {+data.name+}
Back to Seed Clases

{+data.left_bar+}

{! var iblock_indent = 0; data.extendsClasses.reverse().map( function($) { output += (iblock_indent ? 'parent-child marker' : ''); output += new Link().toSymbolLong($.alias); output += "\n
"; iblock_indent += 1; } ) !}parent-child marker {+data.alias+}

{+makeImage(data.alias)+}

{+data.titleType+} {+data.alias+}

Import line: {+data.ns+} = imports.gi.{+data.ns+};
GIR File: {+data.gir_filename+}
C documentation: {+new Link().toGnome(data.alias)+}
{+data.titleType+} : {+data.name+}
Implements: {+ data.implementInterfaces.map( function($) { return new Link().toSymbolLong($.alias); } ).join(", ") +}
Implementations: {+ data.implementedBy .sort() .map( function($) { return new Link().toSymbolLong($); } ).join(", ") +}
Subclasses: {+ data.childClasses .sort() .map( function($) { return new Link().toSymbolLong($); } ).join(", ") +}
Extends: {+ new Link().toSymbolLong(data.extendsClasses[data.extendsClasses.length -1].alias) +}
{+resolveLinks(data.desc)+}
{! cfgProperties = data.values ? data.values.sort(makeSortby("name")) : []; !}
Values
Properties
{! cfgProperties = data.properties.sort(makeSortby("name")); !}
Properties
None
Properties
Properties Defined By
{! var ownMethods = []; ownMethods.push.apply(ownMethods, data.constructors.sort(makeSortby("name"))); ownMethods.push.apply(ownMethods, data.functions.sort(makeSortby("name"))); ownMethods.push.apply(ownMethods, data.methods.sort(makeSortby("name"))); !}
Public Methods
None
Methods / Constructors
Method / Constructor Defined By
 
{! if (member.isConstructor) { output += "new " + member.memberOf + (!member.name || !member.name.length ? "" : ".") +""; } else { if (member.isStatic) { output += data.alias + "."; } } !}{! output += (!member.name || !member.name.length ? "" : member.name); !} {+makeSignature(member.params)+} : {! if (member.returns.length > 1) { output += (new Link().toSymbol("Object")); } else { output += (new Link().toSymbolLong(member.returns[0].type)); } !}
{+resolveLinks(summarize(member.desc))+}
Create a new {+data.alias +}
{+resolveLinks(member.desc)+}
{+member.example+}
Create a new {+data.alias +}
Parameters:
{+(new Link().toSymbolLong('Function'))+} {+makeSignature(item.type.params)+} {! if (member.returns && member.returns.length) { output += ' : ' + (new Link().toSymbolLong(member.returns[0].type)) + ' '; } else { output += ' : none '; } !} {+((item.type)?""+(new Link().toSymbolLong(item.type))+" " : "")+} {+item.name+} Optional , Default: {+item.defaultValue+} Required (not null)
{+resolveLinks(item.desc)+}
{+((returnitem.type)?""+(new Link().toSymbolLong(returnitem.type))+" " : "")+} {+returnitem.name+}
{+resolveLinks(returnitem.desc)+}
Deprecated:
{+member.deprecated+}
Throws:
{+((item.type)?"{"+(new Link().toSymbolLong(item.type))+"} " : "")+} {+item.name+}
{+resolveLinks(item.desc)+}
Returns:
An Object with these properties
{! if (member.returns.length > 1) { output += item.name+ ': '; } !} {+((item.type)?""+(new Link().toSymbolLong(item.type))+" " : "")+} {+resolveLinks(item.desc)+}
{+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbolLong(member.memberOf) +}  
{! var ownEvents = data.signals.sort(makeSortby("name")); !}
Events
None
Events - usage syntax: this.signals.EVENTNAME.connect( {+(new Link().toSymbolLong('Function' ))+} )
Event Defined By
©{+data.copyright+}
Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on {+new Date()+}