diff options
Diffstat (limited to 'doc/reference/html/seed-JavaScript-Classes.html')
| -rw-r--r-- | doc/reference/html/seed-JavaScript-Classes.html | 278 |
1 files changed, 189 insertions, 89 deletions
diff --git a/doc/reference/html/seed-JavaScript-Classes.html b/doc/reference/html/seed-JavaScript-Classes.html index 9a92c40..a20b9a8 100644 --- a/doc/reference/html/seed-JavaScript-Classes.html +++ b/doc/reference/html/seed-JavaScript-Classes.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Creating JavaScript classes</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Creating JavaScript classes: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="api.html" title="Part III. Seed API Reference"> <link rel="prev" href="seed-Native-Functions.html" title="Creating native functions"> <link rel="next" href="seed-SeedClosure.html" title="Using JavaScript closures"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="seed-Native-Functions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">Seed Reference Manual</th> -<td><a accesskey="n" href="seed-SeedClosure.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#seed-JavaScript-Classes.synopsis" class="shortcut">Top</a> - | - <a href="#seed-JavaScript-Classes.description" class="shortcut">Description</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#seed-JavaScript-Classes.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="seed-Native-Functions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-SeedClosure.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-JavaScript-Classes"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,21 +29,65 @@ <h2><span class="refentrytitle"><a name="seed-JavaScript-Classes.top_of_page"></a>Creating JavaScript classes</span></h2> <p>Creating JavaScript classes — Dealing with Seed class definitions and constructors</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="seed-JavaScript-Classes.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -enum <a class="link" href="seed-JavaScript-Classes.html#SeedPropertyAttributes" title="enum SeedPropertyAttributes">SeedPropertyAttributes</a>; -enum <a class="link" href="seed-JavaScript-Classes.html#SeedClassAttributes" title="enum SeedClassAttributes">SeedClassAttributes</a>; -typedef <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass">SeedClass</a>; -#define <a class="link" href="seed-JavaScript-Classes.html#seed-empty-class" title="seed_empty_class">seed_empty_class</a> -<a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="returnvalue">SeedClass</span></a> <a class="link" href="seed-JavaScript-Classes.html#seed-create-class" title="seed_create_class ()">seed_create_class</a> (<em class="parameter"><code><span class="type">seed_class_definition</span> *def</code></em>); -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-JavaScript-Classes.html#seed-make-constructor" title="seed_make_constructor ()">seed_make_constructor</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>, - <em class="parameter"><code><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> klass</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback" title="SeedObjectCallAsConstructorCallback ()"><span class="type">SeedObjectCallAsConstructorCallback</span></a> constructor</code></em>); +<div class="refsect1"> +<a name="seed-JavaScript-Classes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="returnvalue">SeedClass</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JavaScript-Classes.html#seed-create-class" title="seed_create_class ()">seed_create_class</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JavaScript-Classes.html#seed-make-constructor" title="seed_make_constructor ()">seed_make_constructor</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-JavaScript-Classes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="seed-JavaScript-Classes.html#SeedPropertyAttributes" title="enum SeedPropertyAttributes">SeedPropertyAttributes</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="seed-JavaScript-Classes.html#SeedClassAttributes" title="enum SeedClassAttributes">SeedClassAttributes</a></td> +</tr> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass">SeedClass</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="seed-JavaScript-Classes.html#seed-empty-class" title="seed_empty_class">seed_empty_class</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-JavaScript-Classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -65,93 +105,153 @@ to work with future versions of JSCore). </p> </div> <div class="refsect1"> -<a name="seed-JavaScript-Classes.details"></a><h2>Details</h2> +<a name="seed-JavaScript-Classes.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="SeedPropertyAttributes"></a><h3>enum SeedPropertyAttributes</h3> -<pre class="programlisting">typedef enum { - SEED_PROPERTY_ATTRIBUTE_NONE = 0, - SEED_PROPERTY_ATTRIBUTE_READ_ONLY = 1 << 1, - SEED_PROPERTY_ATTRIBUTE_DONT_ENUM = 1 << 2, - SEED_PROPERTY_ATTRIBUTE_DONT_DELETE = 1 << 3 -} SeedPropertyAttributes; -</pre> -<p> -</p> +<a name="seed-create-class"></a><h3>seed_create_class ()</h3> +<pre class="programlisting"><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="returnvalue">SeedClass</span></a> +seed_create_class (<em class="parameter"><code><span class="type">seed_class_definition</span> *def</code></em>);</pre> +<div class="refsect3"> +<a name="seed-create-class.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>def</p></td> +<td class="parameter_description"><p>A <span class="type">JSClassDefinition</span>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="seed-create-class.returns"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a>, described by <em class="parameter"><code>def</code></em> +.</p> </div> -<hr> -<div class="refsect2"> -<a name="SeedClassAttributes"></a><h3>enum SeedClassAttributes</h3> -<pre class="programlisting">typedef enum { - SEED_CLASS_ATTRIBUTE_NONE = 0, - SEED_CLASS_ATTRIBUTE_NO_SHARED_PROTOTYPE = 1 << 1 -} SeedClassAttributes; -</pre> -<p> -</p> </div> <hr> <div class="refsect2"> -<a name="SeedClass"></a><h3>SeedClass</h3> -<pre class="programlisting">typedef gpointer SeedClass; -</pre> -<p> -</p> +<a name="seed-make-constructor"></a><h3>seed_make_constructor ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_make_constructor (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>, + <em class="parameter"><code><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> klass</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback" title="SeedObjectCallAsConstructorCallback ()"><span class="type">SeedObjectCallAsConstructorCallback</span></a> constructor</code></em>);</pre> +<div class="refsect3"> +<a name="seed-make-constructor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>constructor</p></td> +<td class="parameter_description"><p>The <span class="type">JSObjectCallAsConstructorCallback</span> function to call when +the constructor is invoked with 'new'.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> </div> -<hr> +<div class="refsect3"> +<a name="seed-make-constructor.returns"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>, which is a constructor function.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="seed-JavaScript-Classes.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="seed-empty-class"></a><h3>seed_empty_class</h3> -<pre class="programlisting">#define seed_empty_class { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,}; -</pre> +<a name="SeedPropertyAttributes"></a><h3>enum SeedPropertyAttributes</h3> <p> </p> -</div> -<hr> -<div class="refsect2"> -<a name="seed-create-class"></a><h3>seed_create_class ()</h3> -<pre class="programlisting"><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="returnvalue">SeedClass</span></a> seed_create_class (<em class="parameter"><code><span class="type">seed_class_definition</span> *def</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<div class="refsect3"> +<a name="SeedPropertyAttributes.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td> -<td>A <span class="type">JSClassDefinition</span>.</td> +<td class="enum_member_name"><p><a name="SEED-PROPERTY-ATTRIBUTE-NONE:CAPS"></a>SEED_PROPERTY_ATTRIBUTE_NONE</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SEED-PROPERTY-ATTRIBUTE-READ-ONLY:CAPS"></a>SEED_PROPERTY_ATTRIBUTE_READ_ONLY</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="SEED-PROPERTY-ATTRIBUTE-DONT-ENUM:CAPS"></a>SEED_PROPERTY_ATTRIBUTE_DONT_ENUM</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a>, described by <em class="parameter"><code>def</code></em>.</td> +<td class="enum_member_name"><p><a name="SEED-PROPERTY-ATTRIBUTE-DONT-DELETE:CAPS"></a>SEED_PROPERTY_ATTRIBUTE_DONT_DELETE</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-make-constructor"></a><h3>seed_make_constructor ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_make_constructor (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>, - <em class="parameter"><code><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> klass</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback" title="SeedObjectCallAsConstructorCallback ()"><span class="type">SeedObjectCallAsConstructorCallback</span></a> constructor</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="SeedClassAttributes"></a><h3>enum SeedClassAttributes</h3> +<p> +</p> +<div class="refsect3"> +<a name="SeedClassAttributes.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>constructor</code></em> :</span></p></td> -<td>The <span class="type">JSObjectCallAsConstructorCallback</span> function to call when -the constructor is invoked with 'new'.</td> +<td class="enum_member_name"><p><a name="SEED-CLASS-ATTRIBUTE-NONE:CAPS"></a>SEED_CLASS_ATTRIBUTE_NONE</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>, which is a constructor function.</td> +<td class="enum_member_name"><p><a name="SEED-CLASS-ATTRIBUTE-NO-SHARED-PROTOTYPE:CAPS"></a>SEED_CLASS_ATTRIBUTE_NO_SHARED_PROTOTYPE</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> </div> +<hr> +<div class="refsect2"> +<a name="SeedClass"></a><h3>SeedClass</h3> +<pre class="programlisting">typedef gpointer SeedClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="seed-empty-class"></a><h3>seed_empty_class</h3> +<pre class="programlisting">#define seed_empty_class</pre> +<p> +</p> +</div> +</div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html>
\ No newline at end of file |