diff options
Diffstat (limited to 'doc/reference/html')
37 files changed, 5531 insertions, 3297 deletions
diff --git a/doc/reference/html/GtkBuilder-module.html b/doc/reference/html/GtkBuilder-module.html index 9380f20..9eddca4 100644 --- a/doc/reference/html/GtkBuilder-module.html +++ b/doc/reference/html/GtkBuilder-module.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GtkBuilder</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>GtkBuilder: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="modules.html" title="Part IV. Seed Module Reference"> <link rel="prev" href="sqlite-module.html" title="SQLite"> <link rel="next" href="Sandbox-module.html" title="Sandbox"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="sqlite-module.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="modules.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="Sandbox-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="modules.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="sqlite-module.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="Sandbox-module.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div> @@ -33,7 +33,7 @@ </div></div> </div></div> <div class="refsect1"> -<a name="idp9134864"></a><h2>API Reference</h2> +<a name="id-1.5.5.3"></a><h2>API Reference</h2> <p> The GtkBuilder extends Gtk.GtkBuilder.prototype to implement a custom automatic signal connection function, which is useful in Seed. It does not provide any methods or types, so there is no need to save it's namespace, as of such it can be imported as follows. </p> @@ -47,8 +47,11 @@ <div class="refsect2"> <a name="gtkbuilder-connect-signals"></a><h3>builder.connect_signals (object, user_data)</h3> <p>Connects the signals present in the GtkBuilder to the functions present in <em class="parameter"><code>object</code></em>. That is to say, a signal with handler name, 'ok_button_clicked' will be connected to the 'ok_button_clicked' property of object.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>object</code></em></span></p></td> @@ -65,7 +68,7 @@ </p> </div> <div class="refsect1"> -<a name="idp7941616"></a><h2>Examples</h2> +<a name="id-1.5.5.4"></a><h2>Examples</h2> <p>Below are several examples of using the Seed GtkBuilder module. For additional resources, consult the examples/ folder of the Seed source</p> <div class="example"> <a name="GtkBuilder-xml-example"></a><p class="title"><b>Example 16. </b></p> @@ -122,7 +125,6 @@ Gtk.main(); </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/Sandbox-module.html b/doc/reference/html/Sandbox-module.html index bfb063d..8694502 100644 --- a/doc/reference/html/Sandbox-module.html +++ b/doc/reference/html/Sandbox-module.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Sandbox</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Sandbox: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="modules.html" title="Part IV. Seed Module Reference"> <link rel="prev" href="GtkBuilder-module.html" title="GtkBuilder"> <link rel="next" href="ix01.html" title="Index"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="GtkBuilder-module.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="modules.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="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="modules.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GtkBuilder-module.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ix01.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div> @@ -33,7 +33,7 @@ </div></div> </div></div> <div class="refsect1"> -<a name="idp6701488"></a><h2>API Reference</h2> +<a name="id-1.5.6.3"></a><h2>API Reference</h2> <p> The sandbox module allows the creation of isolated JSCore contexts with individual global objects. It is useful as a literal "sandbox" or in a variety of other contexts. </p> @@ -54,8 +54,11 @@ <div class="refsect2"> <a name="sandbox-eval"></a><h3>context.eval(source)</h3> <p>Evaluates a string <em class="parameter"><code>source</code></em> with context, returns the result.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>source</code></em></span></p></td> <td>undefined</td> @@ -87,25 +90,38 @@ </p> </div> <div class="refsect1"> -<a name="idp10155600"></a><h2>Examples</h2> +<a name="id-1.5.6.4"></a><h2>Examples</h2> <p>Below are several examples of using the Seed Sandbox module. For additional resources, consult the examples/ folder of the Seed source</p> <div class="example"> <a name="sandbox-example"></a><p class="title"><b>Example 17. </b></p> -<div class="example-contents"><pre class="programlisting"> -sandbox = imports.sandbox; +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal">sandbox </span><span class="symbol">=</span><span class="normal"> imports</span><span class="symbol">.</span><span class="normal">sandbox</span><span class="symbol">;</span> + +<span class="normal">ctx </span><span class="symbol">=</span><span class="normal"> </span><span class="usertype">new</span><span class="normal"> sandbox</span><span class="symbol">.</span><span class="function">Context</span><span class="symbol">();</span> +<span class="normal">ctx</span><span class="symbol">.</span><span class="function">eval</span><span class="symbol">(</span><span class="string">"b = 2+2"</span><span class="symbol">);</span> +<span class="function">print</span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">.</span><span class="normal">global</span><span class="symbol">.</span><span class="normal">b</span><span class="symbol">);</span><span class="normal"> </span><span class="comment">//4</span> +<span class="normal">ctx</span><span class="symbol">.</span><span class="normal">global</span><span class="symbol">.</span><span class="normal">b </span><span class="symbol">=</span><span class="normal"> </span><span class="usertype">new</span><span class="normal"> Gtk</span><span class="symbol">.</span><span class="function">Window</span><span class="symbol">();</span><span class="normal"> </span><span class="comment">// Possible to expose objects to the context.</span> +<span class="normal">ctx</span><span class="symbol">.</span><span class="function">eval</span><span class="symbol">(</span><span class="string">"b.show()"</span><span class="symbol">);</span></pre></td> + </tr> + </tbody> + </table> +</div> -ctx = new sandbox.Context(); -ctx.eval("b = 2+2"); -print(ctx.global.b); //4 -ctx.global.b = new Gtk.Window(); // Possible to expose objects to the context. -ctx.eval("b.show()"); - </pre></div> </div> <br class="example-break"> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/api.html b/doc/reference/html/api.html index 925e029..e2175fa 100644 --- a/doc/reference/html/api.html +++ b/doc/reference/html/api.html @@ -2,29 +2,29 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Part III. Seed API Reference</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Part III. Seed API Reference: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="index.html" title="Seed Reference Manual"> <link rel="prev" href="seed-importer.html" title="Importer"> <link rel="next" href="seed-Initialization.html" title="Initialization"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-importer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td> </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-Initialization.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="seed-importer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Initialization.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="part"> <div class="titlepage"><div><div><h1 class="title"> <a name="api"></a>Part III. Seed API Reference</h1></div></div></div> <div class="toc"> <p><b>Table of Contents</b></p> -<dl> +<dl class="toc"> <dt> <span class="refentrytitle"><a href="seed-Initialization.html">Initialization</a></span><span class="refpurpose"> — Overall setup of the Seed engine</span> </dt> @@ -69,7 +69,6 @@ <p>This is the documentation for the C API of Seed, used for embedding, and creating native C modules.</p> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/home.png b/doc/reference/html/home.png Binary files differindex fb60b55..9346b33 100644 --- a/doc/reference/html/home.png +++ b/doc/reference/html/home.png diff --git a/doc/reference/html/index.html b/doc/reference/html/index.html index b7ad436..fba8a75 100644 --- a/doc/reference/html/index.html +++ b/doc/reference/html/index.html @@ -2,11 +2,11 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Seed Reference Manual</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Seed Reference Manual: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="next" href="seed.html" title="Part I. Seed Overview"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -15,7 +15,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Seed Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - Documentation for Seed 3.8.1 + Documentation for Seed 3.8.2 . The latest version of this documentation can be found on-line at <a class="ulink" href="http://library.gnome.org/devel/seed/unstable/" target="_top">http://library.gnome.org/devel/seed/unstable/</a>. @@ -23,7 +23,7 @@ </div> <hr> </div> -<div class="toc"><dl> +<div class="toc"><dl class="toc"> <dt><span class="part"><a href="seed.html">I. Seed Overview</a></span></dt> <dd><dl> <dt> @@ -101,7 +101,6 @@ Importing gobject-introspection namespaces, native modules, and JavaScript modul </dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/index.sgml b/doc/reference/html/index.sgml index 7278609..fccccde 100644 --- a/doc/reference/html/index.sgml +++ b/doc/reference/html/index.sgml @@ -13,21 +13,23 @@ <ANCHOR id="seed-importer" href="seed/seed-importer.html"> <ANCHOR id="git" href="seed/seed-importer.html#git"> <ANCHOR id="seed-Initialization" href="seed/seed-Initialization.html"> -<ANCHOR id="seed-Initialization.synopsis" href="seed/seed-Initialization.html#seed-Initialization.synopsis"> +<ANCHOR id="seed-Initialization.functions" href="seed/seed-Initialization.html#seed-Initialization.functions"> +<ANCHOR id="seed-Initialization.other" href="seed/seed-Initialization.html#seed-Initialization.other"> +<ANCHOR id="seed-Initialization.includes" href="seed/seed-Initialization.html#seed-Initialization.includes"> <ANCHOR id="seed-Initialization.description" href="seed/seed-Initialization.html#seed-Initialization.description"> -<ANCHOR id="seed-Initialization.details" href="seed/seed-Initialization.html#seed-Initialization.details"> -<ANCHOR id="SeedEngine" href="seed/seed-Initialization.html#SeedEngine"> +<ANCHOR id="seed-Initialization.functions_details" href="seed/seed-Initialization.html#seed-Initialization.functions_details"> <ANCHOR id="seed-init" href="seed/seed-Initialization.html#seed-init"> <ANCHOR id="seed-init-with-context-group" href="seed/seed-Initialization.html#seed-init-with-context-group"> <ANCHOR id="seed-engine-set-search-path" href="seed/seed-Initialization.html#seed-engine-set-search-path"> <ANCHOR id="seed-engine-get-search-path" href="seed/seed-Initialization.html#seed-engine-get-search-path"> +<ANCHOR id="seed-Initialization.other_details" href="seed/seed-Initialization.html#seed-Initialization.other_details"> +<ANCHOR id="SeedEngine" href="seed/seed-Initialization.html#SeedEngine"> <ANCHOR id="seed-Contexts" href="seed/seed-Contexts.html"> -<ANCHOR id="seed-Contexts.synopsis" href="seed/seed-Contexts.html#seed-Contexts.synopsis"> +<ANCHOR id="seed-Contexts.functions" href="seed/seed-Contexts.html#seed-Contexts.functions"> +<ANCHOR id="seed-Contexts.other" href="seed/seed-Contexts.html#seed-Contexts.other"> +<ANCHOR id="seed-Contexts.includes" href="seed/seed-Contexts.html#seed-Contexts.includes"> <ANCHOR id="seed-Contexts.description" href="seed/seed-Contexts.html#seed-Contexts.description"> -<ANCHOR id="seed-Contexts.details" href="seed/seed-Contexts.html#seed-Contexts.details"> -<ANCHOR id="SeedContext" href="seed/seed-Contexts.html#SeedContext"> -<ANCHOR id="SeedGlobalContext" href="seed/seed-Contexts.html#SeedGlobalContext"> -<ANCHOR id="SeedContextGroup" href="seed/seed-Contexts.html#SeedContextGroup"> +<ANCHOR id="seed-Contexts.functions_details" href="seed/seed-Contexts.html#seed-Contexts.functions_details"> <ANCHOR id="seed-context-create" href="seed/seed-Contexts.html#seed-context-create"> <ANCHOR id="seed-context-ref" href="seed/seed-Contexts.html#seed-context-ref"> <ANCHOR id="seed-context-unref" href="seed/seed-Contexts.html#seed-context-unref"> @@ -36,40 +38,52 @@ <ANCHOR id="seed-prepare-global-context" href="seed/seed-Contexts.html#seed-prepare-global-context"> <ANCHOR id="seed-importer-add-global" href="seed/seed-Contexts.html#seed-importer-add-global"> <ANCHOR id="seed-importer-set-search-path" href="seed/seed-Contexts.html#seed-importer-set-search-path"> +<ANCHOR id="seed-Contexts.other_details" href="seed/seed-Contexts.html#seed-Contexts.other_details"> +<ANCHOR id="SeedContext" href="seed/seed-Contexts.html#SeedContext"> +<ANCHOR id="SeedGlobalContext" href="seed/seed-Contexts.html#SeedGlobalContext"> +<ANCHOR id="SeedContextGroup" href="seed/seed-Contexts.html#SeedContextGroup"> <ANCHOR id="seed-Evaluation" href="seed/seed-Evaluation.html"> -<ANCHOR id="seed-Evaluation.synopsis" href="seed/seed-Evaluation.html#seed-Evaluation.synopsis"> +<ANCHOR id="seed-Evaluation.functions" href="seed/seed-Evaluation.html#seed-Evaluation.functions"> +<ANCHOR id="seed-Evaluation.other" href="seed/seed-Evaluation.html#seed-Evaluation.other"> +<ANCHOR id="seed-Evaluation.includes" href="seed/seed-Evaluation.html#seed-Evaluation.includes"> <ANCHOR id="seed-Evaluation.description" href="seed/seed-Evaluation.html#seed-Evaluation.description"> -<ANCHOR id="seed-Evaluation.details" href="seed/seed-Evaluation.html#seed-Evaluation.details"> -<ANCHOR id="SeedScript" href="seed/seed-Evaluation.html#SeedScript"> +<ANCHOR id="seed-Evaluation.functions_details" href="seed/seed-Evaluation.html#seed-Evaluation.functions_details"> <ANCHOR id="seed-make-script" href="seed/seed-Evaluation.html#seed-make-script"> <ANCHOR id="seed-evaluate" href="seed/seed-Evaluation.html#seed-evaluate"> <ANCHOR id="seed-simple-evaluate" href="seed/seed-Evaluation.html#seed-simple-evaluate"> <ANCHOR id="seed-script-new-from-file" href="seed/seed-Evaluation.html#seed-script-new-from-file"> <ANCHOR id="seed-script-exception" href="seed/seed-Evaluation.html#seed-script-exception"> <ANCHOR id="seed-script-destroy" href="seed/seed-Evaluation.html#seed-script-destroy"> +<ANCHOR id="seed-Evaluation.other_details" href="seed/seed-Evaluation.html#seed-Evaluation.other_details"> +<ANCHOR id="SeedScript" href="seed/seed-Evaluation.html#SeedScript"> <ANCHOR id="seed-Exceptions" href="seed/seed-Exceptions.html"> -<ANCHOR id="seed-Exceptions.synopsis" href="seed/seed-Exceptions.html#seed-Exceptions.synopsis"> +<ANCHOR id="seed-Exceptions.functions" href="seed/seed-Exceptions.html#seed-Exceptions.functions"> +<ANCHOR id="seed-Exceptions.other" href="seed/seed-Exceptions.html#seed-Exceptions.other"> +<ANCHOR id="seed-Exceptions.includes" href="seed/seed-Exceptions.html#seed-Exceptions.includes"> <ANCHOR id="seed-Exceptions.description" href="seed/seed-Exceptions.html#seed-Exceptions.description"> -<ANCHOR id="seed-Exceptions.details" href="seed/seed-Exceptions.html#seed-Exceptions.details"> -<ANCHOR id="SeedException" href="seed/seed-Exceptions.html#SeedException"> +<ANCHOR id="seed-Exceptions.functions_details" href="seed/seed-Exceptions.html#seed-Exceptions.functions_details"> <ANCHOR id="seed-make-exception" href="seed/seed-Exceptions.html#seed-make-exception"> <ANCHOR id="seed-exception-get-name" href="seed/seed-Exceptions.html#seed-exception-get-name"> <ANCHOR id="seed-exception-get-message" href="seed/seed-Exceptions.html#seed-exception-get-message"> <ANCHOR id="seed-exception-get-line" href="seed/seed-Exceptions.html#seed-exception-get-line"> <ANCHOR id="seed-exception-get-file" href="seed/seed-Exceptions.html#seed-exception-get-file"> <ANCHOR id="seed-exception-to-string" href="seed/seed-Exceptions.html#seed-exception-to-string"> +<ANCHOR id="seed-Exceptions.other_details" href="seed/seed-Exceptions.html#seed-Exceptions.other_details"> +<ANCHOR id="SeedException" href="seed/seed-Exceptions.html#SeedException"> <ANCHOR id="seed-Signals" href="seed/seed-Signals.html"> -<ANCHOR id="seed-Signals.synopsis" href="seed/seed-Signals.html#seed-Signals.synopsis"> +<ANCHOR id="seed-Signals.functions" href="seed/seed-Signals.html#seed-Signals.functions"> +<ANCHOR id="seed-Signals.includes" href="seed/seed-Signals.html#seed-Signals.includes"> <ANCHOR id="seed-Signals.description" href="seed/seed-Signals.html#seed-Signals.description"> -<ANCHOR id="seed-Signals.details" href="seed/seed-Signals.html#seed-Signals.details"> +<ANCHOR id="seed-Signals.functions_details" href="seed/seed-Signals.html#seed-Signals.functions_details"> <ANCHOR id="seed-signal-connect" href="seed/seed-Signals.html#seed-signal-connect"> <ANCHOR id="seed-signal-connect-value" href="seed/seed-Signals.html#seed-signal-connect-value"> +<ANCHOR id="seed-Signals.other_details" href="seed/seed-Signals.html#seed-Signals.other_details"> <ANCHOR id="seed-Native-Type-Conversion" href="seed/seed-Native-Type-Conversion.html"> -<ANCHOR id="seed-Native-Type-Conversion.synopsis" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.synopsis"> +<ANCHOR id="seed-Native-Type-Conversion.functions" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.functions"> +<ANCHOR id="seed-Native-Type-Conversion.other" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.other"> +<ANCHOR id="seed-Native-Type-Conversion.includes" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.includes"> <ANCHOR id="seed-Native-Type-Conversion.description" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.description"> -<ANCHOR id="seed-Native-Type-Conversion.details" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.details"> -<ANCHOR id="SeedValue" href="seed/seed-Native-Type-Conversion.html#SeedValue"> -<ANCHOR id="SeedType" href="seed/seed-Native-Type-Conversion.html#SeedType"> +<ANCHOR id="seed-Native-Type-Conversion.functions_details" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.functions_details"> <ANCHOR id="seed-make-undefined" href="seed/seed-Native-Type-Conversion.html#seed-make-undefined"> <ANCHOR id="seed-make-null" href="seed/seed-Native-Type-Conversion.html#seed-make-null"> <ANCHOR id="seed-value-to-boolean" href="seed/seed-Native-Type-Conversion.html#seed-value-to-boolean"> @@ -104,17 +118,27 @@ <ANCHOR id="seed-value-to-format" href="seed/seed-Native-Type-Conversion.html#seed-value-to-format"> <ANCHOR id="seed-pointer-get-pointer" href="seed/seed-Native-Type-Conversion.html#seed-pointer-get-pointer"> <ANCHOR id="seed-make-pointer" href="seed/seed-Native-Type-Conversion.html#seed-make-pointer"> -<ANCHOR id="SeedString" href="seed/seed-Native-Type-Conversion.html#SeedString"> <ANCHOR id="seed-string-ref" href="seed/seed-Native-Type-Conversion.html#seed-string-ref"> <ANCHOR id="seed-string-unref" href="seed/seed-Native-Type-Conversion.html#seed-string-unref"> <ANCHOR id="seed-string-get-maximum-size" href="seed/seed-Native-Type-Conversion.html#seed-string-get-maximum-size"> <ANCHOR id="seed-string-to-utf8-buffer" href="seed/seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer"> <ANCHOR id="seed-string-is-equal" href="seed/seed-Native-Type-Conversion.html#seed-string-is-equal"> <ANCHOR id="seed-string-is-equal-utf8" href="seed/seed-Native-Type-Conversion.html#seed-string-is-equal-utf8"> +<ANCHOR id="seed-Native-Type-Conversion.other_details" href="seed/seed-Native-Type-Conversion.html#seed-Native-Type-Conversion.other_details"> +<ANCHOR id="SeedValue" href="seed/seed-Native-Type-Conversion.html#SeedValue"> +<ANCHOR id="SeedType" href="seed/seed-Native-Type-Conversion.html#SeedType"> +<ANCHOR id="SEED-TYPE-UNDEFINED:CAPS" href="seed/seed-Native-Type-Conversion.html#SEED-TYPE-UNDEFINED:CAPS"> +<ANCHOR id="SEED-TYPE-NULL:CAPS" href="seed/seed-Native-Type-Conversion.html#SEED-TYPE-NULL:CAPS"> +<ANCHOR id="SEED-TYPE-BOOLEAN:CAPS" href="seed/seed-Native-Type-Conversion.html#SEED-TYPE-BOOLEAN:CAPS"> +<ANCHOR id="SEED-TYPE-NUMBER:CAPS" href="seed/seed-Native-Type-Conversion.html#SEED-TYPE-NUMBER:CAPS"> +<ANCHOR id="SEED-TYPE-STRING:CAPS" href="seed/seed-Native-Type-Conversion.html#SEED-TYPE-STRING:CAPS"> +<ANCHOR id="SEED-TYPE-OBJECT:CAPS" href="seed/seed-Native-Type-Conversion.html#SEED-TYPE-OBJECT:CAPS"> +<ANCHOR id="SeedString" href="seed/seed-Native-Type-Conversion.html#SeedString"> <ANCHOR id="seed-Operating-on-Native-Types" href="seed/seed-Operating-on-Native-Types.html"> -<ANCHOR id="seed-Operating-on-Native-Types.synopsis" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.synopsis"> +<ANCHOR id="seed-Operating-on-Native-Types.functions" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.functions"> +<ANCHOR id="seed-Operating-on-Native-Types.includes" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.includes"> <ANCHOR id="seed-Operating-on-Native-Types.description" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.description"> -<ANCHOR id="seed-Operating-on-Native-Types.details" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.details"> +<ANCHOR id="seed-Operating-on-Native-Types.functions_details" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.functions_details"> <ANCHOR id="seed-value-unprotect" href="seed/seed-Operating-on-Native-Types.html#seed-value-unprotect"> <ANCHOR id="seed-value-protect" href="seed/seed-Operating-on-Native-Types.html#seed-value-protect"> <ANCHOR id="seed-value-is-undefined" href="seed/seed-Operating-on-Native-Types.html#seed-value-is-undefined"> @@ -125,11 +149,13 @@ <ANCHOR id="seed-value-is-object-of-class" href="seed/seed-Operating-on-Native-Types.html#seed-value-is-object-of-class"> <ANCHOR id="seed-value-is-object" href="seed/seed-Operating-on-Native-Types.html#seed-value-is-object"> <ANCHOR id="seed-value-get-type" href="seed/seed-Operating-on-Native-Types.html#seed-value-get-type"> +<ANCHOR id="seed-Operating-on-Native-Types.other_details" href="seed/seed-Operating-on-Native-Types.html#seed-Operating-on-Native-Types.other_details"> <ANCHOR id="seed-JS-Objects" href="seed/seed-JS-Objects.html"> -<ANCHOR id="seed-JS-Objects.synopsis" href="seed/seed-JS-Objects.html#seed-JS-Objects.synopsis"> +<ANCHOR id="seed-JS-Objects.functions" href="seed/seed-JS-Objects.html#seed-JS-Objects.functions"> +<ANCHOR id="seed-JS-Objects.other" href="seed/seed-JS-Objects.html#seed-JS-Objects.other"> +<ANCHOR id="seed-JS-Objects.includes" href="seed/seed-JS-Objects.html#seed-JS-Objects.includes"> <ANCHOR id="seed-JS-Objects.description" href="seed/seed-JS-Objects.html#seed-JS-Objects.description"> -<ANCHOR id="seed-JS-Objects.details" href="seed/seed-JS-Objects.html#seed-JS-Objects.details"> -<ANCHOR id="SeedObject" href="seed/seed-JS-Objects.html#SeedObject"> +<ANCHOR id="seed-JS-Objects.functions_details" href="seed/seed-JS-Objects.html#seed-JS-Objects.functions_details"> <ANCHOR id="seed-make-object" href="seed/seed-JS-Objects.html#seed-make-object"> <ANCHOR id="seed-make-array" href="seed/seed-JS-Objects.html#seed-make-array"> <ANCHOR id="seed-object-call" href="seed/seed-JS-Objects.html#seed-object-call"> @@ -153,41 +179,59 @@ <ANCHOR id="SeedObjectHasInstanceCallback" href="seed/seed-JS-Objects.html#SeedObjectHasInstanceCallback"> <ANCHOR id="SeedObjectConvertToTypeCallback" href="seed/seed-JS-Objects.html#SeedObjectConvertToTypeCallback"> <ANCHOR id="SeedObjectCallAsConstructorCallback" href="seed/seed-JS-Objects.html#SeedObjectCallAsConstructorCallback"> +<ANCHOR id="seed-JS-Objects.other_details" href="seed/seed-JS-Objects.html#seed-JS-Objects.other_details"> +<ANCHOR id="SeedObject" href="seed/seed-JS-Objects.html#SeedObject"> <ANCHOR id="seed-Native-Functions" href="seed/seed-Native-Functions.html"> -<ANCHOR id="seed-Native-Functions.synopsis" href="seed/seed-Native-Functions.html#seed-Native-Functions.synopsis"> +<ANCHOR id="seed-Native-Functions.functions" href="seed/seed-Native-Functions.html#seed-Native-Functions.functions"> +<ANCHOR id="seed-Native-Functions.includes" href="seed/seed-Native-Functions.html#seed-Native-Functions.includes"> <ANCHOR id="seed-Native-Functions.description" href="seed/seed-Native-Functions.html#seed-Native-Functions.description"> -<ANCHOR id="seed-Native-Functions.details" href="seed/seed-Native-Functions.html#seed-Native-Functions.details"> +<ANCHOR id="seed-Native-Functions.functions_details" href="seed/seed-Native-Functions.html#seed-Native-Functions.functions_details"> <ANCHOR id="SeedFunctionCallback" href="seed/seed-Native-Functions.html#SeedFunctionCallback"> <ANCHOR id="seed-make-function" href="seed/seed-Native-Functions.html#seed-make-function"> <ANCHOR id="seed-create-function" href="seed/seed-Native-Functions.html#seed-create-function"> +<ANCHOR id="seed-Native-Functions.other_details" href="seed/seed-Native-Functions.html#seed-Native-Functions.other_details"> <ANCHOR id="seed-JavaScript-Classes" href="seed/seed-JavaScript-Classes.html"> -<ANCHOR id="seed-JavaScript-Classes.synopsis" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.synopsis"> +<ANCHOR id="seed-JavaScript-Classes.functions" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.functions"> +<ANCHOR id="seed-JavaScript-Classes.other" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.other"> +<ANCHOR id="seed-JavaScript-Classes.includes" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.includes"> <ANCHOR id="seed-JavaScript-Classes.description" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.description"> -<ANCHOR id="seed-JavaScript-Classes.details" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.details"> +<ANCHOR id="seed-JavaScript-Classes.functions_details" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.functions_details"> +<ANCHOR id="seed-create-class" href="seed/seed-JavaScript-Classes.html#seed-create-class"> +<ANCHOR id="seed-make-constructor" href="seed/seed-JavaScript-Classes.html#seed-make-constructor"> +<ANCHOR id="seed-JavaScript-Classes.other_details" href="seed/seed-JavaScript-Classes.html#seed-JavaScript-Classes.other_details"> <ANCHOR id="SeedPropertyAttributes" href="seed/seed-JavaScript-Classes.html#SeedPropertyAttributes"> +<ANCHOR id="SEED-PROPERTY-ATTRIBUTE-NONE:CAPS" href="seed/seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-NONE:CAPS"> +<ANCHOR id="SEED-PROPERTY-ATTRIBUTE-READ-ONLY:CAPS" href="seed/seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-READ-ONLY:CAPS"> +<ANCHOR id="SEED-PROPERTY-ATTRIBUTE-DONT-ENUM:CAPS" href="seed/seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-DONT-ENUM:CAPS"> +<ANCHOR id="SEED-PROPERTY-ATTRIBUTE-DONT-DELETE:CAPS" href="seed/seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-DONT-DELETE:CAPS"> <ANCHOR id="SeedClassAttributes" href="seed/seed-JavaScript-Classes.html#SeedClassAttributes"> +<ANCHOR id="SEED-CLASS-ATTRIBUTE-NONE:CAPS" href="seed/seed-JavaScript-Classes.html#SEED-CLASS-ATTRIBUTE-NONE:CAPS"> +<ANCHOR id="SEED-CLASS-ATTRIBUTE-NO-SHARED-PROTOTYPE:CAPS" href="seed/seed-JavaScript-Classes.html#SEED-CLASS-ATTRIBUTE-NO-SHARED-PROTOTYPE:CAPS"> <ANCHOR id="SeedClass" href="seed/seed-JavaScript-Classes.html#SeedClass"> <ANCHOR id="seed-empty-class" href="seed/seed-JavaScript-Classes.html#seed-empty-class"> -<ANCHOR id="seed-create-class" href="seed/seed-JavaScript-Classes.html#seed-create-class"> -<ANCHOR id="seed-make-constructor" href="seed/seed-JavaScript-Classes.html#seed-make-constructor"> <ANCHOR id="seed-SeedClosure" href="seed/seed-SeedClosure.html"> -<ANCHOR id="seed-SeedClosure.synopsis" href="seed/seed-SeedClosure.html#seed-SeedClosure.synopsis"> +<ANCHOR id="seed-SeedClosure.functions" href="seed/seed-SeedClosure.html#seed-SeedClosure.functions"> +<ANCHOR id="seed-SeedClosure.other" href="seed/seed-SeedClosure.html#seed-SeedClosure.other"> +<ANCHOR id="seed-SeedClosure.includes" href="seed/seed-SeedClosure.html#seed-SeedClosure.includes"> <ANCHOR id="seed-SeedClosure.description" href="seed/seed-SeedClosure.html#seed-SeedClosure.description"> -<ANCHOR id="seed-SeedClosure.details" href="seed/seed-SeedClosure.html#seed-SeedClosure.details"> -<ANCHOR id="SeedClosure" href="seed/seed-SeedClosure.html#SeedClosure"> +<ANCHOR id="seed-SeedClosure.functions_details" href="seed/seed-SeedClosure.html#seed-SeedClosure.functions_details"> <ANCHOR id="seed-closure-new" href="seed/seed-SeedClosure.html#seed-closure-new"> <ANCHOR id="seed-closure-get-callable" href="seed/seed-SeedClosure.html#seed-closure-get-callable"> <ANCHOR id="seed-closure-invoke" href="seed/seed-SeedClosure.html#seed-closure-invoke"> <ANCHOR id="seed-closure-invoke-with-context" href="seed/seed-SeedClosure.html#seed-closure-invoke-with-context"> <ANCHOR id="seed-closure-warn-exception" href="seed/seed-SeedClosure.html#seed-closure-warn-exception"> +<ANCHOR id="seed-SeedClosure.other_details" href="seed/seed-SeedClosure.html#seed-SeedClosure.other_details"> +<ANCHOR id="SeedClosure" href="seed/seed-SeedClosure.html#SeedClosure"> <ANCHOR id="seed-Modules" href="seed/seed-Modules.html"> -<ANCHOR id="seed-Modules.synopsis" href="seed/seed-Modules.html#seed-Modules.synopsis"> +<ANCHOR id="seed-Modules.functions" href="seed/seed-Modules.html#seed-Modules.functions"> +<ANCHOR id="seed-Modules.includes" href="seed/seed-Modules.html#seed-Modules.includes"> <ANCHOR id="seed-Modules.description" href="seed/seed-Modules.html#seed-Modules.description"> -<ANCHOR id="seed-Modules.details" href="seed/seed-Modules.html#seed-Modules.details"> +<ANCHOR id="seed-Modules.functions_details" href="seed/seed-Modules.html#seed-Modules.functions_details"> <ANCHOR id="CHECK-ARG-COUNT:CAPS" href="seed/seed-Modules.html#CHECK-ARG-COUNT:CAPS"> <ANCHOR id="DEFINE-ENUM-MEMBER:CAPS" href="seed/seed-Modules.html#DEFINE-ENUM-MEMBER:CAPS"> <ANCHOR id="DEFINE-ENUM-MEMBER-EXT:CAPS" href="seed/seed-Modules.html#DEFINE-ENUM-MEMBER-EXT:CAPS"> <ANCHOR id="SeedModuleInitCallback" href="seed/seed-Modules.html#SeedModuleInitCallback"> +<ANCHOR id="seed-Modules.other_details" href="seed/seed-Modules.html#seed-Modules.other_details"> <ANCHOR id="readline-readline" href="seed/readline-module.html#readline-readline"> <ANCHOR id="readline-bind" href="seed/readline-module.html#readline-bind"> <ANCHOR id="readline-done" href="seed/readline-module.html#readline-done"> diff --git a/doc/reference/html/ix01.html b/doc/reference/html/ix01.html index 2037c59..19048ae 100644 --- a/doc/reference/html/ix01.html +++ b/doc/reference/html/ix01.html @@ -2,25 +2,25 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Index</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Index: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="index.html" title="Seed Reference Manual"> <link rel="prev" href="Sandbox-module.html" title="Sandbox"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="Sandbox-module.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td> </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> </td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="Sandbox-module.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> </tr></table> <div class="index"> -<div class="titlepage"><div><div><h2 class="title"> -<a name="idp3803440"></a>Index</h2></div></div></div> +<div class="titlepage"><div><div><h1 class="title"> +<a name="id-1.6"></a>Index</h1></div></div></div> <div class="index"> <div class="indexdiv"> <h3>C</h3> @@ -33,33 +33,33 @@ </dt> <dt>SeedClosure, <a class="indexterm" href="seed-SeedClosure.html#SeedClosure">struct SeedClosure</a> </dt> -<dt>seed_closure_get_callable, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-get-callable">seed_closure_get_callable ()</a> +<dt>seed_closure_get_callable, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-get-callable">seed_closure_get_callable ()</a> </dt> -<dt>seed_closure_invoke, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-invoke">seed_closure_invoke ()</a> +<dt>seed_closure_invoke, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-invoke">seed_closure_invoke ()</a> </dt> -<dt>seed_closure_invoke_with_context, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-invoke-with-context">seed_closure_invoke_with_context ()</a> +<dt>seed_closure_invoke_with_context, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-invoke-with-context">seed_closure_invoke_with_context ()</a> </dt> -<dt>seed_closure_new, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-new">seed_closure_new ()</a> +<dt>seed_closure_new, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-new">seed_closure_new ()</a> </dt> -<dt>seed_closure_warn_exception, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-warn-exception">seed_closure_warn_exception ()</a> +<dt>seed_closure_warn_exception, <a class="indexterm" href="seed-SeedClosure.html#seed-closure-warn-exception">seed_closure_warn_exception ()</a> </dt> <dt>SeedContext, <a class="indexterm" href="seed-Contexts.html#SeedContext">SeedContext</a> </dt> <dt>SeedContextGroup, <a class="indexterm" href="seed-Contexts.html#SeedContextGroup">SeedContextGroup</a> </dt> -<dt>seed_context_collect, <a class="indexterm" href="seed-Contexts.html#seed-context-collect">seed_context_collect ()</a> +<dt>seed_context_collect, <a class="indexterm" href="seed-Contexts.html#seed-context-collect">seed_context_collect ()</a> </dt> -<dt>seed_context_create, <a class="indexterm" href="seed-Contexts.html#seed-context-create">seed_context_create ()</a> +<dt>seed_context_create, <a class="indexterm" href="seed-Contexts.html#seed-context-create">seed_context_create ()</a> </dt> -<dt>seed_context_get_global_object, <a class="indexterm" href="seed-Contexts.html#seed-context-get-global-object">seed_context_get_global_object ()</a> +<dt>seed_context_get_global_object, <a class="indexterm" href="seed-Contexts.html#seed-context-get-global-object">seed_context_get_global_object ()</a> </dt> -<dt>seed_context_ref, <a class="indexterm" href="seed-Contexts.html#seed-context-ref">seed_context_ref ()</a> +<dt>seed_context_ref, <a class="indexterm" href="seed-Contexts.html#seed-context-ref">seed_context_ref ()</a> </dt> -<dt>seed_context_unref, <a class="indexterm" href="seed-Contexts.html#seed-context-unref">seed_context_unref ()</a> +<dt>seed_context_unref, <a class="indexterm" href="seed-Contexts.html#seed-context-unref">seed_context_unref ()</a> </dt> -<dt>seed_create_class, <a class="indexterm" href="seed-JavaScript-Classes.html#seed-create-class">seed_create_class ()</a> +<dt>seed_create_class, <a class="indexterm" href="seed-JavaScript-Classes.html#seed-create-class">seed_create_class ()</a> </dt> -<dt>seed_create_function, <a class="indexterm" href="seed-Native-Functions.html#seed-create-function">seed_create_function ()</a> +<dt>seed_create_function, <a class="indexterm" href="seed-Native-Functions.html#seed-create-function">seed_create_function ()</a> </dt> </dl> </div> @@ -79,29 +79,29 @@ </dt> <dt>SeedEngine, <a class="indexterm" href="seed-Initialization.html#SeedEngine">struct SeedEngine</a> </dt> -<dt>seed_engine_get_search_path, <a class="indexterm" href="seed-Initialization.html#seed-engine-get-search-path">seed_engine_get_search_path ()</a> +<dt>seed_engine_get_search_path, <a class="indexterm" href="seed-Initialization.html#seed-engine-get-search-path">seed_engine_get_search_path ()</a> </dt> -<dt>seed_engine_set_search_path, <a class="indexterm" href="seed-Initialization.html#seed-engine-set-search-path">seed_engine_set_search_path ()</a> +<dt>seed_engine_set_search_path, <a class="indexterm" href="seed-Initialization.html#seed-engine-set-search-path">seed_engine_set_search_path ()</a> </dt> -<dt>seed_evaluate, <a class="indexterm" href="seed-Evaluation.html#seed-evaluate">seed_evaluate ()</a> +<dt>seed_evaluate, <a class="indexterm" href="seed-Evaluation.html#seed-evaluate">seed_evaluate ()</a> </dt> <dt>SeedException, <a class="indexterm" href="seed-Exceptions.html#SeedException">SeedException</a> </dt> -<dt>seed_exception_get_file, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-file">seed_exception_get_file ()</a> +<dt>seed_exception_get_file, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-file">seed_exception_get_file ()</a> </dt> -<dt>seed_exception_get_line, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-line">seed_exception_get_line ()</a> +<dt>seed_exception_get_line, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-line">seed_exception_get_line ()</a> </dt> -<dt>seed_exception_get_message, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-message">seed_exception_get_message ()</a> +<dt>seed_exception_get_message, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-message">seed_exception_get_message ()</a> </dt> -<dt>seed_exception_get_name, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-name">seed_exception_get_name ()</a> +<dt>seed_exception_get_name, <a class="indexterm" href="seed-Exceptions.html#seed-exception-get-name">seed_exception_get_name ()</a> </dt> -<dt>seed_exception_to_string, <a class="indexterm" href="seed-Exceptions.html#seed-exception-to-string">seed_exception_to_string ()</a> +<dt>seed_exception_to_string, <a class="indexterm" href="seed-Exceptions.html#seed-exception-to-string">seed_exception_to_string ()</a> </dt> </dl> </div> <div class="indexdiv"> <h3>F</h3> -<dl><dt>SeedFunctionCallback, <a class="indexterm" href="seed-Native-Functions.html#SeedFunctionCallback">SeedFunctionCallback ()</a> +<dl><dt>SeedFunctionCallback, <a class="indexterm" href="seed-Native-Functions.html#SeedFunctionCallback">SeedFunctionCallback ()</a> </dt></dl> </div> <div class="indexdiv"> @@ -112,38 +112,38 @@ <div class="indexdiv"> <h3>I</h3> <dl> -<dt>seed_importer_add_global, <a class="indexterm" href="seed-Contexts.html#seed-importer-add-global">seed_importer_add_global ()</a> +<dt>seed_importer_add_global, <a class="indexterm" href="seed-Contexts.html#seed-importer-add-global">seed_importer_add_global ()</a> </dt> -<dt>seed_importer_set_search_path, <a class="indexterm" href="seed-Contexts.html#seed-importer-set-search-path">seed_importer_set_search_path ()</a> +<dt>seed_importer_set_search_path, <a class="indexterm" href="seed-Contexts.html#seed-importer-set-search-path">seed_importer_set_search_path ()</a> </dt> -<dt>seed_init, <a class="indexterm" href="seed-Initialization.html#seed-init">seed_init ()</a> +<dt>seed_init, <a class="indexterm" href="seed-Initialization.html#seed-init">seed_init ()</a> </dt> -<dt>seed_init_with_context_group, <a class="indexterm" href="seed-Initialization.html#seed-init-with-context-group">seed_init_with_context_group ()</a> +<dt>seed_init_with_context_group, <a class="indexterm" href="seed-Initialization.html#seed-init-with-context-group">seed_init_with_context_group ()</a> </dt> </dl> </div> <div class="indexdiv"> <h3>M</h3> <dl> -<dt>seed_make_array, <a class="indexterm" href="seed-JS-Objects.html#seed-make-array">seed_make_array ()</a> +<dt>seed_make_array, <a class="indexterm" href="seed-JS-Objects.html#seed-make-array">seed_make_array ()</a> </dt> -<dt>seed_make_constructor, <a class="indexterm" href="seed-JavaScript-Classes.html#seed-make-constructor">seed_make_constructor ()</a> +<dt>seed_make_constructor, <a class="indexterm" href="seed-JavaScript-Classes.html#seed-make-constructor">seed_make_constructor ()</a> </dt> -<dt>seed_make_exception, <a class="indexterm" href="seed-Exceptions.html#seed-make-exception">seed_make_exception ()</a> +<dt>seed_make_exception, <a class="indexterm" href="seed-Exceptions.html#seed-make-exception">seed_make_exception ()</a> </dt> -<dt>seed_make_function, <a class="indexterm" href="seed-Native-Functions.html#seed-make-function">seed_make_function ()</a> +<dt>seed_make_function, <a class="indexterm" href="seed-Native-Functions.html#seed-make-function">seed_make_function ()</a> </dt> -<dt>seed_make_null, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-make-null">seed_make_null ()</a> +<dt>seed_make_null, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-make-null">seed_make_null ()</a> </dt> -<dt>seed_make_object, <a class="indexterm" href="seed-JS-Objects.html#seed-make-object">seed_make_object ()</a> +<dt>seed_make_object, <a class="indexterm" href="seed-JS-Objects.html#seed-make-object">seed_make_object ()</a> </dt> -<dt>seed_make_pointer, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-make-pointer">seed_make_pointer ()</a> +<dt>seed_make_pointer, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-make-pointer">seed_make_pointer ()</a> </dt> -<dt>seed_make_script, <a class="indexterm" href="seed-Evaluation.html#seed-make-script">seed_make_script ()</a> +<dt>seed_make_script, <a class="indexterm" href="seed-Evaluation.html#seed-make-script">seed_make_script ()</a> </dt> -<dt>seed_make_undefined, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-make-undefined">seed_make_undefined ()</a> +<dt>seed_make_undefined, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-make-undefined">seed_make_undefined ()</a> </dt> -<dt>SeedModuleInitCallback, <a class="indexterm" href="seed-Modules.html#SeedModuleInitCallback">SeedModuleInitCallback ()</a> +<dt>SeedModuleInitCallback, <a class="indexterm" href="seed-Modules.html#SeedModuleInitCallback">SeedModuleInitCallback ()</a> </dt> </dl> </div> @@ -152,56 +152,56 @@ <dl> <dt>SeedObject, <a class="indexterm" href="seed-JS-Objects.html#SeedObject">SeedObject</a> </dt> -<dt>SeedObjectCallAsConstructorCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback">SeedObjectCallAsConstructorCallback ()</a> +<dt>SeedObjectCallAsConstructorCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback">SeedObjectCallAsConstructorCallback ()</a> </dt> -<dt>SeedObjectCallAsFunctionCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectCallAsFunctionCallback">SeedObjectCallAsFunctionCallback ()</a> +<dt>SeedObjectCallAsFunctionCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectCallAsFunctionCallback">SeedObjectCallAsFunctionCallback ()</a> </dt> -<dt>SeedObjectConvertToTypeCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectConvertToTypeCallback">SeedObjectConvertToTypeCallback ()</a> +<dt>SeedObjectConvertToTypeCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectConvertToTypeCallback">SeedObjectConvertToTypeCallback ()</a> </dt> -<dt>SeedObjectDeletePropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectDeletePropertyCallback">SeedObjectDeletePropertyCallback ()</a> +<dt>SeedObjectDeletePropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectDeletePropertyCallback">SeedObjectDeletePropertyCallback ()</a> </dt> -<dt>SeedObjectFinalizeCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectFinalizeCallback">SeedObjectFinalizeCallback ()</a> +<dt>SeedObjectFinalizeCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectFinalizeCallback">SeedObjectFinalizeCallback ()</a> </dt> -<dt>SeedObjectGetPropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectGetPropertyCallback">SeedObjectGetPropertyCallback ()</a> +<dt>SeedObjectGetPropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectGetPropertyCallback">SeedObjectGetPropertyCallback ()</a> </dt> -<dt>SeedObjectGetPropertyNamesCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectGetPropertyNamesCallback">SeedObjectGetPropertyNamesCallback ()</a> +<dt>SeedObjectGetPropertyNamesCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectGetPropertyNamesCallback">SeedObjectGetPropertyNamesCallback ()</a> </dt> -<dt>SeedObjectHasInstanceCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectHasInstanceCallback">SeedObjectHasInstanceCallback ()</a> +<dt>SeedObjectHasInstanceCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectHasInstanceCallback">SeedObjectHasInstanceCallback ()</a> </dt> -<dt>SeedObjectHasPropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectHasPropertyCallback">SeedObjectHasPropertyCallback ()</a> +<dt>SeedObjectHasPropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectHasPropertyCallback">SeedObjectHasPropertyCallback ()</a> </dt> -<dt>SeedObjectInitializeCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectInitializeCallback">SeedObjectInitializeCallback ()</a> +<dt>SeedObjectInitializeCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectInitializeCallback">SeedObjectInitializeCallback ()</a> </dt> -<dt>SeedObjectSetPropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectSetPropertyCallback">SeedObjectSetPropertyCallback ()</a> +<dt>SeedObjectSetPropertyCallback, <a class="indexterm" href="seed-JS-Objects.html#SeedObjectSetPropertyCallback">SeedObjectSetPropertyCallback ()</a> </dt> -<dt>seed_object_call, <a class="indexterm" href="seed-JS-Objects.html#seed-object-call">seed_object_call ()</a> +<dt>seed_object_call, <a class="indexterm" href="seed-JS-Objects.html#seed-object-call">seed_object_call ()</a> </dt> -<dt>seed_object_copy_property_names, <a class="indexterm" href="seed-JS-Objects.html#seed-object-copy-property-names">seed_object_copy_property_names ()</a> +<dt>seed_object_copy_property_names, <a class="indexterm" href="seed-JS-Objects.html#seed-object-copy-property-names">seed_object_copy_property_names ()</a> </dt> -<dt>seed_object_get_private, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-private">seed_object_get_private ()</a> +<dt>seed_object_get_private, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-private">seed_object_get_private ()</a> </dt> -<dt>seed_object_get_property, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-property">seed_object_get_property ()</a> +<dt>seed_object_get_property, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-property">seed_object_get_property ()</a> </dt> -<dt>seed_object_get_property_at_index, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-property-at-index">seed_object_get_property_at_index ()</a> +<dt>seed_object_get_property_at_index, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-property-at-index">seed_object_get_property_at_index ()</a> </dt> -<dt>seed_object_get_prototype, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-prototype">seed_object_get_prototype ()</a> +<dt>seed_object_get_prototype, <a class="indexterm" href="seed-JS-Objects.html#seed-object-get-prototype">seed_object_get_prototype ()</a> </dt> -<dt>seed_object_is_of_class, <a class="indexterm" href="seed-JS-Objects.html#seed-object-is-of-class">seed_object_is_of_class ()</a> +<dt>seed_object_is_of_class, <a class="indexterm" href="seed-JS-Objects.html#seed-object-is-of-class">seed_object_is_of_class ()</a> </dt> -<dt>seed_object_set_private, <a class="indexterm" href="seed-JS-Objects.html#seed-object-set-private">seed_object_set_private ()</a> +<dt>seed_object_set_private, <a class="indexterm" href="seed-JS-Objects.html#seed-object-set-private">seed_object_set_private ()</a> </dt> -<dt>seed_object_set_property, <a class="indexterm" href="seed-JS-Objects.html#seed-object-set-property">seed_object_set_property ()</a> +<dt>seed_object_set_property, <a class="indexterm" href="seed-JS-Objects.html#seed-object-set-property">seed_object_set_property ()</a> </dt> -<dt>seed_object_set_property_at_index, <a class="indexterm" href="seed-JS-Objects.html#seed-object-set-property-at-index">seed_object_set_property_at_index ()</a> +<dt>seed_object_set_property_at_index, <a class="indexterm" href="seed-JS-Objects.html#seed-object-set-property-at-index">seed_object_set_property_at_index ()</a> </dt> </dl> </div> <div class="indexdiv"> <h3>P</h3> <dl> -<dt>seed_pointer_get_pointer, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-pointer-get-pointer">seed_pointer_get_pointer ()</a> +<dt>seed_pointer_get_pointer, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-pointer-get-pointer">seed_pointer_get_pointer ()</a> </dt> -<dt>seed_prepare_global_context, <a class="indexterm" href="seed-Contexts.html#seed-prepare-global-context">seed_prepare_global_context ()</a> +<dt>seed_prepare_global_context, <a class="indexterm" href="seed-Contexts.html#seed-prepare-global-context">seed_prepare_global_context ()</a> </dt> <dt>SeedPropertyAttributes, <a class="indexterm" href="seed-JavaScript-Classes.html#SeedPropertyAttributes">enum SeedPropertyAttributes</a> </dt> @@ -212,31 +212,31 @@ <dl> <dt>SeedScript, <a class="indexterm" href="seed-Evaluation.html#SeedScript">SeedScript</a> </dt> -<dt>seed_script_destroy, <a class="indexterm" href="seed-Evaluation.html#seed-script-destroy">seed_script_destroy ()</a> +<dt>seed_script_destroy, <a class="indexterm" href="seed-Evaluation.html#seed-script-destroy">seed_script_destroy ()</a> </dt> -<dt>seed_script_exception, <a class="indexterm" href="seed-Evaluation.html#seed-script-exception">seed_script_exception ()</a> +<dt>seed_script_exception, <a class="indexterm" href="seed-Evaluation.html#seed-script-exception">seed_script_exception ()</a> </dt> -<dt>seed_script_new_from_file, <a class="indexterm" href="seed-Evaluation.html#seed-script-new-from-file">seed_script_new_from_file ()</a> +<dt>seed_script_new_from_file, <a class="indexterm" href="seed-Evaluation.html#seed-script-new-from-file">seed_script_new_from_file ()</a> </dt> -<dt>seed_signal_connect, <a class="indexterm" href="seed-Signals.html#seed-signal-connect">seed_signal_connect ()</a> +<dt>seed_signal_connect, <a class="indexterm" href="seed-Signals.html#seed-signal-connect">seed_signal_connect ()</a> </dt> -<dt>seed_signal_connect_value, <a class="indexterm" href="seed-Signals.html#seed-signal-connect-value">seed_signal_connect_value ()</a> +<dt>seed_signal_connect_value, <a class="indexterm" href="seed-Signals.html#seed-signal-connect-value">seed_signal_connect_value ()</a> </dt> -<dt>seed_simple_evaluate, <a class="indexterm" href="seed-Evaluation.html#seed-simple-evaluate">seed_simple_evaluate ()</a> +<dt>seed_simple_evaluate, <a class="indexterm" href="seed-Evaluation.html#seed-simple-evaluate">seed_simple_evaluate ()</a> </dt> <dt>SeedString, <a class="indexterm" href="seed-Native-Type-Conversion.html#SeedString">SeedString</a> </dt> -<dt>seed_string_get_maximum_size, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-get-maximum-size">seed_string_get_maximum_size ()</a> +<dt>seed_string_get_maximum_size, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-get-maximum-size">seed_string_get_maximum_size ()</a> </dt> -<dt>seed_string_is_equal, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-is-equal">seed_string_is_equal ()</a> +<dt>seed_string_is_equal, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-is-equal">seed_string_is_equal ()</a> </dt> -<dt>seed_string_is_equal_utf8, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-is-equal-utf8">seed_string_is_equal_utf8 ()</a> +<dt>seed_string_is_equal_utf8, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-is-equal-utf8">seed_string_is_equal_utf8 ()</a> </dt> -<dt>seed_string_ref, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-ref">seed_string_ref ()</a> +<dt>seed_string_ref, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-ref">seed_string_ref ()</a> </dt> -<dt>seed_string_to_utf8_buffer, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer">seed_string_to_utf8_buffer ()</a> +<dt>seed_string_to_utf8_buffer, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer">seed_string_to_utf8_buffer ()</a> </dt> -<dt>seed_string_unref, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-unref">seed_string_unref ()</a> +<dt>seed_string_unref, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-string-unref">seed_string_unref ()</a> </dt> </dl> </div> @@ -250,92 +250,91 @@ <dl> <dt>SeedValue, <a class="indexterm" href="seed-Native-Type-Conversion.html#SeedValue">SeedValue</a> </dt> -<dt>seed_value_from_binary_string, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-binary-string">seed_value_from_binary_string ()</a> +<dt>seed_value_from_binary_string, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-binary-string">seed_value_from_binary_string ()</a> </dt> -<dt>seed_value_from_boolean, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-boolean">seed_value_from_boolean ()</a> +<dt>seed_value_from_boolean, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-boolean">seed_value_from_boolean ()</a> </dt> -<dt>seed_value_from_char, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-char">seed_value_from_char ()</a> +<dt>seed_value_from_char, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-char">seed_value_from_char ()</a> </dt> -<dt>seed_value_from_double, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-double">seed_value_from_double ()</a> +<dt>seed_value_from_double, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-double">seed_value_from_double ()</a> </dt> -<dt>seed_value_from_filename, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-filename">seed_value_from_filename ()</a> +<dt>seed_value_from_filename, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-filename">seed_value_from_filename ()</a> </dt> -<dt>seed_value_from_float, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-float">seed_value_from_float ()</a> +<dt>seed_value_from_float, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-float">seed_value_from_float ()</a> </dt> -<dt>seed_value_from_int, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-int">seed_value_from_int ()</a> +<dt>seed_value_from_int, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-int">seed_value_from_int ()</a> </dt> -<dt>seed_value_from_int64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-int64">seed_value_from_int64 ()</a> +<dt>seed_value_from_int64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-int64">seed_value_from_int64 ()</a> </dt> -<dt>seed_value_from_long, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-long">seed_value_from_long ()</a> +<dt>seed_value_from_long, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-long">seed_value_from_long ()</a> </dt> -<dt>seed_value_from_object, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-object">seed_value_from_object ()</a> +<dt>seed_value_from_object, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-object">seed_value_from_object ()</a> </dt> -<dt>seed_value_from_string, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-string">seed_value_from_string ()</a> +<dt>seed_value_from_string, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-string">seed_value_from_string ()</a> </dt> -<dt>seed_value_from_uchar, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-uchar">seed_value_from_uchar ()</a> +<dt>seed_value_from_uchar, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-uchar">seed_value_from_uchar ()</a> </dt> -<dt>seed_value_from_uint, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-uint">seed_value_from_uint ()</a> +<dt>seed_value_from_uint, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-uint">seed_value_from_uint ()</a> </dt> -<dt>seed_value_from_uint64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-uint64">seed_value_from_uint64 ()</a> +<dt>seed_value_from_uint64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-uint64">seed_value_from_uint64 ()</a> </dt> -<dt>seed_value_from_ulong, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-ulong">seed_value_from_ulong ()</a> +<dt>seed_value_from_ulong, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-from-ulong">seed_value_from_ulong ()</a> </dt> -<dt>seed_value_get_type, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-get-type">seed_value_get_type ()</a> +<dt>seed_value_get_type, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-get-type">seed_value_get_type ()</a> </dt> -<dt>seed_value_is_function, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-function">seed_value_is_function ()</a> +<dt>seed_value_is_function, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-function">seed_value_is_function ()</a> </dt> -<dt>seed_value_is_null, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-null">seed_value_is_null ()</a> +<dt>seed_value_is_null, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-null">seed_value_is_null ()</a> </dt> -<dt>seed_value_is_number, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-number">seed_value_is_number ()</a> +<dt>seed_value_is_number, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-number">seed_value_is_number ()</a> </dt> -<dt>seed_value_is_object, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-object">seed_value_is_object ()</a> +<dt>seed_value_is_object, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-object">seed_value_is_object ()</a> </dt> -<dt>seed_value_is_object_of_class, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-object-of-class">seed_value_is_object_of_class ()</a> +<dt>seed_value_is_object_of_class, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-object-of-class">seed_value_is_object_of_class ()</a> </dt> -<dt>seed_value_is_string, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-string">seed_value_is_string ()</a> +<dt>seed_value_is_string, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-string">seed_value_is_string ()</a> </dt> -<dt>seed_value_is_undefined, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-undefined">seed_value_is_undefined ()</a> +<dt>seed_value_is_undefined, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-is-undefined">seed_value_is_undefined ()</a> </dt> -<dt>seed_value_protect, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-protect">seed_value_protect ()</a> +<dt>seed_value_protect, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-protect">seed_value_protect ()</a> </dt> -<dt>seed_value_to_boolean, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-boolean">seed_value_to_boolean ()</a> +<dt>seed_value_to_boolean, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-boolean">seed_value_to_boolean ()</a> </dt> -<dt>seed_value_to_char, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-char">seed_value_to_char ()</a> +<dt>seed_value_to_char, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-char">seed_value_to_char ()</a> </dt> -<dt>seed_value_to_double, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-double">seed_value_to_double ()</a> +<dt>seed_value_to_double, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-double">seed_value_to_double ()</a> </dt> -<dt>seed_value_to_filename, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-filename">seed_value_to_filename ()</a> +<dt>seed_value_to_filename, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-filename">seed_value_to_filename ()</a> </dt> -<dt>seed_value_to_float, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-float">seed_value_to_float ()</a> +<dt>seed_value_to_float, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-float">seed_value_to_float ()</a> </dt> -<dt>seed_value_to_format, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-format">seed_value_to_format ()</a> +<dt>seed_value_to_format, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-format">seed_value_to_format ()</a> </dt> -<dt>seed_value_to_int, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-int">seed_value_to_int ()</a> +<dt>seed_value_to_int, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-int">seed_value_to_int ()</a> </dt> -<dt>seed_value_to_int64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-int64">seed_value_to_int64 ()</a> +<dt>seed_value_to_int64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-int64">seed_value_to_int64 ()</a> </dt> -<dt>seed_value_to_long, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-long">seed_value_to_long ()</a> +<dt>seed_value_to_long, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-long">seed_value_to_long ()</a> </dt> -<dt>seed_value_to_object, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-object">seed_value_to_object ()</a> +<dt>seed_value_to_object, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-object">seed_value_to_object ()</a> </dt> -<dt>seed_value_to_string, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-string">seed_value_to_string ()</a> +<dt>seed_value_to_string, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-string">seed_value_to_string ()</a> </dt> -<dt>seed_value_to_uchar, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-uchar">seed_value_to_uchar ()</a> +<dt>seed_value_to_uchar, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-uchar">seed_value_to_uchar ()</a> </dt> -<dt>seed_value_to_uint, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-uint">seed_value_to_uint ()</a> +<dt>seed_value_to_uint, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-uint">seed_value_to_uint ()</a> </dt> -<dt>seed_value_to_uint64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-uint64">seed_value_to_uint64 ()</a> +<dt>seed_value_to_uint64, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-uint64">seed_value_to_uint64 ()</a> </dt> -<dt>seed_value_to_ulong, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-ulong">seed_value_to_ulong ()</a> +<dt>seed_value_to_ulong, <a class="indexterm" href="seed-Native-Type-Conversion.html#seed-value-to-ulong">seed_value_to_ulong ()</a> </dt> -<dt>seed_value_unprotect, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-unprotect">seed_value_unprotect ()</a> +<dt>seed_value_unprotect, <a class="indexterm" href="seed-Operating-on-Native-Types.html#seed-value-unprotect">seed_value_unprotect ()</a> </dt> </dl> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/js.html b/doc/reference/html/js.html index 96b7762..a10f505 100644 --- a/doc/reference/html/js.html +++ b/doc/reference/html/js.html @@ -2,29 +2,29 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Part II. Seed JavaScript Reference</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Part II. Seed JavaScript Reference: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="index.html" title="Seed Reference Manual"> <link rel="prev" href="seed-contact.html" title="Contact Information"> <link rel="next" href="seed-importer.html" title="Importer"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-contact.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td> </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-importer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="seed-contact.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-importer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="part"> <div class="titlepage"><div><div><h1 class="title"> <a name="js"></a>Part II. Seed JavaScript Reference</h1></div></div></div> <div class="toc"> <p><b>Table of Contents</b></p> -<dl><dt> +<dl class="toc"><dt> <span class="refentrytitle"><a href="seed-importer.html">Importer</a></span><span class="refpurpose"> — Importing gobject-introspection namespaces, native modules, and JavaScript modules </span> @@ -33,7 +33,6 @@ Importing gobject-introspection namespaces, native modules, and JavaScript modul <p>This is the documentation for the JavaScript runtime side of Seed.</p> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/left-insensitive.png b/doc/reference/html/left-insensitive.png Binary files differnew file mode 100644 index 0000000..3269393 --- /dev/null +++ b/doc/reference/html/left-insensitive.png diff --git a/doc/reference/html/left.png b/doc/reference/html/left.png Binary files differindex 48cab27..2abde03 100644 --- a/doc/reference/html/left.png +++ b/doc/reference/html/left.png diff --git a/doc/reference/html/modules.html b/doc/reference/html/modules.html index 207af0c..ecfa0de 100644 --- a/doc/reference/html/modules.html +++ b/doc/reference/html/modules.html @@ -2,29 +2,29 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Part IV. Seed Module Reference</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Part IV. Seed Module Reference: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="index.html" title="Seed Reference Manual"> <link rel="prev" href="seed-Modules.html" title="Seed Modules"> <link rel="next" href="readline-module.html" title="readline"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Modules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td> </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="readline-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="seed-Modules.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="readline-module.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="part"> <div class="titlepage"><div><div><h1 class="title"> <a name="modules"></a>Part IV. Seed Module Reference</h1></div></div></div> <div class="toc"> <p><b>Table of Contents</b></p> -<dl> +<dl class="toc"> <dt><span class="chapter"><a href="readline-module.html">readline</a></span></dt> <dt><span class="chapter"><a href="sqlite-module.html">SQLite</a></span></dt> <dt><span class="chapter"><a href="GtkBuilder-module.html">GtkBuilder</a></span></dt> @@ -34,7 +34,6 @@ <p>This is the documentation for the various modules included with Seed.</p> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/readline-module.html b/doc/reference/html/readline-module.html index 5904db2..523068d 100644 --- a/doc/reference/html/readline-module.html +++ b/doc/reference/html/readline-module.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>readline</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>readline: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="modules.html" title="Part IV. Seed Module Reference"> <link rel="prev" href="modules.html" title="Part IV. Seed Module Reference"> <link rel="next" href="sqlite-module.html" title="SQLite"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="modules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="modules.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="sqlite-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="modules.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="modules.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="sqlite-module.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div> @@ -33,7 +33,7 @@ </div></div> </div></div> <div class="refsect1"> -<a name="idp5150160"></a><h2>API Reference</h2> +<a name="id-1.5.3.3"></a><h2>API Reference</h2> <p> The readline module allows for basic usage of the GNU readline library, in Seed. More advanced features may be added a a later time. In order to use the readline module it must be first imported. </p> @@ -47,8 +47,11 @@ <div class="refsect2"> <a name="readline-readline"></a><h3>readline.readline (prompt)</h3> <p>Prompts for one line of input on standard input using <em class="parameter"><code>prompt</code></em> as the prompt.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>prompt</code></em></span></p></td> @@ -67,8 +70,11 @@ <div class="refsect2"> <a name="readline-bind"></a><h3>readline.bind (key, function)</h3> <p>Binds <em class="parameter"><code>key</code></em> to <em class="parameter"><code>function</code></em> causing the function to be invokved whenever <em class="parameter"><code>key</code></em> is pressed</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>key</code></em></span></p></td> @@ -94,8 +100,11 @@ <div class="refsect2"> <a name="readline-buffer"></a><h3>readline.buffer()</h3> <p>Retrieve the current readline buffer</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span></span></p></td> <td>The current readline buffer</td> @@ -108,8 +117,11 @@ <div class="refsect2"> <a name="readline-insert"></a><h3>readline.insert (string)</h3> <p>Inserts <em class="parameter"><code>string</code></em> in to the current readline buffer</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>string</code></em></span></p></td> <td>undefined</td> @@ -120,7 +132,7 @@ </p> </div> <div class="refsect1"> -<a name="idp9655744"></a><h2>Examples</h2> +<a name="id-1.5.3.4"></a><h2>Examples</h2> <p>Below are several examples of using the Seed readline module. For additional resources, consult the examples/ folder of the Seed source</p> <div class="example"> <a name="readline-repl-example"></a><p class="title"><b>Example 14. </b></p> @@ -143,7 +155,6 @@ while (1){ </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/right-insensitive.png b/doc/reference/html/right-insensitive.png Binary files differnew file mode 100644 index 0000000..4c95785 --- /dev/null +++ b/doc/reference/html/right-insensitive.png diff --git a/doc/reference/html/right.png b/doc/reference/html/right.png Binary files differindex ed55207..76260ec 100644 --- a/doc/reference/html/right.png +++ b/doc/reference/html/right.png diff --git a/doc/reference/html/seed-Contexts.html b/doc/reference/html/seed-Contexts.html index 23a608e..22ab830 100644 --- a/doc/reference/html/seed-Contexts.html +++ b/doc/reference/html/seed-Contexts.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Working with Contexts</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Working with Contexts: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-Initialization.html" title="Initialization"> <link rel="next" href="seed-Evaluation.html" title="Evaluating JavaScript"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Initialization.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-Evaluation.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-Contexts.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Contexts.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-Contexts.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-Initialization.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Evaluation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Contexts"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,210 +29,351 @@ <h2><span class="refentrytitle"><a name="seed-Contexts.top_of_page"></a>Working with Contexts</span></h2> <p>Working with Contexts — Self-contained JavaScript execution environments</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-Contexts.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -typedef <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext">SeedContext</a>; -typedef <a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext">SeedGlobalContext</a>; -typedef <a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup">SeedContextGroup</a>; -<a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> <a class="link" href="seed-Contexts.html#seed-context-create" title="seed_context_create ()">seed_context_create</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> group</code></em>, - <em class="parameter"><code><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> global_class</code></em>); -<a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> <a class="link" href="seed-Contexts.html#seed-context-ref" title="seed_context_ref ()">seed_context_ref</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Contexts.html#seed-context-unref" title="seed_context_unref ()">seed_context_unref</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Contexts.html#seed-context-collect" title="seed_context_collect ()">seed_context_collect</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>); -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-Contexts.html#seed-context-get-global-object" title="seed_context_get_global_object ()">seed_context_get_global_object</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Contexts.html#seed-prepare-global-context" title="seed_prepare_global_context ()">seed_prepare_global_context</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Contexts.html#seed-importer-add-global" title="seed_importer_add_global ()">seed_importer_add_global</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><span class="type">gchar</span> *name</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Contexts.html#seed-importer-set-search-path" title="seed_importer_set_search_path ()">seed_importer_set_search_path</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><span class="type">gchar</span> **search_path</code></em>); +<div class="refsect1"> +<a name="seed-Contexts.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-context-create" title="seed_context_create ()">seed_context_create</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-context-ref" title="seed_context_ref ()">seed_context_ref</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-context-unref" title="seed_context_unref ()">seed_context_unref</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-context-collect" title="seed_context_collect ()">seed_context_collect</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-Contexts.html#seed-context-get-global-object" title="seed_context_get_global_object ()">seed_context_get_global_object</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-prepare-global-context" title="seed_prepare_global_context ()">seed_prepare_global_context</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-importer-add-global" title="seed_importer_add_global ()">seed_importer_add_global</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Contexts.html#seed-importer-set-search-path" title="seed_importer_set_search_path ()">seed_importer_set_search_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Contexts.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext">SeedContext</a></td> +</tr> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext">SeedGlobalContext</a></td> +</tr> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup">SeedContextGroup</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Contexts.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> <a name="seed-Contexts.description"></a><h2>Description</h2> <p> -A <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> provides a complete "universe" for the execution of JavaScript. You can use <a class="link" href="seed-Contexts.html#seed-context-create" title="seed_context_create ()"><code class="function">seed_context_create()</code></a> to create a sandboxed context that lacks the import system, so it can be used to execute somewhat untrusted JavaScript (as it has no way to access the rest of your system). You can also expose the default set of globals (including "print", "imports", and "Seed") to create more powerful but still self-contained environments within which to execute code. +A <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> provides a complete "universe" for the execution of JavaScript. You can use <a class="link" href="seed-Contexts.html#seed-context-create" title="seed_context_create ()"><code class="function">seed_context_create()</code></a> to create a sandboxed context that lacks the import system, so it can be used to execute somewhat untrusted JavaScript (as it has no way to access the rest of your system). You can also expose the default set of globals (including "print", "imports", and "Seed") to create more powerful but still self-contained environments within which to execute code. </p> <div class="example"> -<a name="idp6331760"></a><p class="title"><b>Example 6. Using a Seed context as a form of sandboxing</b></p> -<div class="example-contents"><pre class="programlisting"> -... -ctx = seed_context_create(NULL, NULL); -script = seed_make_script(ctx, "print(imports)", NULL, 0); -// nothing is printed, because imports is undefined, because we're in a sandbox -... -</pre></div> +<a name="id-1.4.4.6.3"></a><p class="title"><b>Example 6. Using a Seed context as a form of sandboxing</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="symbol">...</span> +<span class="normal">ctx </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Contexts.html#seed-context-create">seed_context_create</a></span><span class="symbol">(</span><span class="normal"><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span> +<span class="normal">script </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Evaluation.html#seed-make-script">seed_make_script</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"print(imports)"</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span> +<span class="comment">// nothing is printed, because imports is undefined, because we're in a sandbox</span> +<span class="symbol">...</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"><p>The sandbox module provides access to this system from the JavaScript side of Seed. </p> </div> <div class="refsect1"> -<a name="seed-Contexts.details"></a><h2>Details</h2> +<a name="seed-Contexts.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="SeedContext"></a><h3>SeedContext</h3> -<pre class="programlisting">typedef gpointer SeedContext; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="SeedGlobalContext"></a><h3>SeedGlobalContext</h3> -<pre class="programlisting">typedef gpointer SeedGlobalContext; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="SeedContextGroup"></a><h3>SeedContextGroup</h3> -<pre class="programlisting">typedef gpointer SeedContextGroup; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="seed-context-create"></a><h3>seed_context_create ()</h3> -<pre class="programlisting"><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> seed_context_create (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> group</code></em>, - <em class="parameter"><code><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> global_class</code></em>);</pre> -<p> -Create a new <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>. By default, this creates a new context +<a name="seed-context-create"></a><h3>seed_context_create ()</h3> +<pre class="programlisting"><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> +seed_context_create (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> group</code></em>, + <em class="parameter"><code><a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> global_class</code></em>);</pre> +<p>Create a new <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>. By default, this creates a new context which has no global objects; you can add the default set using -<a class="link" href="seed-Contexts.html#seed-prepare-global-context" title="seed_prepare_global_context ()"><code class="function">seed_prepare_global_context()</code></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a class="link" href="seed-Contexts.html#seed-prepare-global-context" title="seed_prepare_global_context ()"><code class="function">seed_prepare_global_context()</code></a>.</p> +<div class="refsect3"> +<a name="id-1.4.4.7.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> in which to create the new context, or <code class="literal">NULL</code> to -create it in the default context group.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>global_class</code></em> :</span></p></td> -<td>The <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> to use to create the global object, or <code class="literal">NULL</code> to -create it with the default class.</td> +<td class="parameter_name"><p>group</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> in which to create the new context, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to +create it in the default context group.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A new <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>.</td> +<td class="parameter_name"><p>global_class</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a> to use to create the global object, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to +create it with the default class.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.7.2.6"></a><h4>Returns</h4> +<p> A new <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-context-ref"></a><h3>seed_context_ref ()</h3> -<pre class="programlisting"><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> seed_context_ref (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>);</pre> -<p> -Increments the reference count of <em class="parameter"><code>ctx</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td><em class="parameter"><code>ctx</code></em></td> -</tr> -</tbody> +<a name="seed-context-ref"></a><h3>seed_context_ref ()</h3> +<pre class="programlisting"><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="returnvalue">SeedGlobalContext</span></a> +seed_context_ref (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>);</pre> +<p>Increments the reference count of <em class="parameter"><code>ctx</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.4.7.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.7.3.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>ctx</code></em> +</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-context-unref"></a><h3>seed_context_unref ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_context_unref (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>);</pre> -<p> -Decrements the reference count of <em class="parameter"><code>ctx</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-context-unref"></a><h3>seed_context_unref ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_context_unref (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>);</pre> +<p>Decrements the reference count of <em class="parameter"><code>ctx</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.4.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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></tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-context-collect"></a><h3>seed_context_collect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_context_collect (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>);</pre> -<p> -Instructs JavaScriptCore to make a garbage collection pass. +<a name="seed-context-collect"></a><h3>seed_context_collect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_context_collect (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedGlobalContext" title="SeedGlobalContext"><span class="type">SeedGlobalContext</span></a> ctx</code></em>);</pre> +<p>Instructs JavaScriptCore to make a garbage collection pass. The context parameter is currently unused, and a pass is made -through all contexts. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +through all contexts.</p> +<div class="refsect3"> +<a name="id-1.4.4.7.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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></tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-context-get-global-object"></a><h3>seed_context_get_global_object ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_context_get_global_object (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The global object for <em class="parameter"><code>ctx</code></em>.</td> -</tr> -</tbody> +<a name="seed-context-get-global-object"></a><h3>seed_context_get_global_object ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_context_get_global_object (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.4.7.6.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.4.7.6.5"></a><h4>Returns</h4> +<p> The global object for <em class="parameter"><code>ctx</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-prepare-global-context"></a><h3>seed_prepare_global_context ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_prepare_global_context (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> -<p> -Adds the default set of global objects (imports, GType, Seed, and print) -to a fresh <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-prepare-global-context"></a><h3>seed_prepare_global_context ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_prepare_global_context (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> +<p>Adds the default set of global objects (imports, GType, Seed, and print) +to a fresh <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.4.7.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> on which to add the default set of global objects.</td> +<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> on which to add the default set of global objects.</p></td> +<td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-importer-add-global"></a><h3>seed_importer_add_global ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_importer_add_global (<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><span class="type">gchar</span> *name</code></em>);</pre> +<a name="seed-importer-add-global"></a><h3>seed_importer_add_global ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_importer_add_global (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-importer-set-search-path"></a><h3>seed_importer_set_search_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_importer_set_search_path (<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><span class="type">gchar</span> **search_path</code></em>);</pre> +<a name="seed-importer-set-search-path"></a><h3>seed_importer_set_search_path ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_importer_set_search_path (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **search_path</code></em>);</pre> <p> </p> </div> </div> +<div class="refsect1"> +<a name="seed-Contexts.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SeedContext"></a><h3>SeedContext</h3> +<pre class="programlisting">typedef gpointer SeedContext; +</pre> +<p> +</p> </div> -<div class="footer"> <hr> - Generated by GTK-Doc V1.18</div> +<div class="refsect2"> +<a name="SeedGlobalContext"></a><h3>SeedGlobalContext</h3> +<pre class="programlisting">typedef gpointer SeedGlobalContext; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="SeedContextGroup"></a><h3>SeedContextGroup</h3> +<pre class="programlisting">typedef gpointer SeedContextGroup; +</pre> +<p> +</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Evaluation.html b/doc/reference/html/seed-Evaluation.html index 345d00f..9e2c4af 100644 --- a/doc/reference/html/seed-Evaluation.html +++ b/doc/reference/html/seed-Evaluation.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Evaluating JavaScript</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Evaluating JavaScript: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-Contexts.html" title="Working with Contexts"> <link rel="next" href="seed-Exceptions.html" title="Exception Handling"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Contexts.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-Exceptions.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-Evaluation.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Evaluation.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-Evaluation.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-Contexts.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Exceptions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Evaluation"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,241 +29,378 @@ <h2><span class="refentrytitle"><a name="seed-Evaluation.top_of_page"></a>Evaluating JavaScript</span></h2> <p>Evaluating JavaScript — Creating and interpreting scripts</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-Evaluation.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - - <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a>; -<a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()">seed_make_script</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>const <span class="type">gchar</span> *js</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *source_url</code></em>, - <em class="parameter"><code><span class="type">gint</span> line_number</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Evaluation.html#seed-evaluate" title="seed_evaluate ()">seed_evaluate</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-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Evaluation.html#seed-simple-evaluate" title="seed_simple_evaluate ()">seed_simple_evaluate</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><span class="type">gchar</span> *source</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * <a class="link" href="seed-Evaluation.html#seed-script-new-from-file" title="seed_script_new_from_file ()">seed_script_new_from_file</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><span class="type">gchar</span> *file</code></em>); -<a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="returnvalue">SeedException</span></a> <a class="link" href="seed-Evaluation.html#seed-script-exception" title="seed_script_exception ()">seed_script_exception</a> (<em class="parameter"><code><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Evaluation.html#seed-script-destroy" title="seed_script_destroy ()">seed_script_destroy</a> (<em class="parameter"><code><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>); +<div class="refsect1"> +<a name="seed-Evaluation.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()">seed_make_script</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Evaluation.html#seed-evaluate" title="seed_evaluate ()">seed_evaluate</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Evaluation.html#seed-simple-evaluate" title="seed_simple_evaluate ()">seed_simple_evaluate</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Evaluation.html#seed-script-new-from-file" title="seed_script_new_from_file ()">seed_script_new_from_file</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="returnvalue">SeedException</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Evaluation.html#seed-script-exception" title="seed_script_exception ()">seed_script_exception</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Evaluation.html#seed-script-destroy" title="seed_script_destroy ()">seed_script_destroy</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Evaluation.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Evaluation.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> <a name="seed-Evaluation.description"></a><h2>Description</h2> <p> -Seed relies on WebKit's JavaScriptCore interpreter to actually evaluate snippets of JavaScript; however, it provides a handful of useful wrapper functions to quickly create and evaluate scripts. <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a> and <a class="link" href="seed-Evaluation.html#seed-evaluate" title="seed_evaluate ()"><code class="function">seed_evaluate()</code></a> are the workhorse functions; these allow you to control every detail of the created script and its evaluation environment (including customizing the "this" object during evaluation, and setting a starting line number and filename from which the script originates). <a class="link" href="seed-Evaluation.html#seed-simple-evaluate" title="seed_simple_evaluate ()"><code class="function">seed_simple_evaluate()</code></a> provides an interface to execute a string of JavaScript without previously creating a <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>, and, while requiring less supporting code, is less flexible. +Seed relies on WebKit's JavaScriptCore interpreter to actually evaluate snippets of JavaScript; however, it provides a handful of useful wrapper functions to quickly create and evaluate scripts. <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a> and <a class="link" href="seed-Evaluation.html#seed-evaluate" title="seed_evaluate ()"><code class="function">seed_evaluate()</code></a> are the workhorse functions; these allow you to control every detail of the created script and its evaluation environment (including customizing the "this" object during evaluation, and setting a starting line number and filename from which the script originates). <a class="link" href="seed-Evaluation.html#seed-simple-evaluate" title="seed_simple_evaluate ()"><code class="function">seed_simple_evaluate()</code></a> provides an interface to execute a string of JavaScript without previously creating a <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>, and, while requiring less supporting code, is less flexible. </p> <div class="example"> -<a name="idp8392992"></a><p class="title"><b>Example 7. Create and evaluate a string of JavaScript with <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a></b></p> -<div class="example-contents"><pre class="programlisting"> -SeedEngine * eng; - -... - -SeedScript * script; -/* Create a simple <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> */ -script = seed_make_script(eng->context, "print('Hello, world!')", NULL, 0); - -/* Evaluate the <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> in the default context */ -seed_evaluate(eng->context, script, 0); - -... -</pre></div> +<a name="id-1.4.5.6.3"></a><p class="title"><b>Example 7. Create and evaluate a string of JavaScript with <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a></b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="seed-Initialization.html#SeedEngine">SeedEngine</a> </span><span class="symbol">*</span><span class="normal"> eng</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="symbol">...</span> +<span class="normal"> </span> +<span class="normal"><a href="seed-Evaluation.html#SeedScript">SeedScript</a> </span><span class="symbol">*</span><span class="normal"> script</span><span class="symbol">;</span> +<span class="comment">/* Create a simple <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> */</span> +<span class="normal">script </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Evaluation.html#seed-make-script">seed_make_script</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"print('Hello, world!')"</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="comment">/* Evaluate the <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> in the default context */</span> +<span class="function"><a href="seed-Evaluation.html#seed-evaluate">seed_evaluate</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> script</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="symbol">...</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"><div class="example"> -<a name="idp8397072"></a><p class="title"><b>Example 8. Create and evaluate a string of JavaScript with <a class="link" href="seed-Evaluation.html#seed-simple-evaluate" title="seed_simple_evaluate ()"><code class="function">seed_simple_evaluate()</code></a></b></p> -<div class="example-contents"><pre class="programlisting"> -SeedEngine * eng; - -... - -/* Evaluate a simple JavaScript snippet in the default context */ -seed_simple_evaluate(eng->context, "print('Hello, world!')", NULL); - -... -</pre></div> +<a name="id-1.4.5.6.4"></a><p class="title"><b>Example 8. Create and evaluate a string of JavaScript with <a class="link" href="seed-Evaluation.html#seed-simple-evaluate" title="seed_simple_evaluate ()"><code class="function">seed_simple_evaluate()</code></a></b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="seed-Initialization.html#SeedEngine">SeedEngine</a> </span><span class="symbol">*</span><span class="normal"> eng</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="symbol">...</span> +<span class="normal"> </span> +<span class="comment">/* Evaluate a simple JavaScript snippet in the default context */</span> +<span class="function"><a href="seed-Evaluation.html#seed-simple-evaluate">seed_simple_evaluate</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"print('Hello, world!')"</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="symbol">...</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"> </div> <div class="refsect1"> -<a name="seed-Evaluation.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="SeedScript"></a><h3>SeedScript</h3> -<pre class="programlisting">typedef struct { - JSStringRef script; - JSValueRef exception; - - JSStringRef source_url; - gint line_number; -} SeedScript; -</pre> -<p> -</p> -</div> -<hr> +<a name="seed-Evaluation.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="seed-make-script"></a><h3>seed_make_script ()</h3> -<pre class="programlisting"><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * seed_make_script (<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>const <span class="type">gchar</span> *js</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *source_url</code></em>, - <em class="parameter"><code><span class="type">gint</span> line_number</code></em>);</pre> -<p> -Creates a new <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> instance with <em class="parameter"><code>js</code></em> as the contents, then -checks for proper syntax. -</p> -<p> -Note: <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a> does not handle the shebang line, and will return a - parse error if one is included in <em class="parameter"><code>js</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-make-script"></a><h3>seed_make_script ()</h3> +<pre class="programlisting"><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * +seed_make_script (<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>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *js</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_url</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line_number</code></em>);</pre> +<p>Creates a new <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> instance with <em class="parameter"><code>js</code></em> + as the contents, then +checks for proper syntax.</p> +<p>Note: <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a> does not handle the shebang line, and will return a + parse error if one is included in <em class="parameter"><code>js</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.5.7.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>js</code></em> :</span></p></td> -<td>A string representing the contents of the script.</td> +<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><p><span class="term"><em class="parameter"><code>source_url</code></em> :</span></p></td> -<td>The filename of the script, for reference in errors, or <code class="literal">NULL</code>.</td> +<td class="parameter_name"><p>js</p></td> +<td class="parameter_description"><p>A string representing the contents of the script.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>line_number</code></em> :</span></p></td> -<td>The line number of the beginning of the script, for reference -in error messages, or <code class="literal">NULL</code>.</td> +<td class="parameter_name"><p>source_url</p></td> +<td class="parameter_description"><p>The filename of the script, for reference in errors, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The newly created <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>.</td> +<td class="parameter_name"><p>line_number</p></td> +<td class="parameter_description"><p>The line number of the beginning of the script, for reference +in error messages, or 0.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.5.7.2.7"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-evaluate"></a><h3>seed_evaluate ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_evaluate (<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-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>);</pre> -<p> -Evaluates a <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> with <em class="parameter"><code>this</code></em> as the global "this" object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-evaluate"></a><h3>seed_evaluate ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_evaluate (<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-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>);</pre> +<p>Evaluates a <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> with <em class="parameter"><code>this</code></em> + as the global "this" object.</p> +<div class="refsect3"> +<a name="id-1.4.5.7.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> to evaluate.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> returned by evaluating the script.</td> +<td class="parameter_name"><p>s</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> to evaluate.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.5.7.3.6"></a><h4>Returns</h4> +<p> The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> returned by evaluating the script.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-simple-evaluate"></a><h3>seed_simple_evaluate ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_simple_evaluate (<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><span class="type">gchar</span> *source</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Evaluates a string of JavaScript in <em class="parameter"><code>ctx</code></em>; if an exception -is raised in the context of the script, it will be placed in <em class="parameter"><code>exception</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-simple-evaluate"></a><h3>seed_simple_evaluate ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_simple_evaluate (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Evaluates a string of JavaScript in <em class="parameter"><code>ctx</code></em> +; if an exception +is raised in the context of the script, it will be placed in <em class="parameter"><code>exception</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.5.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td> -<td>A string representing the JavaScript to evaluate.</td> +<td class="parameter_name"><p>source</p></td> +<td class="parameter_description"><p>A string representing the JavaScript to evaluate.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> pointer to store an exception in.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> returned by evaluating the script.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> pointer to store an exception in.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.5.7.4.6"></a><h4>Returns</h4> +<p> The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> returned by evaluating the script.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-script-new-from-file"></a><h3>seed_script_new_from_file ()</h3> -<pre class="programlisting"><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * seed_script_new_from_file (<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><span class="type">gchar</span> *file</code></em>);</pre> -<p> -Uses <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a> to create a <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> from the contents of <em class="parameter"><code>file</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-script-new-from-file"></a><h3>seed_script_new_from_file ()</h3> +<pre class="programlisting"><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="returnvalue">SeedScript</span></a> * +seed_script_new_from_file (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>);</pre> +<p>Uses <a class="link" href="seed-Evaluation.html#seed-make-script" title="seed_make_script ()"><code class="function">seed_make_script()</code></a> to create a <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> from the contents of <em class="parameter"><code>file</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.5.7.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>file</code></em> :</span></p></td> -<td>The filename of the script to load.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The newly created <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>.</td> +<td class="parameter_name"><p>file</p></td> +<td class="parameter_description"><p>The filename of the script to load.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.5.7.5.6"></a><h4>Returns</h4> +<p> The newly created <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-script-exception"></a><h3>seed_script_exception ()</h3> -<pre class="programlisting"><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="returnvalue">SeedException</span></a> seed_script_exception (<em class="parameter"><code><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>);</pre> -<p> -Retrieves the exception (if any) raised during the evaluation of <em class="parameter"><code>s</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>.</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> representing the exception of <em class="parameter"><code>s</code></em>.</td> -</tr> -</tbody> +<a name="seed-script-exception"></a><h3>seed_script_exception ()</h3> +<pre class="programlisting"><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="returnvalue">SeedException</span></a> +seed_script_exception (<em class="parameter"><code><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>);</pre> +<p>Retrieves the exception (if any) raised during the evaluation of <em class="parameter"><code>s</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.5.7.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>s</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.5.7.6.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> representing the exception of <em class="parameter"><code>s</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-script-destroy"></a><h3>seed_script_destroy ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_script_destroy (<em class="parameter"><code><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>);</pre> +<a name="seed-script-destroy"></a><h3>seed_script_destroy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_script_destroy (<em class="parameter"><code><a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript"><span class="type">SeedScript</span></a> *s</code></em>);</pre> +<p> +</p> +</div> +</div> +<div class="refsect1"> +<a name="seed-Evaluation.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SeedScript"></a><h3>SeedScript</h3> +<pre class="programlisting">typedef struct { + JSStringRef script; + JSValueRef exception; + + JSStringRef source_url; + gint line_number; +} SeedScript; +</pre> <p> </p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Exceptions.html b/doc/reference/html/seed-Exceptions.html index ede41e4..b6bebcc 100644 --- a/doc/reference/html/seed-Exceptions.html +++ b/doc/reference/html/seed-Exceptions.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Exception Handling</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Exception Handling: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-Evaluation.html" title="Evaluating JavaScript"> <link rel="next" href="seed-Signals.html" title="GObject Signals"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Evaluation.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-Signals.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-Exceptions.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Exceptions.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-Exceptions.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-Evaluation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Signals.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Exceptions"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,77 +29,157 @@ <h2><span class="refentrytitle"><a name="seed-Exceptions.top_of_page"></a>Exception Handling</span></h2> <p>Exception Handling — Throwing and catching exceptions</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-Exceptions.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -typedef <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException">SeedException</a>; -<span class="returnvalue">void</span> <a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()">seed_make_exception</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, - <em class="parameter"><code>...</code></em>); -<span class="returnvalue">gchar</span> * <a class="link" href="seed-Exceptions.html#seed-exception-get-name" title="seed_exception_get_name ()">seed_exception_get_name</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>); -<span class="returnvalue">gchar</span> * <a class="link" href="seed-Exceptions.html#seed-exception-get-message" title="seed_exception_get_message ()">seed_exception_get_message</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>); -<span class="returnvalue">guint</span> <a class="link" href="seed-Exceptions.html#seed-exception-get-line" title="seed_exception_get_line ()">seed_exception_get_line</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>); -<span class="returnvalue">gchar</span> * <a class="link" href="seed-Exceptions.html#seed-exception-get-file" title="seed_exception_get_file ()">seed_exception_get_file</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>); -<span class="returnvalue">gchar</span> * <a class="link" href="seed-Exceptions.html#seed-exception-to-string" title="seed_exception_to_string ()">seed_exception_to_string</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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>); +<div class="refsect1"> +<a name="seed-Exceptions.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()">seed_make_exception</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Exceptions.html#seed-exception-get-name" title="seed_exception_get_name ()">seed_exception_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Exceptions.html#seed-exception-get-message" title="seed_exception_get_message ()">seed_exception_get_message</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Exceptions.html#seed-exception-get-line" title="seed_exception_get_line ()">seed_exception_get_line</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Exceptions.html#seed-exception-get-file" title="seed_exception_get_file ()">seed_exception_get_file</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Exceptions.html#seed-exception-to-string" title="seed_exception_to_string ()">seed_exception_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Exceptions.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException">SeedException</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Exceptions.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> <a name="seed-Exceptions.description"></a><h2>Description</h2> <p> -Seed uses exceptions as a method of handling runtime errors within scripts. An exception consists of a name (a list of commonly-used exception names is below), a message, detailing the error, and the line number and filename from which the exception was raised. If Seed cannot determine from where the exception was raised, the line number and filename will be undefined. <a class="link" href="seed-Exceptions.html#seed-exception-to-string" title="seed_exception_to_string ()"><code class="function">seed_exception_to_string()</code></a> provides a simple way to convert all of these into a consistent representation to display to users. +Seed uses exceptions as a method of handling runtime errors within scripts. An exception consists of a name (a list of commonly-used exception names is below), a message, detailing the error, and the line number and filename from which the exception was raised. If Seed cannot determine from where the exception was raised, the line number and filename will be undefined. <a class="link" href="seed-Exceptions.html#seed-exception-to-string" title="seed_exception_to_string ()"><code class="function">seed_exception_to_string()</code></a> provides a simple way to convert all of these into a consistent representation to display to users. </p> <p> All Seed callbacks take an exception argument; calling -<a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()"><code class="function">seed_make_exception()</code></a> with this argument and the details you wish to +<a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()"><code class="function">seed_make_exception()</code></a> with this argument and the details you wish to fill it with will propogate that exception up the chain. Exceptions can be <span class="emphasis"><em>caught</em></span> either by a try/catch block in the calling JavaScript, or by observing the exception property, dealing with it, and then clearing the exception. -It is important to note that calling <a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()"><code class="function">seed_make_exception()</code></a> does not +It is important to note that calling <a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()"><code class="function">seed_make_exception()</code></a> does not in fact <span class="emphasis"><em>throw</em></span> the exception, but just creates an object which, when stored in the exception pointer passed to a callback, causes JSC to throw an exception once flow is returned. </p> <div class="example"> -<a name="idp8068800"></a><p class="title"><b>Example 9. Throw an exception, because <code class="function">random_callback</code> was called with the wrong number of arguments</b></p> -<div class="example-contents"><pre class="programlisting"> -SeedValue random_callback(SeedContext ctx, - SeedObject function, - SeedObject this_object, - gsize argument_count, - const SeedValue arguments[], - SeedException *exception) -{ - ... - - if(argument_count != 1) - { - seed_make_exception(ctx, exception, "ArgumentError", - "wrong number of arguments; expected 1, got %Zd", - argument_count); - return seed_make_undefined(ctx); - } - - ... -} -</pre></div> +<a name="id-1.4.6.6.4"></a><p class="title"><b>Example 9. Throw an exception, because <code class="function">random_callback</code> was called with the wrong number of arguments</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="usertype">SeedValue</span><span class="normal"> </span><span class="function">random_callback</span><span class="symbol">(</span><span class="usertype">SeedContext</span><span class="normal"> ctx</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">SeedObject</span><span class="normal"> function</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">SeedObject</span><span class="normal"> this_object</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">gsize</span><span class="normal"> argument_count</span><span class="symbol">,</span> +<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">SeedValue</span><span class="normal"> arguments</span><span class="symbol">[],</span> +<span class="normal"> </span><span class="usertype">SeedException</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">exception</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> </span><span class="symbol">...</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="keyword">if</span><span class="symbol">(</span><span class="normal">argument_count </span><span class="symbol">!=</span><span class="normal"> </span><span class="number">1</span><span class="symbol">)</span> +<span class="normal"> </span><span class="cbracket">{</span> +<span class="normal"> </span><span class="function"><a href="seed-Exceptions.html#seed-make-exception">seed_make_exception</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> exception</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"ArgumentError"</span><span class="symbol">,</span> +<span class="normal"> </span><span class="string">"wrong number of arguments; expected 1, got %zd"</span><span class="symbol">,</span> +<span class="normal"> argument_count</span><span class="symbol">);</span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="seed-Native-Type-Conversion.html#seed-make-undefined">seed_make_undefined</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">);</span> +<span class="normal"> </span><span class="cbracket">}</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="symbol">...</span> +<span class="cbracket">}</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> -<br class="example-break"><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> +<br class="example-break"><div class="note"> <h3 class="title">Predefined Exception Names</h3> <p> </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"> <span class="emphasis"><em>InvalidPropertyValue</em></span> - a property was set to a value out of range</li> <li class="listitem"> @@ -126,197 +202,250 @@ SeedValue random_callback(SeedContext ctx, </div> </div> <div class="refsect1"> -<a name="seed-Exceptions.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="SeedException"></a><h3>SeedException</h3> -<pre class="programlisting">typedef gpointer SeedException; -</pre> -<p> -</p> -</div> -<hr> +<a name="seed-Exceptions.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="seed-make-exception"></a><h3>seed_make_exception ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_make_exception (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p> -Creates a new JavaScript exception with the given attributes. -</p> -<p> -The line number and file name of the exception created will be undefined. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-make-exception"></a><h3>seed_make_exception ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_make_exception (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p>Creates a new JavaScript exception with the given attributes.</p> +<p>The line number and file name of the exception created will be undefined.</p> +<div class="refsect3"> +<a name="id-1.4.6.7.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> in which to store the exception.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> in which to store the exception.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The <span class="type">gchar</span>* representing the exception name.</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* representing the exception name.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>The <span class="type">gchar</span>*, as a printf format string, representing the -details of the exception.</td> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*, as a printf format string, representing the +details of the exception.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-exception-get-name"></a><h3>seed_exception_get_name ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * seed_exception_get_name (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> -<p> -Retrieves the name of the given exception; this could be one of the +<a name="seed-exception-get-name"></a><h3>seed_exception_get_name ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +seed_exception_get_name (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> +<p>Retrieves the name of the given exception; this could be one of the predefined exception names given above, or your own name, which should -be a single CamelCase word, preferably ending in something like "Error". -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +be a single CamelCase word, preferably ending in something like "Error".</p> +<div class="refsect3"> +<a name="id-1.4.6.7.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gchar</span>* representing the name of <em class="parameter"><code>exception</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.6.7.3.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* representing the name of <em class="parameter"><code>exception</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-exception-get-message"></a><h3>seed_exception_get_message ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * seed_exception_get_message (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> -<p> -Retrieves the message of the given exception; this should be a +<a name="seed-exception-get-message"></a><h3>seed_exception_get_message ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +seed_exception_get_message (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> +<p>Retrieves the message of the given exception; this should be a human-readable string describing the exception enough that a developer could utilize the message in order to determine where to look to debug -the problem. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +the problem.</p> +<div class="refsect3"> +<a name="id-1.4.6.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gchar</span>* representing the detailed message of <em class="parameter"><code>exception</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.6.7.4.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* representing the detailed message of <em class="parameter"><code>exception</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-exception-get-line"></a><h3>seed_exception_get_line ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> seed_exception_get_line (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> -<p> -Retrieves the line number the given exception was thrown from; keep in mind -that exceptions created from C have an undefined line number. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-exception-get-line"></a><h3>seed_exception_get_line ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +seed_exception_get_line (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> +<p>Retrieves the line number the given exception was thrown from; keep in mind +that exceptions created from C have an undefined line number.</p> +<div class="refsect3"> +<a name="id-1.4.6.7.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">guint</span> representing the line number from which <em class="parameter"><code>exception</code></em> -was thrown.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.6.7.5.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> representing the line number from which <em class="parameter"><code>exception</code></em> +was thrown.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-exception-get-file"></a><h3>seed_exception_get_file ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * seed_exception_get_file (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> -<p> -Retrieves the file name the given exception was thrown from; keep in mind -that exceptions created from C have an undefined file name. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-exception-get-file"></a><h3>seed_exception_get_file ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +seed_exception_get_file (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> +<p>Retrieves the file name the given exception was thrown from; keep in mind +that exceptions created from C have an undefined file name.</p> +<div class="refsect3"> +<a name="id-1.4.6.7.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gchar</span>* representing the name of the file from which -<em class="parameter"><code>exception</code></em> was thrown.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.6.7.6.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* representing the name of the file from which +<em class="parameter"><code>exception</code></em> +was thrown.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-exception-to-string"></a><h3>seed_exception_to_string ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * seed_exception_to_string (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> -<p> -Properly formats the name, detailed message, line number, and file name of +<a name="seed-exception-to-string"></a><h3>seed_exception_to_string ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +seed_exception_to_string (<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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> +<p>Properly formats the name, detailed message, line number, and file name of the given extension. This provides a consistent format for printed exceptions, to reduce confusion. Please use it if you're exposing exception -data to the outside world. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +data to the outside world.</p> +<div class="refsect3"> +<a name="id-1.4.6.7.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gchar</span>* representing the <em class="parameter"><code>exception</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.6.7.7.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* representing the <em class="parameter"><code>exception</code></em> +.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="seed-Exceptions.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SeedException"></a><h3>SeedException</h3> +<pre class="programlisting">typedef gpointer SeedException; +</pre> +<p> +</p> +</div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Initialization.html b/doc/reference/html/seed-Initialization.html index 7ea9a15..fd30e6a 100644 --- a/doc/reference/html/seed-Initialization.html +++ b/doc/reference/html/seed-Initialization.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Initialization</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Initialization: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="api.html" title="Part III. Seed API Reference"> <link rel="next" href="seed-Contexts.html" title="Working with Contexts"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="api.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-Contexts.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-Initialization.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Initialization.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-Initialization.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="api.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Contexts.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Initialization"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,183 +29,279 @@ <h2><span class="refentrytitle"><a name="seed-Initialization.top_of_page"></a>Initialization</span></h2> <p>Initialization — Overall setup of the Seed engine</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-Initialization.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -struct <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine">SeedEngine</a>; -<a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * <a class="link" href="seed-Initialization.html#seed-init" title="seed_init ()">seed_init</a> (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>, - <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>); -<a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * <a class="link" href="seed-Initialization.html#seed-init-with-context-group" title="seed_init_with_context_group ()">seed_init_with_context_group</a> (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>, - <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>, - <em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> group</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Initialization.html#seed-engine-set-search-path" title="seed_engine_set_search_path ()">seed_engine_set_search_path</a> (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>); -<span class="returnvalue">gchar</span> ** <a class="link" href="seed-Initialization.html#seed-engine-get-search-path" title="seed_engine_get_search_path ()">seed_engine_get_search_path</a> (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>); +<div class="refsect1"> +<a name="seed-Initialization.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Initialization.html#seed-init" title="seed_init ()">seed_init</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Initialization.html#seed-init-with-context-group" title="seed_init_with_context_group ()">seed_init_with_context_group</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Initialization.html#seed-engine-set-search-path" title="seed_engine_set_search_path ()">seed_engine_set_search_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** +</td> +<td class="function_name"> +<a class="link" href="seed-Initialization.html#seed-engine-get-search-path" title="seed_engine_get_search_path ()">seed_engine_get_search_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Initialization.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine">SeedEngine</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Initialization.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> <a name="seed-Initialization.description"></a><h2>Description</h2> <p> -Before any other Seed functions can be used, you must initialize the engine, which creates an initial JavaScript context and sets up JavaScriptCore and GLib. To do this in most cases, you will use <a class="link" href="seed-Initialization.html#seed-init" title="seed_init ()"><code class="function">seed_init()</code></a>, which will provide you with a <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>. Only one <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> is permitted per application; use a <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> to sandbox code execution. +Before any other Seed functions can be used, you must initialize the engine, which creates an initial JavaScript context and sets up JavaScriptCore and GLib. To do this in most cases, you will use <a class="link" href="seed-Initialization.html#seed-init" title="seed_init ()"><code class="function">seed_init()</code></a>, which will provide you with a <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>. Only one <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> is permitted per application; use a <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> to sandbox code execution. </p> <div class="example"> -<a name="idm10656"></a><p class="title"><b>Example 5. Very simple <code class="function">main</code> function for a Seed program</b></p> -<div class="example-contents"><pre class="programlisting"> -int main (int argc, char **argv) -{ - SeedEngine * eng; - SeedScript * script; - - /* Initialize the Seed engine */ - eng = seed_init(&argc, &argv); - - /* Create a simple <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> */ - script = seed_make_script(eng->context, "print('Hello, world!')", NULL, 0); - - /* Evaluate the <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> in the default context */ - seed_evaluate(eng->context, script, 0); - - g_free(script); - return 0; -} -</pre></div> +<a name="id-1.4.3.6.3"></a><p class="title"><b>Example 5. Very simple <code class="function">main</code> function for a Seed program</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="type">int</span><span class="normal"> </span><span class="function">main</span><span class="normal"> </span><span class="symbol">(</span><span class="type">int</span><span class="normal"> argc</span><span class="symbol">,</span><span class="normal"> </span><span class="type">char</span><span class="normal"> </span><span class="symbol">**</span><span class="normal">argv</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> <a href="seed-Initialization.html#SeedEngine">SeedEngine</a> </span><span class="symbol">*</span><span class="normal"> eng</span><span class="symbol">;</span> +<span class="normal"> <a href="seed-Evaluation.html#SeedScript">SeedScript</a> </span><span class="symbol">*</span><span class="normal"> script</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Initialize the Seed engine */</span> +<span class="normal"> eng </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Initialization.html#seed-init">seed_init</a></span><span class="symbol">(&</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">argv</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Create a simple <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> */</span> +<span class="normal"> script </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Evaluation.html#seed-make-script">seed_make_script</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"print('Hello, world!')"</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Evaluate the <a class="link" href="seed-Evaluation.html#SeedScript" title="SeedScript">SeedScript</a> in the default context */</span> +<span class="normal"> </span><span class="function"><a href="seed-Evaluation.html#seed-evaluate">seed_evaluate</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> script</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free">g_free</a></span><span class="symbol">(</span><span class="normal">script</span><span class="symbol">);</span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="number">0</span><span class="symbol">;</span> +<span class="cbracket">}</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"> </div> <div class="refsect1"> -<a name="seed-Initialization.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="SeedEngine"></a><h3>struct SeedEngine</h3> -<pre class="programlisting">struct SeedEngine { - JSGlobalContextRef context; - JSObjectRef global; - gchar **search_path; - - JSContextGroupRef group; -}; -</pre> -<p> -</p> -</div> -<hr> +<a name="seed-Initialization.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="seed-init"></a><h3>seed_init ()</h3> -<pre class="programlisting"><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * seed_init (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>, - <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>);</pre> -<p> -Initializes a new <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>. This involves initializing GLib, creating +<a name="seed-init"></a><h3>seed_init ()</h3> +<pre class="programlisting"><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * +seed_init (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);</pre> +<p>Initializes a new <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>. This involves initializing GLib, creating an initial context with all of the default globals, and initializing -various internal parts of Seed. -</p> -<p> -This function should only be called once within a single Seed application. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +various internal parts of Seed.</p> +<p>This function should only be called once within a single Seed application.</p> +<div class="refsect3"> +<a name="id-1.4.3.7.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td> -<td>A reference to the number of arguments remaining to parse.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td> -<td>A reference to an array of string arguments remaining to parse.</td> +<td class="parameter_name"><p>argc</p></td> +<td class="parameter_description"><p>A reference to the number of arguments remaining to parse.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The newly created and initialized <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>.</td> +<td class="parameter_name"><p>argv</p></td> +<td class="parameter_description"><p>A reference to an array of string arguments remaining to parse.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.3.7.2.7"></a><h4>Returns</h4> +<p> The newly created and initialized <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-init-with-context-group"></a><h3>seed_init_with_context_group ()</h3> -<pre class="programlisting"><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * seed_init_with_context_group (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>, - <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>, - <em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> group</code></em>);</pre> -<p> -Initializes a new <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>. This involves initializing GLib, creating +<a name="seed-init-with-context-group"></a><h3>seed_init_with_context_group ()</h3> +<pre class="programlisting"><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="returnvalue">SeedEngine</span></a> * +seed_init_with_context_group (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>, + <em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> group</code></em>);</pre> +<p>Initializes a new <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>. This involves initializing GLib, creating an initial context (in <span class="type">group</span>) with all of the default globals, and -initializing various internal parts of Seed. -</p> -<p> -This function should only be called once within a single Seed application. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +initializing various internal parts of Seed.</p> +<p>This function should only be called once within a single Seed application.</p> +<div class="refsect3"> +<a name="id-1.4.3.7.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td> -<td>A reference to the number of arguments remaining to parse.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td> -<td>A reference to an array of string arguments remaining to parse.</td> +<td class="parameter_name"><p>argc</p></td> +<td class="parameter_description"><p>A reference to the number of arguments remaining to parse.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> within which to create the initial context.</td> +<td class="parameter_name"><p>argv</p></td> +<td class="parameter_description"><p>A reference to an array of string arguments remaining to parse.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The newly created and initialized <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>.</td> +<td class="parameter_name"><p>group</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Contexts.html#SeedContextGroup" title="SeedContextGroup"><span class="type">SeedContextGroup</span></a> within which to create the initial context.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.3.7.3.7"></a><h4>Returns</h4> +<p> The newly created and initialized <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-engine-set-search-path"></a><h3>seed_engine_set_search_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_engine_set_search_path (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre> -<p> -Sets the search path for the imports system. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-engine-set-search-path"></a><h3>seed_engine_set_search_path ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_engine_set_search_path (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre> +<p>Sets the search path for the imports system.</p> +<div class="refsect3"> +<a name="id-1.4.3.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>eng</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, on which to set the path.</td> +<td class="parameter_name"><p>eng</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, on which to set the path.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> -<td>A <span class="type">const</span> gchar*, a colon separated string containing the path to set</td> +<td class="parameter_name"><p>path</p></td> +<td class="parameter_description"><p>A <span class="type">const</span> gchar*, a colon separated string containing the path to set</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-engine-get-search-path"></a><h3>seed_engine_get_search_path ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> ** seed_engine_get_search_path (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>);</pre> +<a name="seed-engine-get-search-path"></a><h3>seed_engine_get_search_path ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** +seed_engine_get_search_path (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>);</pre> +<p>Retrieves the search path for the imports system. The returned value is +owned by the <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, and shouldn't be freed by the application writer.</p> +<div class="refsect3"> +<a name="id-1.4.3.7.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>eng</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, to get the currently set search path.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.3.7.5.6"></a><h4>Returns</h4> +<p> A null-terminated array of strings containing the paths.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="seed-Initialization.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SeedEngine"></a><h3>struct SeedEngine</h3> +<pre class="programlisting">struct SeedEngine { + JSGlobalContextRef context; + JSObjectRef global; + gchar **search_path; + + JSContextGroupRef group; +}; +</pre> <p> -Retrieves the search path for the imports system. The returned value is -owned by the <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, and shouldn't be freed by the application writer. </p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>eng</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, to get the currently set search path.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A null-terminated array of strings containing the paths.</td> -</tr> -</tbody> -</table></div> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-JS-Objects.html b/doc/reference/html/seed-JS-Objects.html index 9da2aa0..0361ae3 100644 --- a/doc/reference/html/seed-JS-Objects.html +++ b/doc/reference/html/seed-JS-Objects.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Working with JavaScript objects</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Working with JavaScript objects: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="types.html" title="Values and Type Conversion"> <link rel="prev" href="seed-Operating-on-Native-Types.html" title="Operating on JavaScript types"> <link rel="next" href="seed-Native-Functions.html" title="Creating native functions"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Operating-on-Native-Types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="types.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-Native-Functions.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-JS-Objects.synopsis" class="shortcut">Top</a> - | - <a href="#seed-JS-Objects.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-JS-Objects.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="types.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="seed-Operating-on-Native-Types.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Native-Functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-JS-Objects"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,94 +29,219 @@ <h2><span class="refentrytitle"><a name="seed-JS-Objects.top_of_page"></a>Working with JavaScript objects</span></h2> <p>Working with JavaScript objects — Using properties, constructing objects, etc.</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-JS-Objects.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -typedef <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject">SeedObject</a>; -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-JS-Objects.html#seed-make-object" title="seed_make_object ()">seed_make_object</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><span class="type">gpointer</span> private_object</code></em>); -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-JS-Objects.html#seed-make-array" title="seed_make_array ()">seed_make_array</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>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> elements</code></em>, - <em class="parameter"><code><span class="type">gsize</span> num_elements</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-JS-Objects.html#seed-object-call" title="seed_object_call ()">seed_object_call</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-JS-Objects.html#seed-object-set-property-at-index" title="seed_object_set_property_at_index ()">seed_object_set_property_at_index</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><span class="type">gint</span> index</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-JS-Objects.html#seed-object-get-property-at-index" title="seed_object_get_property_at_index ()">seed_object_get_property_at_index</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><span class="type">gint</span> index</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-JS-Objects.html#seed-object-is-of-class" title="seed_object_is_of_class ()">seed_object_is_of_class</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</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>); -<span class="returnvalue">gpointer</span> <a class="link" href="seed-JS-Objects.html#seed-object-get-private" title="seed_object_get_private ()">seed_object_get_private</a> (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-JS-Objects.html#seed-object-set-private" title="seed_object_set_private ()">seed_object_set_private</a> (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> value</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-JS-Objects.html#seed-object-get-property" title="seed_object_get_property ()">seed_object_get_property</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-JS-Objects.html#seed-object-set-property" title="seed_object_set_property ()">seed_object_set_property</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-JS-Objects.html#seed-object-get-prototype" title="seed_object_get_prototype ()">seed_object_get_prototype</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</code></em>); -<span class="returnvalue">gchar</span> ** <a class="link" href="seed-JS-Objects.html#seed-object-copy-property-names" title="seed_object_copy_property_names ()">seed_object_copy_property_names</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>); -<span class="returnvalue">void</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectInitializeCallback" title="SeedObjectInitializeCallback ()">*SeedObjectInitializeCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>); -<span class="returnvalue">void</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectFinalizeCallback" title="SeedObjectFinalizeCallback ()">*SeedObjectFinalizeCallback</a>) (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>); -<span class="returnvalue">gboolean</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectHasPropertyCallback" title="SeedObjectHasPropertyCallback ()">*SeedObjectHasPropertyCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (<a class="link" href="seed-JS-Objects.html#SeedObjectGetPropertyCallback" title="SeedObjectGetPropertyCallback ()">*SeedObjectGetPropertyCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>); -<span class="returnvalue">gboolean</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectSetPropertyCallback" title="SeedObjectSetPropertyCallback ()">*SeedObjectSetPropertyCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>); -<span class="returnvalue">gboolean</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectDeletePropertyCallback" title="SeedObjectDeletePropertyCallback ()">*SeedObjectDeletePropertyCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>); -<span class="returnvalue">void</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectGetPropertyNamesCallback" title="SeedObjectGetPropertyNamesCallback ()">*SeedObjectGetPropertyNamesCallback</a>) - (<em class="parameter"><code><span class="type">void</span></code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (<a class="link" href="seed-JS-Objects.html#SeedObjectCallAsFunctionCallback" title="SeedObjectCallAsFunctionCallback ()">*SeedObjectCallAsFunctionCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gboolean</span> (<a class="link" href="seed-JS-Objects.html#SeedObjectHasInstanceCallback" title="SeedObjectHasInstanceCallback ()">*SeedObjectHasInstanceCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> constructor</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> instance_p</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (<a class="link" href="seed-JS-Objects.html#SeedObjectConvertToTypeCallback" title="SeedObjectConvertToTypeCallback ()">*SeedObjectConvertToTypeCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="type">SeedType</span></a> type</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (<a class="link" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback" title="SeedObjectCallAsConstructorCallback ()">*SeedObjectCallAsConstructorCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> constructor</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); +<div class="refsect1"> +<a name="seed-JS-Objects.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-make-object" title="seed_make_object ()">seed_make_object</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-JS-Objects.html#seed-make-array" title="seed_make_array ()">seed_make_array</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-call" title="seed_object_call ()">seed_object_call</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-set-property-at-index" title="seed_object_set_property_at_index ()">seed_object_set_property_at_index</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-get-property-at-index" title="seed_object_get_property_at_index ()">seed_object_get_property_at_index</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-is-of-class" title="seed_object_is_of_class ()">seed_object_is_of_class</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-get-private" title="seed_object_get_private ()">seed_object_get_private</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-set-private" title="seed_object_set_private ()">seed_object_set_private</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-get-property" title="seed_object_get_property ()">seed_object_get_property</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-set-property" title="seed_object_set_property ()">seed_object_set_property</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-JS-Objects.html#seed-object-get-prototype" title="seed_object_get_prototype ()">seed_object_get_prototype</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** +</td> +<td class="function_name"> +<a class="link" href="seed-JS-Objects.html#seed-object-copy-property-names" title="seed_object_copy_property_names ()">seed_object_copy_property_names</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectInitializeCallback" title="SeedObjectInitializeCallback ()">*SeedObjectInitializeCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectFinalizeCallback" title="SeedObjectFinalizeCallback ()">*SeedObjectFinalizeCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectHasPropertyCallback" title="SeedObjectHasPropertyCallback ()">*SeedObjectHasPropertyCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectGetPropertyCallback" title="SeedObjectGetPropertyCallback ()">*SeedObjectGetPropertyCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectSetPropertyCallback" title="SeedObjectSetPropertyCallback ()">*SeedObjectSetPropertyCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectDeletePropertyCallback" title="SeedObjectDeletePropertyCallback ()">*SeedObjectDeletePropertyCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectGetPropertyNamesCallback" title="SeedObjectGetPropertyNamesCallback ()">*SeedObjectGetPropertyNamesCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectCallAsFunctionCallback" title="SeedObjectCallAsFunctionCallback ()">*SeedObjectCallAsFunctionCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectHasInstanceCallback" title="SeedObjectHasInstanceCallback ()">*SeedObjectHasInstanceCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectConvertToTypeCallback" title="SeedObjectConvertToTypeCallback ()">*SeedObjectConvertToTypeCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback" title="SeedObjectCallAsConstructorCallback ()">*SeedObjectCallAsConstructorCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-JS-Objects.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject">SeedObject</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-JS-Objects.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -130,446 +251,561 @@ Long description </p> </div> <div class="refsect1"> -<a name="seed-JS-Objects.details"></a><h2>Details</h2> +<a name="seed-JS-Objects.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="SeedObject"></a><h3>SeedObject</h3> -<pre class="programlisting">typedef gpointer SeedObject; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="seed-make-object"></a><h3>seed_make_object ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_make_object (<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><span class="type">gpointer</span> private_object</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> in which to create the new object.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A new <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>.</td> -</tr> -</tbody> +<a name="seed-make-object"></a><h3>seed_make_object ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_make_object (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> private_object</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.4.7.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>The <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> in which to create the new object.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.2.5"></a><h4>Returns</h4> +<p> A new <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-make-array"></a><h3>seed_make_array ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_make_array (<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>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> elements</code></em>, - <em class="parameter"><code><span class="type">gsize</span> num_elements</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Creates a JavaScript Array object from <em class="parameter"><code>elements</code></em>, a C-style array of -SeedValues. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-make-array"></a><h3>seed_make_array ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_make_array (<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>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> elements</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> num_elements</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Creates a JavaScript Array object from <em class="parameter"><code>elements</code></em> +, a C-style array of +SeedValues.</p> +<div class="refsect3"> +<a name="id-1.4.8.4.7.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <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>elements</code></em> :</span></p></td> -<td>An array of <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>'s with which to populate the array.</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>num_elements</code></em> :</span></p></td> -<td>The number of values, in <em class="parameter"><code>elements</code></em> -</td> +<td class="parameter_name"><p>elements</p></td> +<td class="parameter_description"><p>An array of <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>'s with which to populate the array.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> in which to store an exception. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>num_elements</p></td> +<td class="parameter_description"><p>The number of values, in <em class="parameter"><code>elements</code></em> +</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A new array object, populated with <em class="parameter"><code>elements</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> in which to store an exception. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.3.6"></a><h4>Returns</h4> +<p> A new array object, populated with <em class="parameter"><code>elements</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-call"></a><h3>seed_object_call ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_object_call (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Calls <em class="parameter"><code>object</code></em> as a function. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-call"></a><h3>seed_object_call ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_object_call (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> argument_count</code></em>, + <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Calls <em class="parameter"><code>object</code></em> + as a function.</p> +<div class="refsect3"> +<a name="id-1.4.8.4.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>object</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> to call.</td> +<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><p><span class="term"><em class="parameter"><code>argument_count</code></em> :</span></p></td> -<td>The number of arguments in the <em class="parameter"><code>arguments</code></em> array.</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> to call.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>arguments</code></em> :</span></p></td> -<td>An array (<em class="parameter"><code>argument_count</code></em> long) of <a href="seed-Native-Type-Conversion.html#SeedValue"><span class="type">SeedValues</span></a> to pass in as the -function's arguments.</td> +<td class="parameter_name"><p>argument_count</p></td> +<td class="parameter_description"><p>The number of arguments in the <em class="parameter"><code>arguments</code></em> +array.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>arguments</p></td> +<td class="parameter_description"><p>An array (<em class="parameter"><code>argument_count</code></em> +long) of <a href="seed-Native-Type-Conversion.html#SeedValue"><span class="type">SeedValues</span></a> to pass in as the +function's arguments.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <em class="parameter"><code>SeedValue</code></em> returned by the called function, or <code class="literal">NULL</code> if an -exception occurs or the object is not a function.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.4.6"></a><h4>Returns</h4> +<p> The <em class="parameter"><code>SeedValue</code></em> +returned by the called function, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an +exception occurs or the object is not a function.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-set-property-at-index"></a><h3>seed_object_set_property_at_index ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_object_set_property_at_index (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><span class="type">gint</span> index</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Sets the property <em class="parameter"><code>index</code></em> on <em class="parameter"><code>object</code></em> to <em class="parameter"><code>value</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-set-property-at-index"></a><h3>seed_object_set_property_at_index ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_object_set_property_at_index (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Sets the property <em class="parameter"><code>index</code></em> + on <em class="parameter"><code>object</code></em> + to <em class="parameter"><code>value</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.8.4.7.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> on which to set the property.</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> on which to set the property.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> -<td>The index of the property to set.</td> +<td class="parameter_name"><p>index</p></td> +<td class="parameter_description"><p>The index of the property to set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to use as the property's value.</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to use as the property's value.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-get-property-at-index"></a><h3>seed_object_get_property_at_index ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_object_get_property_at_index (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><span class="type">gint</span> index</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="seed-object-get-property-at-index"></a><h3>seed_object_get_property_at_index ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_object_get_property_at_index (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-object-is-of-class"></a><h3>seed_object_is_of_class ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_object_is_of_class (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</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>);</pre> +<a name="seed-object-is-of-class"></a><h3>seed_object_is_of_class ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_object_is_of_class (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</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>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-object-get-private"></a><h3>seed_object_get_private ()</h3> -<pre class="programlisting"><span class="returnvalue">gpointer</span> seed_object_get_private (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> -<p> -Retrieves the private data of <em class="parameter"><code>object</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A pointer to the private data of <em class="parameter"><code>object</code></em>.</td> -</tr> -</tbody> +<a name="seed-object-get-private"></a><h3>seed_object_get_private ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> +seed_object_get_private (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> +<p>Retrieves the private data of <em class="parameter"><code>object</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.8.4.7.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>object</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.8.6"></a><h4>Returns</h4> +<p> A pointer to the private data of <em class="parameter"><code>object</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-set-private"></a><h3>seed_object_set_private ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_object_set_private (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> value</code></em>);</pre> -<p> -Sets the private data of <em class="parameter"><code>object</code></em> to <em class="parameter"><code>value</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-set-private"></a><h3>seed_object_set_private ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_object_set_private (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> value</code></em>);</pre> +<p>Sets the private data of <em class="parameter"><code>object</code></em> + to <em class="parameter"><code>value</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.8.4.7.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>.</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>A <span class="type">gpointer</span> to set the private data of <em class="parameter"><code>object</code></em> to.</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> to set the private data of <em class="parameter"><code>object</code></em> +to.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-get-property"></a><h3>seed_object_get_property ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_object_get_property (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-get-property"></a><h3>seed_object_get_property ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_object_get_property (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.4.7.10.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> -</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The property to get, should be a valid JavaScript identifier</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The value of the property or the undefined value</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The property to get, should be a valid JavaScript identifier</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.10.5"></a><h4>Returns</h4> +<p> The value of the property or the undefined value</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-set-property"></a><h3>seed_object_set_property ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_object_set_property (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-set-property"></a><h3>seed_object_set_property ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_object_set_property (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.4.7.11.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> -</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The property to set, should be a valid JavaScript identifier</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The property to set, should be a valid JavaScript identifier</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>The value to set the property to.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The value to set the property to.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.11.5"></a><h4>Returns</h4> +<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-get-prototype"></a><h3>seed_object_get_prototype ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_object_get_prototype (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-get-prototype"></a><h3>seed_object_get_prototype ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_object_get_prototype (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.4.7.12.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The prototype of <em class="parameter"><code>obj</code></em>.</td> +<td class="parameter_name"><p>obj</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.12.5"></a><h4>Returns</h4> +<p> The prototype of <em class="parameter"><code>obj</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-object-copy-property-names"></a><h3>seed_object_copy_property_names ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> ** seed_object_copy_property_names (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-object-copy-property-names"></a><h3>seed_object_copy_property_names ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** +seed_object_copy_property_names (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.4.7.13.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>An object from which to copy property names.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <code class="literal">NULL</code> terminated array containing the property names of <em class="parameter"><code>object</code></em> -</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>An object from which to copy property names.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.4.7.13.5"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array containing the property names of +<em class="parameter"><code>object</code></em> +</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="SeedObjectInitializeCallback"></a><h3>SeedObjectInitializeCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> (*SeedObjectInitializeCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> +<a name="SeedObjectInitializeCallback"></a><h3>SeedObjectInitializeCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*SeedObjectInitializeCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectFinalizeCallback"></a><h3>SeedObjectFinalizeCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> (*SeedObjectFinalizeCallback) (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> +<a name="SeedObjectFinalizeCallback"></a><h3>SeedObjectFinalizeCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*SeedObjectFinalizeCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectHasPropertyCallback"></a><h3>SeedObjectHasPropertyCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> (*SeedObjectHasPropertyCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> +<a name="SeedObjectHasPropertyCallback"></a><h3>SeedObjectHasPropertyCallback ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="c_punctuation">(</span>*SeedObjectHasPropertyCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectGetPropertyCallback"></a><h3>SeedObjectGetPropertyCallback ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (*SeedObjectGetPropertyCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>);</pre> +<a name="SeedObjectGetPropertyCallback"></a><h3>SeedObjectGetPropertyCallback ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +<span class="c_punctuation">(</span>*SeedObjectGetPropertyCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectSetPropertyCallback"></a><h3>SeedObjectSetPropertyCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> (*SeedObjectSetPropertyCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>);</pre> +<a name="SeedObjectSetPropertyCallback"></a><h3>SeedObjectSetPropertyCallback ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="c_punctuation">(</span>*SeedObjectSetPropertyCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectDeletePropertyCallback"></a><h3>SeedObjectDeletePropertyCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> (*SeedObjectDeletePropertyCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>);</pre> +<a name="SeedObjectDeletePropertyCallback"></a><h3>SeedObjectDeletePropertyCallback ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="c_punctuation">(</span>*SeedObjectDeletePropertyCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> property_name</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *e</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectGetPropertyNamesCallback"></a><h3>SeedObjectGetPropertyNamesCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> (*SeedObjectGetPropertyNamesCallback) - (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<a name="SeedObjectGetPropertyNamesCallback"></a><h3>SeedObjectGetPropertyNamesCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*SeedObjectGetPropertyNamesCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectCallAsFunctionCallback"></a><h3>SeedObjectCallAsFunctionCallback ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (*SeedObjectCallAsFunctionCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="SeedObjectCallAsFunctionCallback"></a><h3>SeedObjectCallAsFunctionCallback ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +<span class="c_punctuation">(</span>*SeedObjectCallAsFunctionCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> argument_count</code></em>, + <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectHasInstanceCallback"></a><h3>SeedObjectHasInstanceCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> (*SeedObjectHasInstanceCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> constructor</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> instance_p</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="SeedObjectHasInstanceCallback"></a><h3>SeedObjectHasInstanceCallback ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="c_punctuation">(</span>*SeedObjectHasInstanceCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> constructor</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> instance_p</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectConvertToTypeCallback"></a><h3>SeedObjectConvertToTypeCallback ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (*SeedObjectConvertToTypeCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="type">SeedType</span></a> type</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="SeedObjectConvertToTypeCallback"></a><h3>SeedObjectConvertToTypeCallback ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +<span class="c_punctuation">(</span>*SeedObjectConvertToTypeCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> object</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="type">SeedType</span></a> type</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedObjectCallAsConstructorCallback"></a><h3>SeedObjectCallAsConstructorCallback ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (*SeedObjectCallAsConstructorCallback) - (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> constructor</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="SeedObjectCallAsConstructorCallback"></a><h3>SeedObjectCallAsConstructorCallback ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +<span class="c_punctuation">(</span>*SeedObjectCallAsConstructorCallback<span class="c_punctuation">)</span> + (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> constructor</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> argument_count</code></em>, + <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p> +</p> +</div> +</div> +<div class="refsect1"> +<a name="seed-JS-Objects.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SeedObject"></a><h3>SeedObject</h3> +<pre class="programlisting">typedef gpointer SeedObject; +</pre> <p> </p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-JavaScript-Classes.html b/doc/reference/html/seed-JavaScript-Classes.html index 9a92c40..2669f78 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.78.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.24 (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 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 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="id-1.4.10.7.2.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.4.10.7.2.5"></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="id-1.4.10.7.3.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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="id-1.4.10.7.3.5"></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="id-1.4.10.8.2.4"></a><h4>Members</h4> +<div class="informaltable"><table 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="id-1.4.10.8.3.4"></a><h4>Members</h4> +<div class="informaltable"><table 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.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Modules.html b/doc/reference/html/seed-Modules.html index f24012b..3bf6d38 100644 --- a/doc/reference/html/seed-Modules.html +++ b/doc/reference/html/seed-Modules.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Seed Modules</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Seed Modules: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-SeedClosure.html" title="Using JavaScript closures"> <link rel="next" href="modules.html" title="Part IV. Seed Module Reference"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-SeedClosure.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="modules.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-Modules.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Modules.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-Modules.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-SeedClosure.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="modules.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Modules"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,21 +29,48 @@ <h2><span class="refentrytitle"><a name="seed-Modules.top_of_page"></a>Seed Modules</span></h2> <p>Seed Modules — Native C modules for Seed</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-Modules.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -#define <a class="link" href="seed-Modules.html#CHECK-ARG-COUNT:CAPS" title="CHECK_ARG_COUNT()">CHECK_ARG_COUNT</a> (name, - argnum) -#define <a class="link" href="seed-Modules.html#DEFINE-ENUM-MEMBER:CAPS" title="DEFINE_ENUM_MEMBER()">DEFINE_ENUM_MEMBER</a> (holder, - member) -#define <a class="link" href="seed-Modules.html#DEFINE-ENUM-MEMBER-EXT:CAPS" title="DEFINE_ENUM_MEMBER_EXT()">DEFINE_ENUM_MEMBER_EXT</a> (holder, - name, - val) -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> (<a class="link" href="seed-Modules.html#SeedModuleInitCallback" title="SeedModuleInitCallback ()">*SeedModuleInitCallback</a>) (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>); +<div class="refsect1"> +<a name="seed-Modules.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="seed-Modules.html#CHECK-ARG-COUNT:CAPS" title="CHECK_ARG_COUNT()">CHECK_ARG_COUNT</a><span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="seed-Modules.html#DEFINE-ENUM-MEMBER:CAPS" title="DEFINE_ENUM_MEMBER()">DEFINE_ENUM_MEMBER</a><span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="seed-Modules.html#DEFINE-ENUM-MEMBER-EXT:CAPS" title="DEFINE_ENUM_MEMBER_EXT()">DEFINE_ENUM_MEMBER_EXT</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"> +<span class="c_punctuation">(</span><a class="link" href="seed-Modules.html#SeedModuleInitCallback" title="SeedModuleInitCallback ()">*SeedModuleInitCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Modules.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -57,189 +80,292 @@ Seed includes a simple system for creating C modules which can be loaded and man </p> <p>Numerous binding modules are included in the Seed repository; when writing a new native module, it would be wise to look over these before beginning, as they have many tidbits of useful knowledge for writing modules.</p> <div class="example"> -<a name="idp5746544"></a><p class="title"><b>Example 11. Very simple example C module</b></p> -<div class="example-contents"><pre class="programlisting"> -#include <glib.h> -#include <seed-module.h> -SeedObject seed_module_init(SeedEngine * eng) -{ - /* Say hello! */ - g_print("Hello, Seed Module World!\n"); - - /* Return an empty object as the module's namespace */ - return seed_make_object (eng->context, NULL, NULL); -} -</pre></div> -</div> -<br class="example-break"><p>Above is a C module which does absolutely nothing useful. When a module is loaded, <code class="function">seed_module_init()</code> is called, which should have the signature of <a class="link" href="seed-Modules.html#SeedModuleInitCallback" title="SeedModuleInitCallback ()"><code class="function">SeedModuleInitCallback()</code></a>. You're passed the global <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, and the value you return is the namespace for your module. Say, for example, you place a static function on that object:</p> +<a name="id-1.4.12.5.4"></a><p class="title"><b>Example 11. Very simple example C module</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="preproc">#include</span><span class="normal"> </span><span class="string"><glib.h></span> +<span class="preproc">#include</span><span class="normal"> </span><span class="string"><seed-module.h></span> +<span class="usertype">SeedObject</span><span class="normal"> </span><span class="function">seed_module_init</span><span class="symbol">(</span><span class="normal"><a href="seed-Initialization.html#SeedEngine">SeedEngine</a> </span><span class="symbol">*</span><span class="normal"> eng</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> </span><span class="comment">/* Say hello! */</span> +<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="symbol">(</span><span class="string">"Hello, Seed Module World!</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Return an empty object as the module's namespace */</span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="seed-JS-Objects.html#seed-make-object">seed_make_object</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span> +<span class="cbracket">}</span></pre></td> + </tr> + </tbody> + </table> +</div> + +</div> +<br class="example-break"><p>Above is a C module which does absolutely nothing useful. When a module is loaded, <code class="function">seed_module_init()</code> is called, which should have the signature of <a class="link" href="seed-Modules.html#SeedModuleInitCallback" title="SeedModuleInitCallback ()"><code class="function">SeedModuleInitCallback()</code></a>. You're passed the global <a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a>, and the value you return is the namespace for your module. Say, for example, you place a static function on that object:</p> <div class="example"> -<a name="idp9516368"></a><p class="title"><b>Example 12. C module with a function</b></p> -<div class="example-contents"><pre class="programlisting"> -#include <glib.h> -#include <seed-module.h> -/* Our function, with the signature of SeedFunctionCallback(); say hello! */ -SeedValue say_hello_to(SeedContext ctx, - SeedObject function, - SeedObject this_object, - gsize argument_count, - const SeedValue arguments[], - SeedException *exception) -{ - guchar * name; - - /* Check that only one argument was passed into the function. - CHECK_ARG_COUNT() is from seed-module.h, which you might find useful. */ - CHECK_ARG_COUNT("hello.say_hello_to", 1); - - /* Convert the first argument, a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue">SeedValue</a>, to a C string */ - name = seed_value_to_string(ctx, arguments[0], exception); - - g_print("Hello, %s!\n", name); - - g_free(name); - - return seed_make_null(ctx); -} - -/* Define an array of seed_static_function */ -seed_static_function gettext_funcs[] = { - {"say_hello_to", say_hello_to, 0} -}; - -SeedObject seed_module_init(SeedEngine * eng) -{ - SeedGlobalContext ctx = eng->context; - - /* Create a new class definition with our array of static functions */ - seed_class_definition ns_class_def = seed_empty_class; - ns_class_def.static_functions = example_funcs; - - /* Create a class from the class definition we just created */ - SeedClass ns_class = seed_create_class(&ns_class_def); - - /* Instantiate the class; this instance will be the namespace we return */ - ns_ref = seed_make_object (ctx, ns_class, NULL); - seed_value_protect (ctx, ns_ref); - - return ns_ref; -} -</pre></div> +<a name="id-1.4.12.5.6"></a><p class="title"><b>Example 12. C module with a function</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="preproc">#include</span><span class="normal"> </span><span class="string"><glib.h></span> +<span class="preproc">#include</span><span class="normal"> </span><span class="string"><seed-module.h></span> +<span class="comment">/* Our function, with the signature of SeedFunctionCallback(); say hello! */</span> +<span class="usertype">SeedValue</span><span class="normal"> </span><span class="function">say_hello_to</span><span class="symbol">(</span><span class="usertype">SeedContext</span><span class="normal"> ctx</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">SeedObject</span><span class="normal"> function</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">SeedObject</span><span class="normal"> this_object</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">gsize</span><span class="normal"> argument_count</span><span class="symbol">,</span> +<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">SeedValue</span><span class="normal"> arguments</span><span class="symbol">[],</span> +<span class="normal"> </span><span class="usertype">SeedException</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">exception</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar">guchar</a> </span><span class="symbol">*</span><span class="normal"> name</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Check that only one argument was passed into the function.</span> +<span class="comment"> CHECK_ARG_COUNT() is from seed-module.h, which you might find useful. */</span> +<span class="normal"> </span><span class="function"><a href="seed-Modules.html#CHECK-ARG-COUNT:CAPS">CHECK_ARG_COUNT</a></span><span class="symbol">(</span><span class="string">"hello.say_hello_to"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Convert the first argument, a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue">SeedValue</a>, to a C string */</span> +<span class="normal"> name </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Native-Type-Conversion.html#seed-value-to-string">seed_value_to_string</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> arguments</span><span class="symbol">[</span><span class="number">0</span><span class="symbol">],</span><span class="normal"> exception</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="symbol">(</span><span class="string">"Hello, %s!</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span><span class="normal"> name</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free">g_free</a></span><span class="symbol">(</span><span class="normal">name</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="seed-Native-Type-Conversion.html#seed-make-null">seed_make_null</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">);</span> +<span class="cbracket">}</span> +<span class="normal"> </span> +<span class="comment">/* Define an array of <GTKDOCLINK HREF="seed-static-function">seed_static_function</GTKDOCLINK> */</span> +<span class="usertype">seed_static_function</span><span class="normal"> gettext_funcs</span><span class="symbol">[]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span> +<span class="normal"> </span><span class="cbracket">{</span><span class="string">"say_hello_to"</span><span class="symbol">,</span><span class="normal"> say_hello_to</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="cbracket">}</span> +<span class="cbracket">}</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="usertype">SeedObject</span><span class="normal"> </span><span class="function">seed_module_init</span><span class="symbol">(</span><span class="normal"><a href="seed-Initialization.html#SeedEngine">SeedEngine</a> </span><span class="symbol">*</span><span class="normal"> eng</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> </span><span class="usertype">SeedGlobalContext</span><span class="normal"> ctx </span><span class="symbol">=</span><span class="normal"> eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Create a new class definition with our array of static functions */</span> +<span class="normal"> </span><span class="usertype">seed_class_definition</span><span class="normal"> ns_class_def </span><span class="symbol">=</span><span class="normal"> <a href="seed-JavaScript-Classes.html#seed-empty-class">seed_empty_class</a></span><span class="symbol">;</span> +<span class="normal"> ns_class_def</span><span class="symbol">.</span><span class="normal">static_functions </span><span class="symbol">=</span><span class="normal"> example_funcs</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Create a class from the class definition we just created */</span> +<span class="normal"> </span><span class="usertype">SeedClass</span><span class="normal"> ns_class </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-JavaScript-Classes.html#seed-create-class">seed_create_class</a></span><span class="symbol">(&</span><span class="normal">ns_class_def</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Instantiate the class; this instance will be the namespace we return */</span> +<span class="normal"> ns_ref </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-JS-Objects.html#seed-make-object">seed_make_object</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> ns_class</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span> +<span class="normal"> </span><span class="function"><a href="seed-Operating-on-Native-Types.html#seed-value-protect">seed_value_protect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">,</span><span class="normal"> ns_ref</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> ns_ref</span><span class="symbol">;</span> +<span class="cbracket">}</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"><p>After building and installing this module (look in the Seed build system for examples of how to get this to work, as well as a copy of seed-module.h, which will be very useful), it will be loadable with the normal Seed import system. Assuming it's installed as libseed_hello.so:</p> <div class="example"> -<a name="idp6928144"></a><p class="title"><b>Example 13. Utilize our second example C module from JavaScript</b></p> -<div class="example-contents"><pre class="programlisting"> -hello = imports.hello; -hello.say_hello_to("Tim"); -</pre></div> +<a name="id-1.4.12.5.8"></a><p class="title"><b>Example 13. Utilize our second example C module from JavaScript</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal">hello </span><span class="symbol">=</span><span class="normal"> imports</span><span class="symbol">.</span><span class="normal">hello</span><span class="symbol">;</span> +<span class="normal">hello</span><span class="symbol">.</span><span class="function">say_hello_to</span><span class="symbol">(</span><span class="string">"Tim"</span><span class="symbol">);</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"> </div> <div class="refsect1"> -<a name="seed-Modules.details"></a><h2>Details</h2> +<a name="seed-Modules.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="CHECK-ARG-COUNT:CAPS"></a><h3>CHECK_ARG_COUNT()</h3> <pre class="programlisting">#define CHECK_ARG_COUNT(name, argnum)</pre> -<p> -Check that the required number of arguments were passed into a -<a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a>. If this is not true, raise an exception and -return <code class="literal">NULL</code>. This requires the callback to use "argument_count", -"ctx", and "exception" as the names of the various function arguments. -</p> -<p> -<em class="parameter"><code>name</code></em> should be of form "namespace.function_name" -</p> -<p> -At the moment, there is no way to specify more than one acceptable -argument count. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<p>Check that the required number of arguments were passed into a +<a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a>. If this is not true, raise an exception and +return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This requires the callback to use "argument_count", +"ctx", and "exception" as the names of the various function arguments.</p> +<p><em class="parameter"><code>name</code></em> + should be of form "namespace.function_name"</p> +<p>At the moment, there is no way to specify more than one acceptable +argument count.</p> +<div class="refsect3"> +<a name="id-1.4.12.6.2.7"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The name of the function being called from, pretty-printed</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the function being called from, pretty-printed</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>argnum</code></em> :</span></p></td> -<td>The number of arguments which should be passed into the function</td> +<td class="parameter_name"><p>argnum</p></td> +<td class="parameter_description"><p>The number of arguments which should be passed into the function</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> <a name="DEFINE-ENUM-MEMBER:CAPS"></a><h3>DEFINE_ENUM_MEMBER()</h3> <pre class="programlisting">#define DEFINE_ENUM_MEMBER(holder, member)</pre> -<p> -Defines a property on <em class="parameter"><code>holder</code></em> which is named the same as <em class="parameter"><code>member</code></em>, and -is assigned the value that <em class="parameter"><code>member</code></em> has in C. -</p> -<p> -This macro works for defining properties from constants and -#defines as well. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<p>Defines a property on <em class="parameter"><code>holder</code></em> + which is named the same as <em class="parameter"><code>member</code></em> +, and +is assigned the value that <em class="parameter"><code>member</code></em> + has in C.</p> +<p>This macro works for defining properties from constants and +#defines as well.</p> +<div class="refsect3"> +<a name="id-1.4.12.6.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>holder</code></em> :</span></p></td> -<td>The object on which to define the enum member</td> +<td class="parameter_name"><p>holder</p></td> +<td class="parameter_description"><p>The object on which to define the enum member</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>member</code></em> :</span></p></td> -<td>The enum member, as it is named in C</td> +<td class="parameter_name"><p>member</p></td> +<td class="parameter_description"><p>The enum member, as it is named in C</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> <a name="DEFINE-ENUM-MEMBER-EXT:CAPS"></a><h3>DEFINE_ENUM_MEMBER_EXT()</h3> <pre class="programlisting">#define DEFINE_ENUM_MEMBER_EXT(holder, name, val)</pre> -<p> -Defines a property on <em class="parameter"><code>holder</code></em> which is named <em class="parameter"><code>name</code></em>, and is assigned the -value that <em class="parameter"><code>member</code></em> has in C. This allows for an override of the enum +<p>Defines a property on <em class="parameter"><code>holder</code></em> + which is named <em class="parameter"><code>name</code></em> +, and is assigned the +value that <em class="parameter"><code>member</code></em> + has in C. This allows for an override of the enum member's name, most often to remove a common prefix. For example, to declare a property named VERSION_MAJOR on the namespace from mfpr's version -constant MPFR_VERSION_MAJOR: -</p> -<p> -</p> +constant MPFR_VERSION_MAJOR:</p> <pre class="programlisting"> DEFINE_ENUM_MEMBER_EXT(ns, "VERSION_MAJOR", MPFR_VERSION_MAJOR); </pre> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<div class="refsect3"> +<a name="id-1.4.12.6.4.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>holder</code></em> :</span></p></td> -<td>The object on which to define the enum member</td> +<td class="parameter_name"><p>holder</p></td> +<td class="parameter_description"><p>The object on which to define the enum member</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The enum member, as it should be named in JavaScript</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The enum member, as it should be named in JavaScript</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The enum member, as it is named in C</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The enum member, as it is named in C</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="SeedModuleInitCallback"></a><h3>SeedModuleInitCallback ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> (*SeedModuleInitCallback) (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>);</pre> +<a name="SeedModuleInitCallback"></a><h3>SeedModuleInitCallback ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +<span class="c_punctuation">(</span>*SeedModuleInitCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="seed-Initialization.html#SeedEngine" title="struct SeedEngine"><span class="type">SeedEngine</span></a> *eng</code></em>);</pre> <p> </p> </div> </div> +<div class="refsect1"> +<a name="seed-Modules.other_details"></a><h2>Types and Values</h2> +</div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Native-Functions.html b/doc/reference/html/seed-Native-Functions.html index 1a73cd0..ce14e7f 100644 --- a/doc/reference/html/seed-Native-Functions.html +++ b/doc/reference/html/seed-Native-Functions.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Creating native functions</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Creating native functions: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-JS-Objects.html" title="Working with JavaScript objects"> <link rel="next" href="seed-JavaScript-Classes.html" title="Creating JavaScript classes"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-JS-Objects.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-JavaScript-Classes.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-Native-Functions.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Native-Functions.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-Native-Functions.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-JS-Objects.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-JavaScript-Classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Native-Functions"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,26 +29,46 @@ <h2><span class="refentrytitle"><a name="seed-Native-Functions.top_of_page"></a>Creating native functions</span></h2> <p>Creating native functions — C functions as first-class JavaScript objects</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-Native-Functions.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (<a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()">*SeedFunctionCallback</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-Native-Functions.html#seed-make-function" title="seed_make_function ()">seed_make_function</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-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> func</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Native-Functions.html#seed-create-function" title="seed_create_function ()">seed_create_function</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><span class="type">gchar</span> *name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> func</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</code></em>); +<div class="refsect1"> +<a name="seed-Native-Functions.functions"></a><h2>Functions</h2> +<div class="informaltable"><table 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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()">*SeedFunctionCallback</a><span class="c_punctuation">)</span> <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-Native-Functions.html#seed-make-function" title="seed_make_function ()">seed_make_function</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Functions.html#seed-create-function" title="seed_create_function ()">seed_create_function</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Native-Functions.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -61,169 +77,243 @@ Exposing native C functions to JavaScript is one of the fundamental use cases for libseed when used in an embedding environment; if your application cannot be introspected, or you only have a small number of functions to expose, this is the simplest way to do that. </p> <p> -All native C callbacks should have the prototype of <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><code class="function">SeedFunctionCallback()</code></a>. +All native C callbacks should have the prototype of <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><code class="function">SeedFunctionCallback()</code></a>. </p> <div class="example"> -<a name="idp9574864"></a><p class="title"><b>Example 10. Simple C program which embeds Seed with one exposed function</b></p> -<div class="example-contents"><pre class="programlisting"> -#include <glib.h> -#include <seed.h> - -/* Our function, with the signature of SeedFunctionCallback(); say hello! */ -SeedValue hello_world(SeedContext ctx, - SeedObject function, - SeedObject this_object, - gsize argument_count, - const SeedValue arguments[], - SeedException *exception) -{ - g_print("Hello, World!\n"); - return seed_make_null(ctx); -} - -int main(gint argc, gchar ** argv) -{ - SeedEngine * eng; - - /* Initialize the Seed engine */ - eng = seed_init(&argc, &argv); - - /* Expose a C function to JavaScript */ - seed_create_function(eng->context, "hello_world", - (SeedFunctionCallback)hello_world, - eng->global); - - /* Call the newly created JavaScript function */ - seed_simple_evaluate(eng->context, "hello_world()", NULL); - - return 0; -} -</pre></div> +<a name="id-1.4.9.5.4"></a><p class="title"><b>Example 10. Simple C program which embeds Seed with one exposed function</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="preproc">#include</span><span class="normal"> </span><span class="string"><glib.h></span> +<span class="preproc">#include</span><span class="normal"> </span><span class="string"><seed.h></span> +<span class="normal"> </span> +<span class="comment">/* Our function, with the signature of SeedFunctionCallback(); say hello! */</span> +<span class="usertype">SeedValue</span><span class="normal"> </span><span class="function">hello_world</span><span class="symbol">(</span><span class="usertype">SeedContext</span><span class="normal"> ctx</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">SeedObject</span><span class="normal"> function</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">SeedObject</span><span class="normal"> this_object</span><span class="symbol">,</span> +<span class="normal"> </span><span class="usertype">gsize</span><span class="normal"> argument_count</span><span class="symbol">,</span> +<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">SeedValue</span><span class="normal"> arguments</span><span class="symbol">[],</span> +<span class="normal"> </span><span class="usertype">SeedException</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">exception</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="symbol">(</span><span class="string">"Hello, World!</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">);</span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="seed-Native-Type-Conversion.html#seed-make-null">seed_make_null</a></span><span class="symbol">(</span><span class="normal">ctx</span><span class="symbol">);</span> +<span class="cbracket">}</span> +<span class="normal"> </span> +<span class="type">int</span><span class="normal"> </span><span class="function">main</span><span class="symbol">(</span><span class="usertype">gint</span><span class="normal"> argc</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> </span><span class="symbol">**</span><span class="normal"> argv</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> <a href="seed-Initialization.html#SeedEngine">SeedEngine</a> </span><span class="symbol">*</span><span class="normal"> eng</span><span class="symbol">;</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Initialize the Seed engine */</span> +<span class="normal"> eng </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="seed-Initialization.html#seed-init">seed_init</a></span><span class="symbol">(&</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">argv</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Expose a C function to JavaScript */</span> +<span class="normal"> </span><span class="function"><a href="seed-Native-Functions.html#seed-create-function">seed_create_function</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"hello_world"</span><span class="symbol">,</span> +<span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="seed-Native-Functions.html#SeedFunctionCallback">SeedFunctionCallback</a></span><span class="symbol">)</span><span class="normal">hello_world</span><span class="symbol">,</span> +<span class="normal"> eng</span><span class="symbol">-></span><span class="normal">global</span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="comment">/* Call the newly created JavaScript function */</span> +<span class="normal"> </span><span class="function"><a href="seed-Evaluation.html#seed-simple-evaluate">seed_simple_evaluate</a></span><span class="symbol">(</span><span class="normal">eng</span><span class="symbol">-></span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"hello_world()"</span><span class="symbol">,</span><span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span> +<span class="normal"> </span> +<span class="normal"> </span><span class="keyword">return</span><span class="normal"> </span><span class="number">0</span><span class="symbol">;</span> +<span class="cbracket">}</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"> </div> <div class="refsect1"> -<a name="seed-Native-Functions.details"></a><h2>Details</h2> +<a name="seed-Native-Functions.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="SeedFunctionCallback"></a><h3>SeedFunctionCallback ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> (*SeedFunctionCallback) (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, - <em class="parameter"><code><span class="type">gsize</span> argument_count</code></em>, - <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -All native C function callbacks should use the prototype of -SeedFunctionCallback. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="SeedFunctionCallback"></a><h3>SeedFunctionCallback ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +<span class="c_punctuation">(</span>*SeedFunctionCallback<span class="c_punctuation">)</span> (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> this_object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> argument_count</code></em>, + <em class="parameter"><code>const <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> arguments[]</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>All native C function callbacks should use the prototype of +SeedFunctionCallback.</p> +<div class="refsect3"> +<a name="id-1.4.9.6.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>function</code></em> :</span></p></td> -<td>The <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> representing the function</td> +<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><p><span class="term"><em class="parameter"><code>this_object</code></em> :</span></p></td> -<td>The <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> representing the "this" object in the caller</td> +<td class="parameter_name"><p>function</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> representing the function</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>argument_count</code></em> :</span></p></td> -<td>The number of arguments passed into the callback</td> +<td class="parameter_name"><p>this_object</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> representing the "this" object in the caller</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>arguments</code></em> :</span></p></td> -<td>An array of <a href="seed-Native-Type-Conversion.html#SeedValue"><span class="type">SeedValues</span></a>; the value of the arguments passed in</td> +<td class="parameter_name"><p>argument_count</p></td> +<td class="parameter_description"><p>The number of arguments passed into the callback</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>; use <a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()"><code class="function">seed_make_exception()</code></a> in order -to throw a JavaScript exception from the callback.</td> +<td class="parameter_name"><p>arguments</p></td> +<td class="parameter_description"><p>An array of <a href="seed-Native-Type-Conversion.html#SeedValue"><span class="type">SeedValues</span></a>; the value of the arguments passed in</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to return to the caller</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a>; use <a class="link" href="seed-Exceptions.html#seed-make-exception" title="seed_make_exception ()"><code class="function">seed_make_exception()</code></a> in +order +to throw a JavaScript exception from the callback.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.9.6.2.6"></a><h4>Returns</h4> +<p> The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to return to the caller</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-make-function"></a><h3>seed_make_function ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_make_function (<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-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> func</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> -<p> -Creates a JavaScript object representing a first-class function; when -the function is called from JavaScript, <em class="parameter"><code>func</code></em> will be called. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-make-function"></a><h3>seed_make_function ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_make_function (<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-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> func</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre> +<p>Creates a JavaScript object representing a first-class function; when +the function is called from JavaScript, <em class="parameter"><code>func</code></em> + will be called.</p> +<div class="refsect3"> +<a name="id-1.4.9.6.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> to implement the function.</td> +<td class="parameter_name"><p>func</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> to implement the function.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The name of the function (used in exceptions).</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> representing the function</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the function (used in exceptions).</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.9.6.3.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> representing the function</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-create-function"></a><h3>seed_create_function ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_create_function (<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><span class="type">gchar</span> *name</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> func</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</code></em>);</pre> -<p> -Creates a JavaScript object representing a first-class function; when -the function is called from JavaScript, <em class="parameter"><code>func</code></em> will be called. Places -the created function as the property <em class="parameter"><code>name</code></em> on <em class="parameter"><code>obj</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-create-function"></a><h3>seed_create_function ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_create_function (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> func</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> obj</code></em>);</pre> +<p>Creates a JavaScript object representing a first-class function; when +the function is called from JavaScript, <em class="parameter"><code>func</code></em> + will be called. Places +the created function as the property <em class="parameter"><code>name</code></em> + on <em class="parameter"><code>obj</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.9.6.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The name of the function (used in exceptions).</td> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the function (used in exceptions).</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> to implement the function.</td> +<td class="parameter_name"><p>func</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a> to implement the function.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> -<td>The <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> on which to put the function.</td> +<td class="parameter_name"><p>obj</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> on which to put the function.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> </div> </div> +<div class="refsect1"> +<a name="seed-Native-Functions.other_details"></a><h2>Types and Values</h2> +</div> +</div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Native-Type-Conversion.html b/doc/reference/html/seed-Native-Type-Conversion.html index 2d3fd2c..4aee2ec 100644 --- a/doc/reference/html/seed-Native-Type-Conversion.html +++ b/doc/reference/html/seed-Native-Type-Conversion.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Type Conversion</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Type Conversion: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="types.html" title="Values and Type Conversion"> <link rel="prev" href="types.html" title="Values and Type Conversion"> <link rel="next" href="seed-Operating-on-Native-Types.html" title="Operating on JavaScript types"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="types.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-Operating-on-Native-Types.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-Native-Type-Conversion.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Native-Type-Conversion.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-Native-Type-Conversion.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="types.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="types.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Operating-on-Native-Types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Native-Type-Conversion"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,1376 +29,2002 @@ <h2><span class="refentrytitle"><a name="seed-Native-Type-Conversion.top_of_page"></a>Type Conversion</span></h2> <p>Type Conversion — Moving between JavaScript and C intrinsic types</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-Native-Type-Conversion.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -typedef <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue">SeedValue</a>; -enum <a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType">SeedType</a>; -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-make-undefined" title="seed_make_undefined ()">seed_make_undefined</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-make-null" title="seed_make_null ()">seed_make_null</a> (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-boolean" title="seed_value_to_boolean ()">seed_value_to_boolean</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-boolean" title="seed_value_from_boolean ()">seed_value_from_boolean</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><span class="type">gboolean</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">guint</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-uint" title="seed_value_to_uint ()">seed_value_to_uint</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-uint" title="seed_value_from_uint ()">seed_value_from_uint</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><span class="type">guint</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gint</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-int" title="seed_value_to_int ()">seed_value_to_int</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-int" title="seed_value_from_int ()">seed_value_from_int</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><span class="type">gint</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gchar</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-char" title="seed_value_to_char ()">seed_value_to_char</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-char" title="seed_value_from_char ()">seed_value_from_char</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><span class="type">gchar</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">guchar</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-uchar" title="seed_value_to_uchar ()">seed_value_to_uchar</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-uchar" title="seed_value_from_uchar ()">seed_value_from_uchar</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><span class="type">guchar</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">glong</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-long" title="seed_value_to_long ()">seed_value_to_long</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-long" title="seed_value_from_long ()">seed_value_from_long</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><span class="type">glong</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gulong</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-ulong" title="seed_value_to_ulong ()">seed_value_to_ulong</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-ulong" title="seed_value_from_ulong ()">seed_value_from_ulong</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><span class="type">gulong</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gint64</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-int64" title="seed_value_to_int64 ()">seed_value_to_int64</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-int64" title="seed_value_from_int64 ()">seed_value_from_int64</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><span class="type">gint64</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">guint64</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-uint64" title="seed_value_to_uint64 ()">seed_value_to_uint64</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-uint64" title="seed_value_from_uint64 ()">seed_value_from_uint64</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><span class="type">guint64</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gfloat</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-float" title="seed_value_to_float ()">seed_value_to_float</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-float" title="seed_value_from_float ()">seed_value_from_float</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><span class="type">gfloat</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gdouble</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-double" title="seed_value_to_double ()">seed_value_to_double</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-double" title="seed_value_from_double ()">seed_value_from_double</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><span class="type">gdouble</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gchar</span> * <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-string" title="seed_value_to_string ()">seed_value_to_string</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-string" title="seed_value_from_string ()">seed_value_from_string</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>const <span class="type">gchar</span> *val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-binary-string" title="seed_value_from_binary_string ()">seed_value_from_binary_string</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>const <span class="type">gchar</span> *bytes</code></em>, - <em class="parameter"><code><span class="type">gint</span> n_bytes</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">GObject</span> * <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-object" title="seed_value_to_object ()">seed_value_to_object</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-object" title="seed_value_from_object ()">seed_value_from_object</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><span class="type">GObject</span> *val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">gchar</span> * <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-filename" title="seed_value_to_filename ()">seed_value_to_filename</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-filename" title="seed_value_from_filename ()">seed_value_from_filename</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-format" title="seed_value_to_format ()">seed_value_to_format</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>const <span class="type">gchar</span> *format</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *values</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>, - <em class="parameter"><code>...</code></em>); -<span class="returnvalue">gpointer</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-pointer-get-pointer" title="seed_pointer_get_pointer ()">seed_pointer_get_pointer</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> pointer</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-make-pointer" title="seed_make_pointer ()">seed_make_pointer</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><span class="type">gpointer</span> pointer</code></em>); -typedef <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString">SeedString</a>; -<a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="returnvalue">SeedString</span></a> <a class="link" href="seed-Native-Type-Conversion.html#seed-string-ref" title="seed_string_ref ()">seed_string_ref</a> (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-string-unref" title="seed_string_unref ()">seed_string_unref</a> (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>); -<span class="returnvalue">gsize</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-string-get-maximum-size" title="seed_string_get_maximum_size ()">seed_string_get_maximum_size</a> (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>); -<span class="returnvalue">gsize</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer" title="seed_string_to_utf8_buffer ()">seed_string_to_utf8_buffer</a> (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>, - <em class="parameter"><code><span class="type">gchar</span> *buffer</code></em>, - <em class="parameter"><code><span class="type">size_t</span> buffer_size</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-string-is-equal" title="seed_string_is_equal ()">seed_string_is_equal</a> (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> a</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> b</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Native-Type-Conversion.html#seed-string-is-equal-utf8" title="seed_string_is_equal_utf8 ()">seed_string_is_equal_utf8</a> (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> a</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *b</code></em>); -</pre> -</div> <div class="refsect1"> -<a name="seed-Native-Type-Conversion.description"></a><h2>Description</h2> -<p> -Long description -</p> -</div> -<div class="refsect1"> -<a name="seed-Native-Type-Conversion.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="SeedValue"></a><h3>SeedValue</h3> -<pre class="programlisting">typedef gpointer SeedValue; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="SeedType"></a><h3>enum SeedType</h3> -<pre class="programlisting">typedef enum { - SEED_TYPE_UNDEFINED, - SEED_TYPE_NULL, - SEED_TYPE_BOOLEAN, - SEED_TYPE_NUMBER, - SEED_TYPE_STRING, - SEED_TYPE_OBJECT -} SeedType; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="seed-make-undefined"></a><h3>seed_make_undefined ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_make_undefined (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> -<p> -Note that this function returns a valid SeedValue, -representing the undefined JavaScript value, and not an -undefined SeedValue. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-Native-Type-Conversion.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-make-undefined" title="seed_make_undefined ()">seed_make_undefined</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-make-null" title="seed_make_null ()">seed_make_null</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-boolean" title="seed_value_to_boolean ()">seed_value_to_boolean</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-boolean" title="seed_value_from_boolean ()">seed_value_from_boolean</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-uint" title="seed_value_to_uint ()">seed_value_to_uint</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-uint" title="seed_value_from_uint ()">seed_value_from_uint</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-int" title="seed_value_to_int ()">seed_value_to_int</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-int" title="seed_value_from_int ()">seed_value_from_int</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-char" title="seed_value_to_char ()">seed_value_to_char</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-char" title="seed_value_from_char ()">seed_value_from_char</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-uchar" title="seed_value_to_uchar ()">seed_value_to_uchar</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-uchar" title="seed_value_from_uchar ()">seed_value_from_uchar</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="returnvalue">glong</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-long" title="seed_value_to_long ()">seed_value_to_long</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-long" title="seed_value_from_long ()">seed_value_from_long</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-ulong" title="seed_value_to_ulong ()">seed_value_to_ulong</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-ulong" title="seed_value_from_ulong ()">seed_value_from_ulong</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-int64" title="seed_value_to_int64 ()">seed_value_to_int64</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-int64" title="seed_value_from_int64 ()">seed_value_from_int64</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-uint64" title="seed_value_to_uint64 ()">seed_value_to_uint64</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-uint64" title="seed_value_from_uint64 ()">seed_value_from_uint64</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-float" title="seed_value_to_float ()">seed_value_to_float</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-float" title="seed_value_from_float ()">seed_value_from_float</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-double" title="seed_value_to_double ()">seed_value_to_double</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-double" title="seed_value_from_double ()">seed_value_from_double</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-string" title="seed_value_to_string ()">seed_value_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-string" title="seed_value_from_string ()">seed_value_from_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-binary-string" title="seed_value_from_binary_string ()">seed_value_from_binary_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-object" title="seed_value_to_object ()">seed_value_to_object</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-object" title="seed_value_from_object ()">seed_value_from_object</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-filename" title="seed_value_to_filename ()">seed_value_to_filename</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-from-filename" title="seed_value_from_filename ()">seed_value_from_filename</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-value-to-format" title="seed_value_to_format ()">seed_value_to_format</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-pointer-get-pointer" title="seed_pointer_get_pointer ()">seed_pointer_get_pointer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-make-pointer" title="seed_make_pointer ()">seed_make_pointer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="returnvalue">SeedString</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-string-ref" title="seed_string_ref ()">seed_string_ref</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-string-unref" title="seed_string_unref ()">seed_string_unref</a> <span class="c_punctuation">()</span> </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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> of the 'undefined' type.</td> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-string-get-maximum-size" title="seed_string_get_maximum_size ()">seed_string_get_maximum_size</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer" title="seed_string_to_utf8_buffer ()">seed_string_to_utf8_buffer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-string-is-equal" title="seed_string_is_equal ()">seed_string_is_equal</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Native-Type-Conversion.html#seed-string-is-equal-utf8" title="seed_string_is_equal_utf8 ()">seed_string_is_equal_utf8</a> <span class="c_punctuation">()</span> +</td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="seed-make-null"></a><h3>seed_make_null ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_make_null (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> -<p> -Note that this function returns a valid SeedValue, -representing the null JavaScript value, and not a -null SeedValue. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<div class="refsect1"> +<a name="seed-Native-Type-Conversion.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue">SeedValue</a></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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> of the 'null' type.</td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType">SeedType</a></td> +</tr> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString">SeedString</a></td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="seed-value-to-boolean"></a><h3>seed_value_to_boolean ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_to_boolean (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<div class="refsect1"> +<a name="seed-Native-Type-Conversion.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> +</pre> +</div> +<div class="refsect1"> +<a name="seed-Native-Type-Conversion.description"></a><h2>Description</h2> <p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gboolean</span>. Keep in mind that this will -not convert a JavaScript number type, only a boolean. +Long description </p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +</div> +<div class="refsect1"> +<a name="seed-Native-Type-Conversion.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="seed-make-undefined"></a><h3>seed_make_undefined ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_make_undefined (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> +<p>Note that this function returns a valid SeedValue, +representing the undefined JavaScript value, and not an +undefined SeedValue.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.2.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> of the 'undefined' type.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="seed-make-null"></a><h3>seed_make_null ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_make_null (<em class="parameter"><code><a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> ctx</code></em>);</pre> +<p>Note that this function returns a valid SeedValue, +representing the null JavaScript value, and not a +null SeedValue.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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 valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.3.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> of the 'null' type.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="seed-value-to-boolean"></a><h3>seed_value_to_boolean ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_to_boolean (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>. Keep in mind that this will +not convert a JavaScript number type, only a boolean.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gboolean</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.4.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-boolean"></a><h3>seed_value_from_boolean ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_boolean (<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><span class="type">gboolean</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gboolean</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-boolean"></a><h3>seed_value_from_boolean ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_boolean (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <span class="type">gboolean</span> to represent.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> to represent.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.5.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-uint"></a><h3>seed_value_to_uint ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> seed_value_to_uint (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">guint</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-uint"></a><h3>seed_value_to_uint ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +seed_value_to_uint (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">guint</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.6.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-uint"></a><h3>seed_value_from_uint ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_uint (<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><span class="type">guint</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">guint</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-uint"></a><h3>seed_value_from_uint ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_uint (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">guint</span> to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.7.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-int"></a><h3>seed_value_to_int ()</h3> -<pre class="programlisting"><span class="returnvalue">gint</span> seed_value_to_int (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gint</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-int"></a><h3>seed_value_to_int ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> +seed_value_to_int (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gint</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.8.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-int"></a><h3>seed_value_from_int ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_int (<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><span class="type">gint</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gint</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-int"></a><h3>seed_value_from_int ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_int (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">gint</span> to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.9.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-char"></a><h3>seed_value_to_char ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> seed_value_to_char (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gchar</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-char"></a><h3>seed_value_to_char ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> +seed_value_to_char (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gchar</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.10.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-char"></a><h3>seed_value_from_char ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_char (<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><span class="type">gchar</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gchar</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-char"></a><h3>seed_value_from_char ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_char (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.11.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">gchar</span> to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.11.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-uchar"></a><h3>seed_value_to_uchar ()</h3> -<pre class="programlisting"><span class="returnvalue">guchar</span> seed_value_to_uchar (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">guchar</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-uchar"></a><h3>seed_value_to_uchar ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> +seed_value_to_uchar (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.12.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">guchar</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.12.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-uchar"></a><h3>seed_value_from_uchar ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_uchar (<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><span class="type">guchar</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">guchar</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-uchar"></a><h3>seed_value_from_uchar ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_uchar (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.13.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <span class="type">guchar</span> to represent.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> to represent.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.13.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-long"></a><h3>seed_value_to_long ()</h3> -<pre class="programlisting"><span class="returnvalue">glong</span> seed_value_to_long (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">glong</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-long"></a><h3>seed_value_to_long ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="returnvalue">glong</span></a> +seed_value_to_long (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.14.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">glong</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.14.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-long"></a><h3>seed_value_from_long ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_long (<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><span class="type">glong</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">glong</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-long"></a><h3>seed_value_from_long ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_long (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.15.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <span class="type">glong</span> to represent.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> to represent.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.15.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-ulong"></a><h3>seed_value_to_ulong ()</h3> -<pre class="programlisting"><span class="returnvalue">gulong</span> seed_value_to_ulong (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gulong</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-ulong"></a><h3>seed_value_to_ulong ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a> +seed_value_to_ulong (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.16.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gulong</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.16.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-ulong"></a><h3>seed_value_from_ulong ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_ulong (<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><span class="type">gulong</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gulong</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-ulong"></a><h3>seed_value_from_ulong ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_ulong (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.17.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">gulong</span> to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.17.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-int64"></a><h3>seed_value_to_int64 ()</h3> -<pre class="programlisting"><span class="returnvalue">gint64</span> seed_value_to_int64 (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gint64</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-int64"></a><h3>seed_value_to_int64 ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> +seed_value_to_int64 (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.18.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gint64</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.18.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-int64"></a><h3>seed_value_from_int64 ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_int64 (<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><span class="type">gint64</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gint64</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-int64"></a><h3>seed_value_from_int64 ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_int64 (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.19.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">gint64</span> to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.19.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-uint64"></a><h3>seed_value_to_uint64 ()</h3> -<pre class="programlisting"><span class="returnvalue">guint64</span> seed_value_to_uint64 (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">guint64</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-uint64"></a><h3>seed_value_to_uint64 ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> +seed_value_to_uint64 (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.20.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">guint64</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.20.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-uint64"></a><h3>seed_value_from_uint64 ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_uint64 (<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><span class="type">guint64</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">guint64</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-uint64"></a><h3>seed_value_from_uint64 ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_uint64 (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.21.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">guint64</span> to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.21.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-float"></a><h3>seed_value_to_float ()</h3> -<pre class="programlisting"><span class="returnvalue">gfloat</span> seed_value_to_float (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gfloat</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-float"></a><h3>seed_value_to_float ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> +seed_value_to_float (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.22.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gfloat</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.22.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-float"></a><h3>seed_value_from_float ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_float (<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><span class="type">gfloat</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gfloat</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-float"></a><h3>seed_value_from_float ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_float (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.23.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <span class="type">gfloat</span> to represent.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> to represent.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.23.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-double"></a><h3>seed_value_to_double ()</h3> -<pre class="programlisting"><span class="returnvalue">gdouble</span> seed_value_to_double (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gdouble</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-double"></a><h3>seed_value_to_double ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> +seed_value_to_double (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.24.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gdouble</span> represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.24.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-double"></a><h3>seed_value_from_double ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_double (<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><span class="type">gdouble</span> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gdouble</span> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-double"></a><h3>seed_value_from_double ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_double (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.25.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <span class="type">gdouble</span> to represent.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> to represent.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.25.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-string"></a><h3>seed_value_to_string ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * seed_value_to_string (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gchar</span>* string. Keep in mind that it's -up to the caller to free the string. -</p> -<p> -If the <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> represents JavaScript's undefined value, this returns +<a name="seed-value-to-string"></a><h3>seed_value_to_string ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +seed_value_to_string (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* string. Keep in mind that it's +up to the caller to free the string.</p> +<p>If the <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> represents JavaScript's undefined value, this returns "[undefined]"; if it represents JavaScript's null value, this returns -"[null]". -</p> -<p> -If the <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> is a number or a boolean, it is printed as a double, with -the printf format string "%.15g". -</p> -<p> -If the <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> is an object, the string returned is that obtained by -calling .toString() on said object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +"[null]".</p> +<p>If the <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> is a number or a boolean, it is printed as a double, with +the printf format string "%.15g".</p> +<p>If the <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> is an object, the string returned is that obtained by +calling .toString() on said object.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.26.8"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gchar</span>* represented by <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.26.9"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* represented by <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-string"></a><h3>seed_value_from_string ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_string (<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>const <span class="type">gchar</span> *val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gchar</span>* string into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-string"></a><h3>seed_value_from_string ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_string (<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>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* string into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.27.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <span class="type">gchar</span>* to represent.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* to represent.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.27.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-binary-string"></a><h3>seed_value_from_binary_string ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_binary_string (<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>const <span class="type">gchar</span> *bytes</code></em>, - <em class="parameter"><code><span class="type">gint</span> n_bytes</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Converts a string representation of the given binary string -into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<p> -FIXME - should use BinaryArray really -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-binary-string"></a><h3>seed_value_from_binary_string ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_binary_string (<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>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *bytes</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_bytes</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Converts a string representation of the given binary string +into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<p>FIXME - should use BinaryArray really</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.28.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>bytes</code></em> :</span></p></td> -<td>A string of bytes to represent as a string.</td> +<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><p><span class="term"><em class="parameter"><code>n_bytes</code></em> :</span></p></td> -<td>The number of bytes from <em class="parameter"><code>bytes</code></em> to convert.</td> +<td class="parameter_name"><p>bytes</p></td> +<td class="parameter_description"><p>A string of bytes to represent as a string.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of bytes from <em class="parameter"><code>bytes</code></em> +to convert.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>bytes</code></em> as a string.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.28.7"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>bytes</code></em> +as a string.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-object"></a><h3>seed_value_to_object ()</h3> -<pre class="programlisting"><span class="returnvalue">GObject</span> * seed_value_to_object (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Given a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which is wrapping a <span class="type">GObject</span>, retrieve the wrapped -<span class="type">GObject</span>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-object"></a><h3>seed_value_to_object ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * +seed_value_to_object (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Given a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which is wrapping a <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>, retrieve the wrapped +<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.29.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to unwrap.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to unwrap.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">GObject</span> wrapped within <em class="parameter"><code>val</code></em>, or <code class="literal">NULL</code> if an exception -is raised during the conversion.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.29.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> wrapped within <em class="parameter"><code>val</code></em> +, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an exception +is raised during the conversion.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-object"></a><h3>seed_value_from_object ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_object (<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><span class="type">GObject</span> *val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> -<p> -Wraps <em class="parameter"><code>val</code></em> in a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-object"></a><h3>seed_value_from_object ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_object (<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 href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<p>Wraps <em class="parameter"><code>val</code></em> + in a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.30.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">GObject</span> to wrap.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> to wrap.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which wraps <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.30.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which wraps <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-filename"></a><h3>seed_value_to_filename ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * seed_value_to_filename (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>);</pre> -<p> -Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <span class="type">gchar</span>*, properly converting to the -character set used for filenames on the local machine. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-to-filename"></a><h3>seed_value_to_filename ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +seed_value_to_filename (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>);</pre> +<p>Converts the given <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> into a <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*, properly converting to the +character set used for filenames on the local machine.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.31.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The <span class="type">gchar</span>* represented by <em class="parameter"><code>val</code></em>, or <code class="literal">NULL</code> if an exception -is raised during the conversion.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.31.6"></a><h4>Returns</h4> +<p> The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* represented by <em class="parameter"><code>val</code></em> +, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an exception +is raised during the conversion.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-from-filename"></a><h3>seed_value_from_filename ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_value_from_filename (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>);</pre> -<p> -Converts the given <span class="type">gchar</span>* filename into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>, respecting the -character set used for filenames on the local machine. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-from-filename"></a><h3>seed_value_from_filename ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_value_from_filename (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> val</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>);</pre> +<p>Converts the given <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* filename into a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>, respecting the +character set used for filenames on the local machine.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.32.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>val</code></em> :</span></p></td> -<td>The <span class="type">gchar</span>* filename to represent.</td> +<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><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. -Pass <code class="literal">NULL</code> to ignore exceptions.</td> +<td class="parameter_name"><p>val</p></td> +<td class="parameter_description"><p>The <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* filename to represent.</p></td> +<td class="parameter_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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em>.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>A reference to a <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> in which to store any exceptions. +Pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore exceptions.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.32.6"></a><h4>Returns</h4> +<p> A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> which represents <em class="parameter"><code>val</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-to-format"></a><h3>seed_value_to_format ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_to_format (<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>const <span class="type">gchar</span> *format</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *values</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p> -A convenience API for converting multiple values at once, the format string +<a name="seed-value-to-format"></a><h3>seed_value_to_format ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_to_format (<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>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *values</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *exception</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p>A convenience API for converting multiple values at once, the format string is composed of single characters specifying types, for example: i: gint u: guint o: GObject * s: gchar * f: gdouble -c: gchar -</p> -<p> -and a valid format string could be "iuo". -</p> -<p> -This function may be in particular useful in converting arguments -in a <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +c: gchar</p> +<p>and a valid format string could be "iuo".</p> +<p>This function may be in particular useful in converting arguments +in a <a class="link" href="seed-Native-Functions.html#SeedFunctionCallback" title="SeedFunctionCallback ()"><span class="type">SeedFunctionCallback</span></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.33.7"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <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>format</code></em> :</span></p></td> -<td>Format string to use.</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td> -<td>The values to convert.</td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>Format string to use.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>exception</code></em> :</span></p></td> -<td>Location to store an exception.</td> +<td class="parameter_name"><p>values</p></td> +<td class="parameter_description"><p>The values to convert.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Whether conversion was successful.</td> +<td class="parameter_name"><p>exception</p></td> +<td class="parameter_description"><p>Location to store an exception.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.33.8"></a><h4>Returns</h4> +<p> Whether conversion was successful.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-pointer-get-pointer"></a><h3>seed_pointer_get_pointer ()</h3> -<pre class="programlisting"><span class="returnvalue">gpointer</span> seed_pointer_get_pointer (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> pointer</code></em>);</pre> +<a name="seed-pointer-get-pointer"></a><h3>seed_pointer_get_pointer ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> +seed_pointer_get_pointer (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> pointer</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-make-pointer"></a><h3>seed_make_pointer ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_make_pointer (<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><span class="type">gpointer</span> pointer</code></em>);</pre> +<a name="seed-make-pointer"></a><h3>seed_make_pointer ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_make_pointer (<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 href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> pointer</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="SeedString"></a><h3>SeedString</h3> -<pre class="programlisting">typedef gpointer SeedString; -</pre> -<p> +<a name="seed-string-ref"></a><h3>seed_string_ref ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="returnvalue">SeedString</span></a> +seed_string_ref (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> +<p>Increments the reference count of <em class="parameter"><code>string</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.36.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>string</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.36.6"></a><h4>Returns</h4> +<p> <em class="parameter"><code>string</code></em> </p> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-string-ref"></a><h3>seed_string_ref ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="returnvalue">SeedString</span></a> seed_string_ref (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> -<p> -Increments the reference count of <em class="parameter"><code>string</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td><em class="parameter"><code>string</code></em></td> -</tr> -</tbody> +<a name="seed-string-unref"></a><h3>seed_string_unref ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_string_unref (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> +<p>Decrements the reference count of <em class="parameter"><code>string</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.37.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>string</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-string-unref"></a><h3>seed_string_unref ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_string_unref (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> -<p> -Decrements the reference count of <em class="parameter"><code>string</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-string-get-maximum-size"></a><h3>seed_string_get_maximum_size ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> +seed_string_get_maximum_size (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.2.7.38.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</td> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.38.5"></a><h4>Returns</h4> +<p> The maximum number of bytes <em class="parameter"><code>string</code></em> +will take up if converted +to a null-terminated UTF8 string.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-string-get-maximum-size"></a><h3>seed_string_get_maximum_size ()</h3> -<pre class="programlisting"><span class="returnvalue">gsize</span> seed_string_get_maximum_size (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-string-to-utf8-buffer"></a><h3>seed_string_to_utf8_buffer ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> +seed_string_to_utf8_buffer (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer</code></em>, + <em class="parameter"><code><span class="type">size_t</span> buffer_size</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.2.7.39.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</td> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The maximum number of bytes <em class="parameter"><code>string</code></em> will take up if converted -to a null-terminated UTF8 string.</td> +<td class="parameter_name"><p>buffer</p></td> +<td class="parameter_description"><p>An allocated string.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>buffer_size</p></td> +<td class="parameter_description"><p>The length of <em class="parameter"><code>buffer</code></em> +, in bytes.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.39.5"></a><h4>Returns</h4> +<p> A the number of bytes copied into <em class="parameter"><code>buffer</code></em> +.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-string-to-utf8-buffer"></a><h3>seed_string_to_utf8_buffer ()</h3> -<pre class="programlisting"><span class="returnvalue">gsize</span> seed_string_to_utf8_buffer (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> string</code></em>, - <em class="parameter"><code><span class="type">gchar</span> *buffer</code></em>, - <em class="parameter"><code><span class="type">size_t</span> buffer_size</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-string-is-equal"></a><h3>seed_string_is_equal ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_string_is_equal (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> a</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> b</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.2.7.40.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a>.</td> +<td class="parameter_name"><p>a</p></td> +<td class="parameter_description"><p>The first <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> to compare.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> -<td>An allocated string.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>buffer_size</code></em> :</span></p></td> -<td>The length of <em class="parameter"><code>buffer</code></em>, in bytes.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A the number of bytes copied into <em class="parameter"><code>buffer</code></em>.</td> +<td class="parameter_name"><p>b</p></td> +<td class="parameter_description"><p>The second <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> to compare.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.40.5"></a><h4>Returns</h4> +<p> <span class="type">true</span>, if a and b are equal, <span class="type">false</span> otherwise.</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-string-is-equal"></a><h3>seed_string_is_equal ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_string_is_equal (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> a</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> b</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-string-is-equal-utf8"></a><h3>seed_string_is_equal_utf8 ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_string_is_equal_utf8 (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> a</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *b</code></em>);</pre> +<p>Tests the equality of a SeedString and a UTF-8 C-style string.</p> +<div class="refsect3"> +<a name="id-1.4.8.2.7.41.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td> -<td>The first <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> to compare.</td> +<td class="parameter_name"><p>a</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> to compare.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td> -<td>The second <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> to compare.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<span class="type">true</span>, if a and b are equal, <span class="type">false</span> otherwise.</td> +<td class="parameter_name"><p>b</p></td> +<td class="parameter_description"><p>A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* to compare to.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.2.7.41.6"></a><h4>Returns</h4> +<p> <span class="type">true</span>, if a and b are equal, <span class="type">false</span> otherwise.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="seed-Native-Type-Conversion.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SeedValue"></a><h3>SeedValue</h3> +<pre class="programlisting">typedef gpointer SeedValue; +</pre> +<p> +</p> +</div> <hr> <div class="refsect2"> -<a name="seed-string-is-equal-utf8"></a><h3>seed_string_is_equal_utf8 ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_string_is_equal_utf8 (<em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> a</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *b</code></em>);</pre> +<a name="SeedType"></a><h3>enum SeedType</h3> <p> -Tests the equality of a SeedString and a UTF-8 C-style string. </p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<div class="refsect3"> +<a name="id-1.4.8.2.8.3.4"></a><h4>Members</h4> +<div class="informaltable"><table 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>a</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedString" title="SeedString"><span class="type">SeedString</span></a> to compare.</td> +<td class="enum_member_name"><p><a name="SEED-TYPE-UNDEFINED:CAPS"></a>SEED_TYPE_UNDEFINED</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-TYPE-NULL:CAPS"></a>SEED_TYPE_NULL</p></td> +<td class="enum_member_description"> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td> -<td>A <span class="type">gchar</span>* to compare to.</td> +<td class="enum_member_name"><p><a name="SEED-TYPE-BOOLEAN:CAPS"></a>SEED_TYPE_BOOLEAN</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> -<span class="type">true</span>, if a and b are equal, <span class="type">false</span> otherwise.</td> +<td class="enum_member_name"><p><a name="SEED-TYPE-NUMBER:CAPS"></a>SEED_TYPE_NUMBER</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-TYPE-STRING:CAPS"></a>SEED_TYPE_STRING</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-TYPE-OBJECT:CAPS"></a>SEED_TYPE_OBJECT</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="SeedString"></a><h3>SeedString</h3> +<pre class="programlisting">typedef gpointer SeedString; +</pre> +<p> +</p> +</div> +</div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Operating-on-Native-Types.html b/doc/reference/html/seed-Operating-on-Native-Types.html index 12fda20..4b7ae46 100644 --- a/doc/reference/html/seed-Operating-on-Native-Types.html +++ b/doc/reference/html/seed-Operating-on-Native-Types.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Operating on JavaScript types</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Operating on JavaScript types: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="types.html" title="Values and Type Conversion"> <link rel="prev" href="seed-Native-Type-Conversion.html" title="Type Conversion"> <link rel="next" href="seed-JS-Objects.html" title="Working with JavaScript objects"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Type-Conversion.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="types.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-JS-Objects.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-Operating-on-Native-Types.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Operating-on-Native-Types.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-Operating-on-Native-Types.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="types.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="seed-Native-Type-Conversion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-JS-Objects.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Operating-on-Native-Types"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,34 +29,102 @@ <h2><span class="refentrytitle"><a name="seed-Operating-on-Native-Types.top_of_page"></a>Operating on JavaScript types</span></h2> <p>Operating on JavaScript types — Determining the type of a SeedValue</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-Operating-on-Native-Types.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -<span class="returnvalue">void</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-unprotect" title="seed_value_unprotect ()">seed_value_unprotect</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-protect" title="seed_value_protect ()">seed_value_protect</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-undefined" title="seed_value_is_undefined ()">seed_value_is_undefined</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-null" title="seed_value_is_null ()">seed_value_is_null</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-function" title="seed_value_is_function ()">seed_value_is_function</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> value</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-number" title="seed_value_is_number ()">seed_value_is_number</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-string" title="seed_value_is_string ()">seed_value_is_string</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-object-of-class" title="seed_value_is_object_of_class ()">seed_value_is_object_of_class</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</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>); -<span class="returnvalue">gboolean</span> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-object" title="seed_value_is_object ()">seed_value_is_object</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="returnvalue">SeedType</span></a> <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-get-type" title="seed_value_get_type ()">seed_value_get_type</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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>); +<div class="refsect1"> +<a name="seed-Operating-on-Native-Types.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-unprotect" title="seed_value_unprotect ()">seed_value_unprotect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-protect" title="seed_value_protect ()">seed_value_protect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-undefined" title="seed_value_is_undefined ()">seed_value_is_undefined</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-null" title="seed_value_is_null ()">seed_value_is_null</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-function" title="seed_value_is_function ()">seed_value_is_function</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-number" title="seed_value_is_number ()">seed_value_is_number</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-string" title="seed_value_is_string ()">seed_value_is_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-object-of-class" title="seed_value_is_object_of_class ()">seed_value_is_object_of_class</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-is-object" title="seed_value_is_object ()">seed_value_is_object</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="returnvalue">SeedType</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-get-type" title="seed_value_get_type ()">seed_value_get_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Operating-on-Native-Types.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -70,275 +134,374 @@ Long description </p> </div> <div class="refsect1"> -<a name="seed-Operating-on-Native-Types.details"></a><h2>Details</h2> +<a name="seed-Operating-on-Native-Types.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="seed-value-unprotect"></a><h3>seed_value_unprotect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_value_unprotect (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Decrements the "protection count" of <em class="parameter"><code>value</code></em>, as explained in -<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-protect" title="seed_value_protect ()"><code class="function">seed_value_protect()</code></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-unprotect"></a><h3>seed_value_unprotect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_value_unprotect (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Decrements the "protection count" of <em class="parameter"><code>value</code></em> +, as explained in +<a class="link" href="seed-Operating-on-Native-Types.html#seed-value-protect" title="seed_value_protect ()"><code class="function">seed_value_protect()</code></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to unprotect.</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to unprotect.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-protect"></a><h3>seed_value_protect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_value_protect (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Increments the "protection count" of <em class="parameter"><code>value</code></em>, in case you want to store +<a name="seed-value-protect"></a><h3>seed_value_protect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_value_protect (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Increments the "protection count" of <em class="parameter"><code>value</code></em> +, in case you want to store a reference somewhere where the garbage collector won't be able to find it, -and don't want it to be collected! -</p> -<p> -In order for <em class="parameter"><code>value</code></em> to be collected afterwards, it will need to be -unprotected the same number of times with <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-unprotect" title="seed_value_unprotect ()"><code class="function">seed_value_unprotect()</code></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +and don't want it to be collected!</p> +<p>In order for <em class="parameter"><code>value</code></em> + to be collected afterwards, it will need to be +unprotected the same number of times with <a class="link" href="seed-Operating-on-Native-Types.html#seed-value-unprotect" title="seed_value_unprotect ()"><code class="function">seed_value_unprotect()</code></a>.</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.3.6"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to protect.</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> to protect.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-undefined"></a><h3>seed_value_is_undefined ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_undefined (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> represents the JavaScript undefined value -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-undefined"></a><h3>seed_value_is_undefined ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_undefined (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + represents the JavaScript undefined value</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is 'undefined')</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.4.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is 'undefined')</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-null"></a><h3>seed_value_is_null ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_null (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> represents the JavaScript null value -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-null"></a><h3>seed_value_is_null ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_null (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + represents the JavaScript null value</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is 'null')</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.5.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is 'null')</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-function"></a><h3>seed_value_is_function ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_function (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> value</code></em>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> is a JavaScript function (and, therefore, -an object) -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-function"></a><h3>seed_value_is_function ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_function (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> value</code></em>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + is a JavaScript function (and, therefore, +an object)</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is a function)</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.6.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is a function)</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-number"></a><h3>seed_value_is_number ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_number (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> is a JavaScript number -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-number"></a><h3>seed_value_is_number ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_number (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + is a JavaScript number</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.7.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is a number)</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.7.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is a number)</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-string"></a><h3>seed_value_is_string ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_string (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> is a JavaScript string -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-string"></a><h3>seed_value_is_string ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_string (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + is a JavaScript string</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.8.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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> +<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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is a string)</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.8.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is a string)</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-object-of-class"></a><h3>seed_value_is_object_of_class ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_object_of_class (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</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>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> is an object of the specified class -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-object-of-class"></a><h3>seed_value_is_object_of_class ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_object_of_class (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</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>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + is an object of the specified class</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.9.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> +<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><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td> -<td>A <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a>.</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is of class <em class="parameter"><code>klass</code></em>)</td> +<td class="parameter_name"><p>klass</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-JavaScript-Classes.html#SeedClass" title="SeedClass"><span class="type">SeedClass</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.9.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is of class <em class="parameter"><code>klass</code></em> +)</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-is-object"></a><h3>seed_value_is_object ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> seed_value_is_object (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<p> -Determine whether or not <em class="parameter"><code>value</code></em> is a JavaScript object -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-is-object"></a><h3>seed_value_is_object ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +seed_value_is_object (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<p>Determine whether or not <em class="parameter"><code>value</code></em> + is a JavaScript object</p> +<div class="refsect3"> +<a name="id-1.4.8.3.6.10.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><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>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</td> +<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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <span class="type">gboolean</span> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> is an object)</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a>.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.10.6"></a><h4>Returns</h4> +<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> (<code class="literal">true</code> if <em class="parameter"><code>value</code></em> +is an object)</p> +</div> +</div> <hr> <div class="refsect2"> -<a name="seed-value-get-type"></a><h3>seed_value_get_type ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="returnvalue">SeedType</span></a> seed_value_get_type (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-value-get-type"></a><h3>seed_value_get_type ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedType" title="enum SeedType"><span class="returnvalue">SeedType</span></a> +seed_value_get_type (<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-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> value</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.8.3.6.11.4"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> -<td>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The type of <em class="parameter"><code>value</code></em> -</td> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>A <a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.4.8.3.6.11.5"></a><h4>Returns</h4> +<p> The type of <em class="parameter"><code>value</code></em> +</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="seed-Operating-on-Native-Types.other_details"></a><h2>Types and Values</h2> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-SeedClosure.html b/doc/reference/html/seed-SeedClosure.html index 71786d9..c2a5ff6 100644 --- a/doc/reference/html/seed-SeedClosure.html +++ b/doc/reference/html/seed-SeedClosure.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Using JavaScript closures</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Using JavaScript closures: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-JavaScript-Classes.html" title="Creating JavaScript classes"> <link rel="next" href="seed-Modules.html" title="Seed Modules"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-JavaScript-Classes.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-Modules.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-SeedClosure.synopsis" class="shortcut">Top</a> - | - <a href="#seed-SeedClosure.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-SeedClosure.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-JavaScript-Classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Modules.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-SeedClosure"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,31 +29,75 @@ <h2><span class="refentrytitle"><a name="seed-SeedClosure.top_of_page"></a>Using JavaScript closures</span></h2> <p>Using JavaScript closures — Creating and invoking closures over JavaScript functions using GClosure</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-SeedClosure.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -struct <a class="link" href="seed-SeedClosure.html#SeedClosure" title="struct SeedClosure">SeedClosure</a>; -<span class="returnvalue">GClosure</span> * <a class="link" href="seed-SeedClosure.html#seed-closure-new" title="seed_closure_new ()">seed_closure_new</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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> user_data</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>); -<a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> <a class="link" href="seed-SeedClosure.html#seed-closure-get-callable" title="seed_closure_get_callable ()">seed_closure_get_callable</a> (<em class="parameter"><code><span class="type">GClosure</span> *c</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-SeedClosure.html#seed-closure-invoke" title="seed_closure_invoke ()">seed_closure_invoke</a> (<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *args</code></em>, - <em class="parameter"><code><span class="type">guint</span> argc</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> <a class="link" href="seed-SeedClosure.html#seed-closure-invoke-with-context" title="seed_closure_invoke_with_context ()">seed_closure_invoke_with_context</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><span class="type">GClosure</span> *closure</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *args</code></em>, - <em class="parameter"><code><span class="type">guint</span> argc</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-SeedClosure.html#seed-closure-warn-exception" title="seed_closure_warn_exception ()">seed_closure_warn_exception</a> (<em class="parameter"><code><span class="type">GClosure</span> *c</code></em>, - <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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>); +<div class="refsect1"> +<a name="seed-SeedClosure.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#GClosure"><span class="returnvalue">GClosure</span></a> * +</td> +<td class="function_name"> +<a class="link" href="seed-SeedClosure.html#seed-closure-new" title="seed_closure_new ()">seed_closure_new</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-SeedClosure.html#seed-closure-get-callable" title="seed_closure_get_callable ()">seed_closure_get_callable</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-SeedClosure.html#seed-closure-invoke" title="seed_closure_invoke ()">seed_closure_invoke</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +</td> +<td class="function_name"> +<a class="link" href="seed-SeedClosure.html#seed-closure-invoke-with-context" title="seed_closure_invoke_with_context ()">seed_closure_invoke_with_context</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-SeedClosure.html#seed-closure-warn-exception" title="seed_closure_warn_exception ()">seed_closure_warn_exception</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-SeedClosure.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="seed-SeedClosure.html#SeedClosure" title="struct SeedClosure">SeedClosure</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-SeedClosure.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -67,73 +107,79 @@ Long description </p> </div> <div class="refsect1"> -<a name="seed-SeedClosure.details"></a><h2>Details</h2> +<a name="seed-SeedClosure.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="SeedClosure"></a><h3>struct SeedClosure</h3> -<pre class="programlisting">struct SeedClosure { - GClosure closure; - - JSObjectRef function; - JSValueRef user_data; - - GType return_type; - gchar *description; -}; -</pre> +<a name="seed-closure-new"></a><h3>seed_closure_new ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#GClosure"><span class="returnvalue">GClosure</span></a> * +seed_closure_new (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, + <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> user_data</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-closure-new"></a><h3>seed_closure_new ()</h3> -<pre class="programlisting"><span class="returnvalue">GClosure</span> * seed_closure_new (<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-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="type">SeedObject</span></a> user_data</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>);</pre> +<a name="seed-closure-get-callable"></a><h3>seed_closure_get_callable ()</h3> +<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> +seed_closure_get_callable (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *c</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-closure-get-callable"></a><h3>seed_closure_get_callable ()</h3> -<pre class="programlisting"><a class="link" href="seed-JS-Objects.html#SeedObject" title="SeedObject"><span class="returnvalue">SeedObject</span></a> seed_closure_get_callable (<em class="parameter"><code><span class="type">GClosure</span> *c</code></em>);</pre> +<a name="seed-closure-invoke"></a><h3>seed_closure_invoke ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_closure_invoke (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *closure</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *args</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> argc</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-closure-invoke"></a><h3>seed_closure_invoke ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_closure_invoke (<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *args</code></em>, - <em class="parameter"><code><span class="type">guint</span> argc</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="seed-closure-invoke-with-context"></a><h3>seed_closure_invoke_with_context ()</h3> +<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> +seed_closure_invoke_with_context (<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 href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *closure</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *args</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> argc</code></em>, + <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> <p> </p> </div> <hr> <div class="refsect2"> -<a name="seed-closure-invoke-with-context"></a><h3>seed_closure_invoke_with_context ()</h3> -<pre class="programlisting"><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="returnvalue">SeedValue</span></a> seed_closure_invoke_with_context (<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><span class="type">GClosure</span> *closure</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> *args</code></em>, - <em class="parameter"><code><span class="type">guint</span> argc</code></em>, - <em class="parameter"><code><a class="link" href="seed-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> *exception</code></em>);</pre> +<a name="seed-closure-warn-exception"></a><h3>seed_closure_warn_exception ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_closure_warn_exception (<em class="parameter"><code><a href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *c</code></em>, + <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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> <p> </p> </div> -<hr> +</div> +<div class="refsect1"> +<a name="seed-SeedClosure.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="seed-closure-warn-exception"></a><h3>seed_closure_warn_exception ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_closure_warn_exception (<em class="parameter"><code><span class="type">GClosure</span> *c</code></em>, - <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-Exceptions.html#SeedException" title="SeedException"><span class="type">SeedException</span></a> exception</code></em>);</pre> +<a name="SeedClosure"></a><h3>struct SeedClosure</h3> +<pre class="programlisting">struct SeedClosure { + GClosure closure; + + JSObjectRef function; + JSValueRef user_data; + + GType return_type; + gchar *description; +}; +</pre> <p> </p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-Signals.html b/doc/reference/html/seed-Signals.html index 6242c86..03ca7bf 100644 --- a/doc/reference/html/seed-Signals.html +++ b/doc/reference/html/seed-Signals.html @@ -2,30 +2,26 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GObject Signals</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>GObject Signals: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-Exceptions.html" title="Exception Handling"> <link rel="next" href="types.html" title="Values and Type Conversion"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Exceptions.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="types.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-Signals.synopsis" class="shortcut">Top</a> - | - <a href="#seed-Signals.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-Signals.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-Exceptions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="seed-Signals"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -33,22 +29,38 @@ <h2><span class="refentrytitle"><a name="seed-Signals.top_of_page"></a>GObject Signals</span></h2> <p>GObject Signals — Connecting JavaScript functions to signals</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-Signals.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <seed/seed.h> - -<span class="returnvalue">void</span> <a class="link" href="seed-Signals.html#seed-signal-connect" title="seed_signal_connect ()">seed_signal_connect</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><span class="type">GObject</span> *object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *script</code></em>); -<span class="returnvalue">void</span> <a class="link" href="seed-Signals.html#seed-signal-connect-value" title="seed_signal_connect_value ()">seed_signal_connect_value</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><span class="type">GObject</span> *object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> user_data</code></em>); +<div class="refsect1"> +<a name="seed-Signals.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Signals.html#seed-signal-connect" title="seed_signal_connect ()">seed_signal_connect</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="seed-Signals.html#seed-signal-connect-value" title="seed_signal_connect_value ()">seed_signal_connect_value</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="seed-Signals.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <seed/seed.h> </pre> </div> <div class="refsect1"> @@ -58,56 +70,72 @@ Long description </p> </div> <div class="refsect1"> -<a name="seed-Signals.details"></a><h2>Details</h2> +<a name="seed-Signals.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="seed-signal-connect"></a><h3>seed_signal_connect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_signal_connect (<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><span class="type">GObject</span> *object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *script</code></em>);</pre> -<p> -Evaluates <em class="parameter"><code>script</code></em>, which should return a function, then connects the returned -function to the signal specified by <em class="parameter"><code>signal</code></em> on <em class="parameter"><code>object</code></em>. <em class="parameter"><code>user_data</code></em> -is passed as the user_data argument to the callback function. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> +<a name="seed-signal-connect"></a><h3>seed_signal_connect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_signal_connect (<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 href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *signal</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *script</code></em>);</pre> +<p>Evaluates <em class="parameter"><code>script</code></em> +, which should return a function, then connects the returned +function to the signal specified by <em class="parameter"><code>signal</code></em> + on <em class="parameter"><code>object</code></em> +. <em class="parameter"><code>user_data</code></em> + +is passed as the user_data argument to the callback function.</p> +<div class="refsect3"> +<a name="id-1.4.7.6.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> -<td>A valid <a class="link" href="seed-Contexts.html#SeedContext" title="SeedContext"><span class="type">SeedContext</span></a> -</td> +<td class="parameter_name"><p>ctx</p></td> +<td class="parameter_description"><p>A valid <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><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>A <span class="type">GObject</span>, to connect the signal on.</td> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>A <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>, to connect the signal on.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>signal</code></em> :</span></p></td> -<td>A signal specification.</td> +<td class="parameter_name"><p>signal</p></td> +<td class="parameter_description"><p>A signal specification.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td> -<td>The script to connect to the signal. Should return a function.</td> +<td class="parameter_name"><p>script</p></td> +<td class="parameter_description"><p>The script to connect to the signal. Should return a function.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +</div> <hr> <div class="refsect2"> -<a name="seed-signal-connect-value"></a><h3>seed_signal_connect_value ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> seed_signal_connect_value (<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><span class="type">GObject</span> *object</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> function</code></em>, - <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> user_data</code></em>);</pre> +<a name="seed-signal-connect-value"></a><h3>seed_signal_connect_value ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +seed_signal_connect_value (<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 href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>, + <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *signal</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> function</code></em>, + <em class="parameter"><code><a class="link" href="seed-Native-Type-Conversion.html#SeedValue" title="SeedValue"><span class="type">SeedValue</span></a> user_data</code></em>);</pre> <p> </p> </div> </div> +<div class="refsect1"> +<a name="seed-Signals.other_details"></a><h2>Types and Values</h2> +</div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-building.html b/doc/reference/html/seed-building.html index 111d84f..6bce168 100644 --- a/doc/reference/html/seed-building.html +++ b/doc/reference/html/seed-building.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Compiling Seed</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Compiling Seed: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="seed.html" title="Part I. Seed Overview"> <link rel="prev" href="seed-introduction.html" title="Introduction"> <link rel="next" href="seed-contact.html" title="Contact Information"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-introduction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="seed.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-contact.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="seed.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="seed-introduction.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-contact.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="seed-building"></a><div class="titlepage"></div> @@ -28,7 +28,7 @@ How to compile Seed itself </p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="building"></a><h2>Building the Library on UNIX</h2> @@ -65,7 +65,7 @@ How to compile Seed itself Before you can compile Seed, you need to have various external libraries installed on your system. </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p> The <a class="ulink" href="http://live.gnome.org/GObjectIntrospection" target="_top">gobject-introspection library</a> is necessary to build Seed. It provides the bridge between Seed and many GObject-based libraries. </p></li> @@ -88,7 +88,7 @@ How to compile Seed itself <p> Seed ships with a number of native modules which provide access to libraries which help with development but are not able to be introspected. Some of these modules depend on external libraries, and Seed's configuration will fail if they are not installed; if you wish to build Seed without a module for which you do not have the underlying library installed, check the Extra Configuration Options section of this document. </p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p> <a class="ulink" href="http://cairographics.org/" target="_top">Cairo</a> provides access to fast 2D graphics and numerous different types of output, including drawing to the screen, to an image, to a PDF, etc. </p></li> @@ -211,7 +211,6 @@ How to compile Seed itself </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-contact.html b/doc/reference/html/seed-contact.html index 3853bf7..0164d6b 100644 --- a/doc/reference/html/seed-contact.html +++ b/doc/reference/html/seed-contact.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Contact Information</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Contact Information: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="seed.html" title="Part I. Seed Overview"> <link rel="prev" href="seed-building.html" title="Compiling Seed"> <link rel="next" href="js.html" title="Part II. Seed JavaScript Reference"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-building.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="seed.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="js.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="seed.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="seed-building.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="js.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="seed-contact"></a><div class="titlepage"></div> @@ -28,11 +28,11 @@ Where to find help, ask questions, or bring patches </p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="build"></a><h2>Authors</h2> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem">Robert Carr <<a class="ulink" href="mailto:racarr@svn.gnome.org" target="_top">racarr@svn.gnome.org</a>></li> <li class="listitem">Tim Horton <<a class="ulink" href="mailto:hortont@svn.gnome.org" target="_top">hortont@svn.gnome.org</a>></li> </ul></div> @@ -48,7 +48,6 @@ Where to find help, ask questions, or bring patches </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-importer.html b/doc/reference/html/seed-importer.html index b18dd5d..ff74cd7 100644 --- a/doc/reference/html/seed-importer.html +++ b/doc/reference/html/seed-importer.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Importer</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Importer: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="js.html" title="Part II. Seed JavaScript Reference"> <link rel="prev" href="js.html" title="Part II. Seed JavaScript Reference"> <link rel="next" href="api.html" title="Part III. Seed API Reference"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="js.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="js.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="api.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="js.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="js.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="api.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="seed-importer"></a><div class="titlepage"></div> @@ -28,12 +28,12 @@ Importing gobject-introspection namespaces, native modules, and JavaScript modules </p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="git"></a><h2>Overview</h2> <p>The Seed importer provides a way for applications written in JavaScript to reference functions outside of the current file. This is the heart of Seed's ability to work with other parts of the GNOME stack, as well as a way to write reasonably structured and sensible complex applications from JavaScript. The importer allows access to four types of external objects:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem">GObject-Introspection namespaces, which provide access to functiosn and data which were scanned using gobject-introspection from other C libraries; this is how one accesses most of the libraries of the GNOME stack from JavaScript</li> <li class="listitem">Native modules, which provide a way to load arbitrary shared libraries tailored explicitly to the Seed API, which often offer much higher performance for critical code, or provide an easy way to bind code (by hand) which the introspection scanner cannot parse.</li> <li class="listitem">JavaScript modules, which provide a way to access (in a namespaced manner) the global object of another script, offering a simple way to modularize code written against Seed.</li> @@ -42,60 +42,100 @@ Importing gobject-introspection namespaces, native modules, and JavaScript modul <p>The global 'imports' object represents the runtime-side portion of the importer; all of your interactions with the importer will take place through this object.</p> </div> <div class="refsect1"> -<a name="idp4561216"></a><h2>The Imports Search Path</h2> +<a name="id-1.3.3.4"></a><h2>The Imports Search Path</h2> <p>The path which the importer searches for native modules and JavaScript modules is defined by the searchPath property on the 'imports' global. This should be a JavaScript array of strings representing the order and locations to search for these modules; the default set of paths includes various Seed system directories, the directory in which the currently running script is located, and the current directory, in that order. You can change the path at any time; if an invalid value is assigned, the importer will throw an exception the next time something is imported, <span class="emphasis"><em>not</em></span> when the property is set.</p> <div class="example"> -<a name="idm40224"></a><p class="title"><b>Example 1. Adding a directory to the search path</b></p> -<div class="example-contents"><pre class="programlisting"> -imports.searchPath.unshift("/usr/local/share/random-seed-program-scripts/"); -</pre></div> +<a name="id-1.3.3.4.3"></a><p class="title"><b>Example 1. Adding a directory to the search path</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal">imports</span><span class="symbol">.</span><span class="normal">searchPath</span><span class="symbol">.</span><span class="function">unshift</span><span class="symbol">(</span><span class="string">"/usr/local/share/random-seed-program-scripts/"</span><span class="symbol">);</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"> </div> <div class="refsect1"> -<a name="idm38736"></a><h2>Importing GObject-Introspection namespaces</h2> +<a name="id-1.3.3.5"></a><h2>Importing GObject-Introspection namespaces</h2> <p>GObject-Introspection provides the metadata required in order to call functions, connect to signals, and interact with properties within any library which has been scanned. The hows and whys of introspection are outside of the scope of this article, but how to utilize this data is central to the very tenents of Seed (the minimal platform possible to interact with GObject-based libraries from a pleasant language).</p> <p>Namespaces are loaded as requested, and are loaded only once throughout the lifetime of a Seed program (subsequent requests for the same namespace will return the same object provided previously). The special property 'gi' on the imports global represents the interface for loading these namespaces. A request to import Gtk might look like the following:</p> <div class="example"> -<a name="idm36400"></a><p class="title"><b>Example 2. Using 'imports.gi' to import the Gtk namespace</b></p> -<div class="example-contents"><pre class="programlisting"> -Gtk = imports.gi.Gtk; -</pre></div> +<a name="id-1.3.3.5.4"></a><p class="title"><b>Example 2. Using 'imports.gi' to import the Gtk namespace</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal">Gtk </span><span class="symbol">=</span><span class="normal"> imports</span><span class="symbol">.</span><span class="normal">gi</span><span class="symbol">.</span><span class="normal">Gtk</span><span class="symbol">;</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"><p>This will import the Gtk namespace from GObject-Introspection, and assign it to the global "Gtk" object. Afterwards, Gtk-related functions can be accessed as properties of said object. Imports will <span class="emphasis"><em>never</em></span> add values to the global object or affect anything outside of their namespace.</p> <p>By default, 'imports.gi.NameSpace' will return the most recent installed version of the imported namespace; in order to request a different version, or to mark your program as requiring a particular version, the "imports.gi.versions.NameSpace" property can be set. Keep in mind that versioning for GObject-Introspection namespaces is slightly different from the actual library version numbers; for example, the version for Gtk is still "2.0", even though we're many versions past that. The import will raise an exception if the requested version could not be loaded:</p> <div class="example"> -<a name="idm33056"></a><p class="title"><b>Example 3. Using 'imports.gi.versions' to require Clutter 0.8</b></p> -<div class="example-contents"><pre class="programlisting"> -imports.gi.versions.Clutter = "0.8"; +<a name="id-1.3.3.5.7"></a><p class="title"><b>Example 3. Using 'imports.gi.versions' to require Clutter 0.8</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1 +2 +3 +4 +5 +6 +7 +8 +9 +10</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal">imports</span><span class="symbol">.</span><span class="normal">gi</span><span class="symbol">.</span><span class="normal">versions</span><span class="symbol">.</span><span class="normal">Clutter </span><span class="symbol">=</span><span class="normal"> </span><span class="string">"0.8"</span><span class="symbol">;</span> + +<span class="normal">try</span> +<span class="cbracket">{</span> +<span class="normal"> Clutter </span><span class="symbol">=</span><span class="normal"> imports</span><span class="symbol">.</span><span class="normal">gi</span><span class="symbol">.</span><span class="normal">Clutter</span><span class="symbol">;</span> +<span class="cbracket">}</span> +<span class="keyword">catch</span><span class="symbol">(</span><span class="normal">e</span><span class="symbol">)</span> +<span class="cbracket">{</span> +<span class="normal"> </span><span class="function">print</span><span class="symbol">(</span><span class="string">"Clutter 0.8 is not installed!"</span><span class="symbol">);</span> +<span class="cbracket">}</span></pre></td> + </tr> + </tbody> + </table> +</div> -try -{ - Clutter = imports.gi.Clutter; -} -catch(e) -{ - print("Clutter 0.8 is not installed!"); -} -</pre></div> </div> <br class="example-break"> </div> <div class="refsect1"> -<a name="idm31456"></a><h2>Importing Native Modules</h2> +<a name="id-1.3.3.6"></a><h2>Importing Native Modules</h2> <p>Seed ships with a number of (link!) native modules, which provide access to various parts of the system which GObject-Introspection cannot provide proper metadata for. An application developer could also decide to write performance-critical parts of their code as a native Seed module, as well, as one of the numerous ways to interface C with Seed.</p> <p>Native modules are loaded just like GObject-Introspection namespaces, except as toplevel objects on "imports", instead of "imports.gi". For example, to load the readline module that ships with Seed, one could:</p> <div class="example"> -<a name="idm29280"></a><p class="title"><b>Example 4. Loading the native module "readline"</b></p> -<div class="example-contents"><pre class="programlisting"> -readline = imports.readline; -</pre></div> +<a name="id-1.3.3.6.4"></a><p class="title"><b>Example 4. Loading the native module "readline"</b></p> +<div class="example-contents"> + <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> + <tbody> + <tr> + <td class="listing_lines" align="right"><pre>1</pre></td> + <td class="listing_code"><pre class="programlisting"><span class="normal">readline </span><span class="symbol">=</span><span class="normal"> imports</span><span class="symbol">.</span><span class="normal">readline</span><span class="symbol">;</span></pre></td> + </tr> + </tbody> + </table> +</div> + </div> <br class="example-break"><p>Seed searches the imports search path for native modules; if it finds a file with the given name, the prefix "seed_" and the same suffix as is used for shared libraries on your system (.so on Linux, .dylib on Mac OS X, etc.), it will assume this is a native module and load and initialize it as such. For example, the readline module loaded above is named <code class="filename">seed_readline.so</code> on a recent Linux machine.</p> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed-introduction.html b/doc/reference/html/seed-introduction.html index 688557d..47b2bcc 100644 --- a/doc/reference/html/seed-introduction.html +++ b/doc/reference/html/seed-introduction.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Introduction</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Introduction: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="seed.html" title="Part I. Seed Overview"> <link rel="prev" href="seed.html" title="Part I. Seed Overview"> <link rel="next" href="seed-building.html" title="Compiling Seed"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="seed.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-building.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="seed.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="seed.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-building.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="seed-introduction"></a><div class="titlepage"></div> @@ -28,14 +28,13 @@ What Seed is all about </p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <p> Seed is a library and interpreter, dynamically bridging (through gobject-introspection) the WebKit JavaScriptCore engine with the GObject type system. In a more concrete sense, Seed enables you to immediately write applications around a significant portion of the GNOME platform, and easily embed JavaScript as a scripting language in your GObject library. Seed is built around the idea of "minimal-platform", in that it seems a theoretically ideal GNOME development language provides no platform of its own, but instead seamlessly integrates with the already quite large GNOME platform. </p> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/seed.devhelp2 b/doc/reference/html/seed.devhelp2 index 29c0532..430f3ce 100644 --- a/doc/reference/html/seed.devhelp2 +++ b/doc/reference/html/seed.devhelp2 @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="utf-8" standalone="no"?> -<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> <book xmlns="http://www.devhelp.net/book" title="Seed Reference Manual" link="index.html" author="" name="seed" version="2" language="c"> <chapters> <sub name="Seed Overview" link="seed.html"> @@ -35,134 +34,134 @@ <sub name="Index" link="ix01.html"/> </chapters> <functions> + <keyword type="function" name="seed_init ()" link="seed-Initialization.html#seed-init"/> + <keyword type="function" name="seed_init_with_context_group ()" link="seed-Initialization.html#seed-init-with-context-group"/> + <keyword type="function" name="seed_engine_set_search_path ()" link="seed-Initialization.html#seed-engine-set-search-path"/> + <keyword type="function" name="seed_engine_get_search_path ()" link="seed-Initialization.html#seed-engine-get-search-path"/> <keyword type="struct" name="struct SeedEngine" link="seed-Initialization.html#SeedEngine"/> - <keyword type="function" name="seed_init ()" link="seed-Initialization.html#seed-init"/> - <keyword type="function" name="seed_init_with_context_group ()" link="seed-Initialization.html#seed-init-with-context-group"/> - <keyword type="function" name="seed_engine_set_search_path ()" link="seed-Initialization.html#seed-engine-set-search-path"/> - <keyword type="function" name="seed_engine_get_search_path ()" link="seed-Initialization.html#seed-engine-get-search-path"/> + <keyword type="function" name="seed_context_create ()" link="seed-Contexts.html#seed-context-create"/> + <keyword type="function" name="seed_context_ref ()" link="seed-Contexts.html#seed-context-ref"/> + <keyword type="function" name="seed_context_unref ()" link="seed-Contexts.html#seed-context-unref"/> + <keyword type="function" name="seed_context_collect ()" link="seed-Contexts.html#seed-context-collect"/> + <keyword type="function" name="seed_context_get_global_object ()" link="seed-Contexts.html#seed-context-get-global-object"/> + <keyword type="function" name="seed_prepare_global_context ()" link="seed-Contexts.html#seed-prepare-global-context"/> + <keyword type="function" name="seed_importer_add_global ()" link="seed-Contexts.html#seed-importer-add-global"/> + <keyword type="function" name="seed_importer_set_search_path ()" link="seed-Contexts.html#seed-importer-set-search-path"/> <keyword type="typedef" name="SeedContext" link="seed-Contexts.html#SeedContext"/> <keyword type="typedef" name="SeedGlobalContext" link="seed-Contexts.html#SeedGlobalContext"/> <keyword type="typedef" name="SeedContextGroup" link="seed-Contexts.html#SeedContextGroup"/> - <keyword type="function" name="seed_context_create ()" link="seed-Contexts.html#seed-context-create"/> - <keyword type="function" name="seed_context_ref ()" link="seed-Contexts.html#seed-context-ref"/> - <keyword type="function" name="seed_context_unref ()" link="seed-Contexts.html#seed-context-unref"/> - <keyword type="function" name="seed_context_collect ()" link="seed-Contexts.html#seed-context-collect"/> - <keyword type="function" name="seed_context_get_global_object ()" link="seed-Contexts.html#seed-context-get-global-object"/> - <keyword type="function" name="seed_prepare_global_context ()" link="seed-Contexts.html#seed-prepare-global-context"/> - <keyword type="function" name="seed_importer_add_global ()" link="seed-Contexts.html#seed-importer-add-global"/> - <keyword type="function" name="seed_importer_set_search_path ()" link="seed-Contexts.html#seed-importer-set-search-path"/> + <keyword type="function" name="seed_make_script ()" link="seed-Evaluation.html#seed-make-script"/> + <keyword type="function" name="seed_evaluate ()" link="seed-Evaluation.html#seed-evaluate"/> + <keyword type="function" name="seed_simple_evaluate ()" link="seed-Evaluation.html#seed-simple-evaluate"/> + <keyword type="function" name="seed_script_new_from_file ()" link="seed-Evaluation.html#seed-script-new-from-file"/> + <keyword type="function" name="seed_script_exception ()" link="seed-Evaluation.html#seed-script-exception"/> + <keyword type="function" name="seed_script_destroy ()" link="seed-Evaluation.html#seed-script-destroy"/> <keyword type="struct" name="SeedScript" link="seed-Evaluation.html#SeedScript"/> - <keyword type="function" name="seed_make_script ()" link="seed-Evaluation.html#seed-make-script"/> - <keyword type="function" name="seed_evaluate ()" link="seed-Evaluation.html#seed-evaluate"/> - <keyword type="function" name="seed_simple_evaluate ()" link="seed-Evaluation.html#seed-simple-evaluate"/> - <keyword type="function" name="seed_script_new_from_file ()" link="seed-Evaluation.html#seed-script-new-from-file"/> - <keyword type="function" name="seed_script_exception ()" link="seed-Evaluation.html#seed-script-exception"/> - <keyword type="function" name="seed_script_destroy ()" link="seed-Evaluation.html#seed-script-destroy"/> + <keyword type="function" name="seed_make_exception ()" link="seed-Exceptions.html#seed-make-exception"/> + <keyword type="function" name="seed_exception_get_name ()" link="seed-Exceptions.html#seed-exception-get-name"/> + <keyword type="function" name="seed_exception_get_message ()" link="seed-Exceptions.html#seed-exception-get-message"/> + <keyword type="function" name="seed_exception_get_line ()" link="seed-Exceptions.html#seed-exception-get-line"/> + <keyword type="function" name="seed_exception_get_file ()" link="seed-Exceptions.html#seed-exception-get-file"/> + <keyword type="function" name="seed_exception_to_string ()" link="seed-Exceptions.html#seed-exception-to-string"/> <keyword type="typedef" name="SeedException" link="seed-Exceptions.html#SeedException"/> - <keyword type="function" name="seed_make_exception ()" link="seed-Exceptions.html#seed-make-exception"/> - <keyword type="function" name="seed_exception_get_name ()" link="seed-Exceptions.html#seed-exception-get-name"/> - <keyword type="function" name="seed_exception_get_message ()" link="seed-Exceptions.html#seed-exception-get-message"/> - <keyword type="function" name="seed_exception_get_line ()" link="seed-Exceptions.html#seed-exception-get-line"/> - <keyword type="function" name="seed_exception_get_file ()" link="seed-Exceptions.html#seed-exception-get-file"/> - <keyword type="function" name="seed_exception_to_string ()" link="seed-Exceptions.html#seed-exception-to-string"/> - <keyword type="function" name="seed_signal_connect ()" link="seed-Signals.html#seed-signal-connect"/> - <keyword type="function" name="seed_signal_connect_value ()" link="seed-Signals.html#seed-signal-connect-value"/> + <keyword type="function" name="seed_signal_connect ()" link="seed-Signals.html#seed-signal-connect"/> + <keyword type="function" name="seed_signal_connect_value ()" link="seed-Signals.html#seed-signal-connect-value"/> + <keyword type="function" name="seed_make_undefined ()" link="seed-Native-Type-Conversion.html#seed-make-undefined"/> + <keyword type="function" name="seed_make_null ()" link="seed-Native-Type-Conversion.html#seed-make-null"/> + <keyword type="function" name="seed_value_to_boolean ()" link="seed-Native-Type-Conversion.html#seed-value-to-boolean"/> + <keyword type="function" name="seed_value_from_boolean ()" link="seed-Native-Type-Conversion.html#seed-value-from-boolean"/> + <keyword type="function" name="seed_value_to_uint ()" link="seed-Native-Type-Conversion.html#seed-value-to-uint"/> + <keyword type="function" name="seed_value_from_uint ()" link="seed-Native-Type-Conversion.html#seed-value-from-uint"/> + <keyword type="function" name="seed_value_to_int ()" link="seed-Native-Type-Conversion.html#seed-value-to-int"/> + <keyword type="function" name="seed_value_from_int ()" link="seed-Native-Type-Conversion.html#seed-value-from-int"/> + <keyword type="function" name="seed_value_to_char ()" link="seed-Native-Type-Conversion.html#seed-value-to-char"/> + <keyword type="function" name="seed_value_from_char ()" link="seed-Native-Type-Conversion.html#seed-value-from-char"/> + <keyword type="function" name="seed_value_to_uchar ()" link="seed-Native-Type-Conversion.html#seed-value-to-uchar"/> + <keyword type="function" name="seed_value_from_uchar ()" link="seed-Native-Type-Conversion.html#seed-value-from-uchar"/> + <keyword type="function" name="seed_value_to_long ()" link="seed-Native-Type-Conversion.html#seed-value-to-long"/> + <keyword type="function" name="seed_value_from_long ()" link="seed-Native-Type-Conversion.html#seed-value-from-long"/> + <keyword type="function" name="seed_value_to_ulong ()" link="seed-Native-Type-Conversion.html#seed-value-to-ulong"/> + <keyword type="function" name="seed_value_from_ulong ()" link="seed-Native-Type-Conversion.html#seed-value-from-ulong"/> + <keyword type="function" name="seed_value_to_int64 ()" link="seed-Native-Type-Conversion.html#seed-value-to-int64"/> + <keyword type="function" name="seed_value_from_int64 ()" link="seed-Native-Type-Conversion.html#seed-value-from-int64"/> + <keyword type="function" name="seed_value_to_uint64 ()" link="seed-Native-Type-Conversion.html#seed-value-to-uint64"/> + <keyword type="function" name="seed_value_from_uint64 ()" link="seed-Native-Type-Conversion.html#seed-value-from-uint64"/> + <keyword type="function" name="seed_value_to_float ()" link="seed-Native-Type-Conversion.html#seed-value-to-float"/> + <keyword type="function" name="seed_value_from_float ()" link="seed-Native-Type-Conversion.html#seed-value-from-float"/> + <keyword type="function" name="seed_value_to_double ()" link="seed-Native-Type-Conversion.html#seed-value-to-double"/> + <keyword type="function" name="seed_value_from_double ()" link="seed-Native-Type-Conversion.html#seed-value-from-double"/> + <keyword type="function" name="seed_value_to_string ()" link="seed-Native-Type-Conversion.html#seed-value-to-string"/> + <keyword type="function" name="seed_value_from_string ()" link="seed-Native-Type-Conversion.html#seed-value-from-string"/> + <keyword type="function" name="seed_value_from_binary_string ()" link="seed-Native-Type-Conversion.html#seed-value-from-binary-string"/> + <keyword type="function" name="seed_value_to_object ()" link="seed-Native-Type-Conversion.html#seed-value-to-object"/> + <keyword type="function" name="seed_value_from_object ()" link="seed-Native-Type-Conversion.html#seed-value-from-object"/> + <keyword type="function" name="seed_value_to_filename ()" link="seed-Native-Type-Conversion.html#seed-value-to-filename"/> + <keyword type="function" name="seed_value_from_filename ()" link="seed-Native-Type-Conversion.html#seed-value-from-filename"/> + <keyword type="function" name="seed_value_to_format ()" link="seed-Native-Type-Conversion.html#seed-value-to-format"/> + <keyword type="function" name="seed_pointer_get_pointer ()" link="seed-Native-Type-Conversion.html#seed-pointer-get-pointer"/> + <keyword type="function" name="seed_make_pointer ()" link="seed-Native-Type-Conversion.html#seed-make-pointer"/> + <keyword type="function" name="seed_string_ref ()" link="seed-Native-Type-Conversion.html#seed-string-ref"/> + <keyword type="function" name="seed_string_unref ()" link="seed-Native-Type-Conversion.html#seed-string-unref"/> + <keyword type="function" name="seed_string_get_maximum_size ()" link="seed-Native-Type-Conversion.html#seed-string-get-maximum-size"/> + <keyword type="function" name="seed_string_to_utf8_buffer ()" link="seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer"/> + <keyword type="function" name="seed_string_is_equal ()" link="seed-Native-Type-Conversion.html#seed-string-is-equal"/> + <keyword type="function" name="seed_string_is_equal_utf8 ()" link="seed-Native-Type-Conversion.html#seed-string-is-equal-utf8"/> <keyword type="typedef" name="SeedValue" link="seed-Native-Type-Conversion.html#SeedValue"/> <keyword type="enum" name="enum SeedType" link="seed-Native-Type-Conversion.html#SeedType"/> - <keyword type="function" name="seed_make_undefined ()" link="seed-Native-Type-Conversion.html#seed-make-undefined"/> - <keyword type="function" name="seed_make_null ()" link="seed-Native-Type-Conversion.html#seed-make-null"/> - <keyword type="function" name="seed_value_to_boolean ()" link="seed-Native-Type-Conversion.html#seed-value-to-boolean"/> - <keyword type="function" name="seed_value_from_boolean ()" link="seed-Native-Type-Conversion.html#seed-value-from-boolean"/> - <keyword type="function" name="seed_value_to_uint ()" link="seed-Native-Type-Conversion.html#seed-value-to-uint"/> - <keyword type="function" name="seed_value_from_uint ()" link="seed-Native-Type-Conversion.html#seed-value-from-uint"/> - <keyword type="function" name="seed_value_to_int ()" link="seed-Native-Type-Conversion.html#seed-value-to-int"/> - <keyword type="function" name="seed_value_from_int ()" link="seed-Native-Type-Conversion.html#seed-value-from-int"/> - <keyword type="function" name="seed_value_to_char ()" link="seed-Native-Type-Conversion.html#seed-value-to-char"/> - <keyword type="function" name="seed_value_from_char ()" link="seed-Native-Type-Conversion.html#seed-value-from-char"/> - <keyword type="function" name="seed_value_to_uchar ()" link="seed-Native-Type-Conversion.html#seed-value-to-uchar"/> - <keyword type="function" name="seed_value_from_uchar ()" link="seed-Native-Type-Conversion.html#seed-value-from-uchar"/> - <keyword type="function" name="seed_value_to_long ()" link="seed-Native-Type-Conversion.html#seed-value-to-long"/> - <keyword type="function" name="seed_value_from_long ()" link="seed-Native-Type-Conversion.html#seed-value-from-long"/> - <keyword type="function" name="seed_value_to_ulong ()" link="seed-Native-Type-Conversion.html#seed-value-to-ulong"/> - <keyword type="function" name="seed_value_from_ulong ()" link="seed-Native-Type-Conversion.html#seed-value-from-ulong"/> - <keyword type="function" name="seed_value_to_int64 ()" link="seed-Native-Type-Conversion.html#seed-value-to-int64"/> - <keyword type="function" name="seed_value_from_int64 ()" link="seed-Native-Type-Conversion.html#seed-value-from-int64"/> - <keyword type="function" name="seed_value_to_uint64 ()" link="seed-Native-Type-Conversion.html#seed-value-to-uint64"/> - <keyword type="function" name="seed_value_from_uint64 ()" link="seed-Native-Type-Conversion.html#seed-value-from-uint64"/> - <keyword type="function" name="seed_value_to_float ()" link="seed-Native-Type-Conversion.html#seed-value-to-float"/> - <keyword type="function" name="seed_value_from_float ()" link="seed-Native-Type-Conversion.html#seed-value-from-float"/> - <keyword type="function" name="seed_value_to_double ()" link="seed-Native-Type-Conversion.html#seed-value-to-double"/> - <keyword type="function" name="seed_value_from_double ()" link="seed-Native-Type-Conversion.html#seed-value-from-double"/> - <keyword type="function" name="seed_value_to_string ()" link="seed-Native-Type-Conversion.html#seed-value-to-string"/> - <keyword type="function" name="seed_value_from_string ()" link="seed-Native-Type-Conversion.html#seed-value-from-string"/> - <keyword type="function" name="seed_value_from_binary_string ()" link="seed-Native-Type-Conversion.html#seed-value-from-binary-string"/> - <keyword type="function" name="seed_value_to_object ()" link="seed-Native-Type-Conversion.html#seed-value-to-object"/> - <keyword type="function" name="seed_value_from_object ()" link="seed-Native-Type-Conversion.html#seed-value-from-object"/> - <keyword type="function" name="seed_value_to_filename ()" link="seed-Native-Type-Conversion.html#seed-value-to-filename"/> - <keyword type="function" name="seed_value_from_filename ()" link="seed-Native-Type-Conversion.html#seed-value-from-filename"/> - <keyword type="function" name="seed_value_to_format ()" link="seed-Native-Type-Conversion.html#seed-value-to-format"/> - <keyword type="function" name="seed_pointer_get_pointer ()" link="seed-Native-Type-Conversion.html#seed-pointer-get-pointer"/> - <keyword type="function" name="seed_make_pointer ()" link="seed-Native-Type-Conversion.html#seed-make-pointer"/> <keyword type="typedef" name="SeedString" link="seed-Native-Type-Conversion.html#SeedString"/> - <keyword type="function" name="seed_string_ref ()" link="seed-Native-Type-Conversion.html#seed-string-ref"/> - <keyword type="function" name="seed_string_unref ()" link="seed-Native-Type-Conversion.html#seed-string-unref"/> - <keyword type="function" name="seed_string_get_maximum_size ()" link="seed-Native-Type-Conversion.html#seed-string-get-maximum-size"/> - <keyword type="function" name="seed_string_to_utf8_buffer ()" link="seed-Native-Type-Conversion.html#seed-string-to-utf8-buffer"/> - <keyword type="function" name="seed_string_is_equal ()" link="seed-Native-Type-Conversion.html#seed-string-is-equal"/> - <keyword type="function" name="seed_string_is_equal_utf8 ()" link="seed-Native-Type-Conversion.html#seed-string-is-equal-utf8"/> - <keyword type="function" name="seed_value_unprotect ()" link="seed-Operating-on-Native-Types.html#seed-value-unprotect"/> - <keyword type="function" name="seed_value_protect ()" link="seed-Operating-on-Native-Types.html#seed-value-protect"/> - <keyword type="function" name="seed_value_is_undefined ()" link="seed-Operating-on-Native-Types.html#seed-value-is-undefined"/> - <keyword type="function" name="seed_value_is_null ()" link="seed-Operating-on-Native-Types.html#seed-value-is-null"/> - <keyword type="function" name="seed_value_is_function ()" link="seed-Operating-on-Native-Types.html#seed-value-is-function"/> - <keyword type="function" name="seed_value_is_number ()" link="seed-Operating-on-Native-Types.html#seed-value-is-number"/> - <keyword type="function" name="seed_value_is_string ()" link="seed-Operating-on-Native-Types.html#seed-value-is-string"/> - <keyword type="function" name="seed_value_is_object_of_class ()" link="seed-Operating-on-Native-Types.html#seed-value-is-object-of-class"/> - <keyword type="function" name="seed_value_is_object ()" link="seed-Operating-on-Native-Types.html#seed-value-is-object"/> - <keyword type="function" name="seed_value_get_type ()" link="seed-Operating-on-Native-Types.html#seed-value-get-type"/> + <keyword type="function" name="seed_value_unprotect ()" link="seed-Operating-on-Native-Types.html#seed-value-unprotect"/> + <keyword type="function" name="seed_value_protect ()" link="seed-Operating-on-Native-Types.html#seed-value-protect"/> + <keyword type="function" name="seed_value_is_undefined ()" link="seed-Operating-on-Native-Types.html#seed-value-is-undefined"/> + <keyword type="function" name="seed_value_is_null ()" link="seed-Operating-on-Native-Types.html#seed-value-is-null"/> + <keyword type="function" name="seed_value_is_function ()" link="seed-Operating-on-Native-Types.html#seed-value-is-function"/> + <keyword type="function" name="seed_value_is_number ()" link="seed-Operating-on-Native-Types.html#seed-value-is-number"/> + <keyword type="function" name="seed_value_is_string ()" link="seed-Operating-on-Native-Types.html#seed-value-is-string"/> + <keyword type="function" name="seed_value_is_object_of_class ()" link="seed-Operating-on-Native-Types.html#seed-value-is-object-of-class"/> + <keyword type="function" name="seed_value_is_object ()" link="seed-Operating-on-Native-Types.html#seed-value-is-object"/> + <keyword type="function" name="seed_value_get_type ()" link="seed-Operating-on-Native-Types.html#seed-value-get-type"/> + <keyword type="function" name="seed_make_object ()" link="seed-JS-Objects.html#seed-make-object"/> + <keyword type="function" name="seed_make_array ()" link="seed-JS-Objects.html#seed-make-array"/> + <keyword type="function" name="seed_object_call ()" link="seed-JS-Objects.html#seed-object-call"/> + <keyword type="function" name="seed_object_set_property_at_index ()" link="seed-JS-Objects.html#seed-object-set-property-at-index"/> + <keyword type="function" name="seed_object_get_property_at_index ()" link="seed-JS-Objects.html#seed-object-get-property-at-index"/> + <keyword type="function" name="seed_object_is_of_class ()" link="seed-JS-Objects.html#seed-object-is-of-class"/> + <keyword type="function" name="seed_object_get_private ()" link="seed-JS-Objects.html#seed-object-get-private"/> + <keyword type="function" name="seed_object_set_private ()" link="seed-JS-Objects.html#seed-object-set-private"/> + <keyword type="function" name="seed_object_get_property ()" link="seed-JS-Objects.html#seed-object-get-property"/> + <keyword type="function" name="seed_object_set_property ()" link="seed-JS-Objects.html#seed-object-set-property"/> + <keyword type="function" name="seed_object_get_prototype ()" link="seed-JS-Objects.html#seed-object-get-prototype"/> + <keyword type="function" name="seed_object_copy_property_names ()" link="seed-JS-Objects.html#seed-object-copy-property-names"/> + <keyword type="function" name="SeedObjectInitializeCallback ()" link="seed-JS-Objects.html#SeedObjectInitializeCallback"/> + <keyword type="function" name="SeedObjectFinalizeCallback ()" link="seed-JS-Objects.html#SeedObjectFinalizeCallback"/> + <keyword type="function" name="SeedObjectHasPropertyCallback ()" link="seed-JS-Objects.html#SeedObjectHasPropertyCallback"/> + <keyword type="function" name="SeedObjectGetPropertyCallback ()" link="seed-JS-Objects.html#SeedObjectGetPropertyCallback"/> + <keyword type="function" name="SeedObjectSetPropertyCallback ()" link="seed-JS-Objects.html#SeedObjectSetPropertyCallback"/> + <keyword type="function" name="SeedObjectDeletePropertyCallback ()" link="seed-JS-Objects.html#SeedObjectDeletePropertyCallback"/> + <keyword type="function" name="SeedObjectGetPropertyNamesCallback ()" link="seed-JS-Objects.html#SeedObjectGetPropertyNamesCallback"/> + <keyword type="function" name="SeedObjectCallAsFunctionCallback ()" link="seed-JS-Objects.html#SeedObjectCallAsFunctionCallback"/> + <keyword type="function" name="SeedObjectHasInstanceCallback ()" link="seed-JS-Objects.html#SeedObjectHasInstanceCallback"/> + <keyword type="function" name="SeedObjectConvertToTypeCallback ()" link="seed-JS-Objects.html#SeedObjectConvertToTypeCallback"/> + <keyword type="function" name="SeedObjectCallAsConstructorCallback ()" link="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback"/> <keyword type="typedef" name="SeedObject" link="seed-JS-Objects.html#SeedObject"/> - <keyword type="function" name="seed_make_object ()" link="seed-JS-Objects.html#seed-make-object"/> - <keyword type="function" name="seed_make_array ()" link="seed-JS-Objects.html#seed-make-array"/> - <keyword type="function" name="seed_object_call ()" link="seed-JS-Objects.html#seed-object-call"/> - <keyword type="function" name="seed_object_set_property_at_index ()" link="seed-JS-Objects.html#seed-object-set-property-at-index"/> - <keyword type="function" name="seed_object_get_property_at_index ()" link="seed-JS-Objects.html#seed-object-get-property-at-index"/> - <keyword type="function" name="seed_object_is_of_class ()" link="seed-JS-Objects.html#seed-object-is-of-class"/> - <keyword type="function" name="seed_object_get_private ()" link="seed-JS-Objects.html#seed-object-get-private"/> - <keyword type="function" name="seed_object_set_private ()" link="seed-JS-Objects.html#seed-object-set-private"/> - <keyword type="function" name="seed_object_get_property ()" link="seed-JS-Objects.html#seed-object-get-property"/> - <keyword type="function" name="seed_object_set_property ()" link="seed-JS-Objects.html#seed-object-set-property"/> - <keyword type="function" name="seed_object_get_prototype ()" link="seed-JS-Objects.html#seed-object-get-prototype"/> - <keyword type="function" name="seed_object_copy_property_names ()" link="seed-JS-Objects.html#seed-object-copy-property-names"/> - <keyword type="function" name="SeedObjectInitializeCallback ()" link="seed-JS-Objects.html#SeedObjectInitializeCallback"/> - <keyword type="function" name="SeedObjectFinalizeCallback ()" link="seed-JS-Objects.html#SeedObjectFinalizeCallback"/> - <keyword type="function" name="SeedObjectHasPropertyCallback ()" link="seed-JS-Objects.html#SeedObjectHasPropertyCallback"/> - <keyword type="function" name="SeedObjectGetPropertyCallback ()" link="seed-JS-Objects.html#SeedObjectGetPropertyCallback"/> - <keyword type="function" name="SeedObjectSetPropertyCallback ()" link="seed-JS-Objects.html#SeedObjectSetPropertyCallback"/> - <keyword type="function" name="SeedObjectDeletePropertyCallback ()" link="seed-JS-Objects.html#SeedObjectDeletePropertyCallback"/> - <keyword type="function" name="SeedObjectGetPropertyNamesCallback ()" link="seed-JS-Objects.html#SeedObjectGetPropertyNamesCallback"/> - <keyword type="function" name="SeedObjectCallAsFunctionCallback ()" link="seed-JS-Objects.html#SeedObjectCallAsFunctionCallback"/> - <keyword type="function" name="SeedObjectHasInstanceCallback ()" link="seed-JS-Objects.html#SeedObjectHasInstanceCallback"/> - <keyword type="function" name="SeedObjectConvertToTypeCallback ()" link="seed-JS-Objects.html#SeedObjectConvertToTypeCallback"/> - <keyword type="function" name="SeedObjectCallAsConstructorCallback ()" link="seed-JS-Objects.html#SeedObjectCallAsConstructorCallback"/> - <keyword type="function" name="SeedFunctionCallback ()" link="seed-Native-Functions.html#SeedFunctionCallback"/> - <keyword type="function" name="seed_make_function ()" link="seed-Native-Functions.html#seed-make-function"/> - <keyword type="function" name="seed_create_function ()" link="seed-Native-Functions.html#seed-create-function"/> + <keyword type="function" name="SeedFunctionCallback ()" link="seed-Native-Functions.html#SeedFunctionCallback"/> + <keyword type="function" name="seed_make_function ()" link="seed-Native-Functions.html#seed-make-function"/> + <keyword type="function" name="seed_create_function ()" link="seed-Native-Functions.html#seed-create-function"/> + <keyword type="function" name="seed_create_class ()" link="seed-JavaScript-Classes.html#seed-create-class"/> + <keyword type="function" name="seed_make_constructor ()" link="seed-JavaScript-Classes.html#seed-make-constructor"/> <keyword type="enum" name="enum SeedPropertyAttributes" link="seed-JavaScript-Classes.html#SeedPropertyAttributes"/> <keyword type="enum" name="enum SeedClassAttributes" link="seed-JavaScript-Classes.html#SeedClassAttributes"/> <keyword type="typedef" name="SeedClass" link="seed-JavaScript-Classes.html#SeedClass"/> <keyword type="macro" name="seed_empty_class" link="seed-JavaScript-Classes.html#seed-empty-class"/> - <keyword type="function" name="seed_create_class ()" link="seed-JavaScript-Classes.html#seed-create-class"/> - <keyword type="function" name="seed_make_constructor ()" link="seed-JavaScript-Classes.html#seed-make-constructor"/> + <keyword type="function" name="seed_closure_new ()" link="seed-SeedClosure.html#seed-closure-new"/> + <keyword type="function" name="seed_closure_get_callable ()" link="seed-SeedClosure.html#seed-closure-get-callable"/> + <keyword type="function" name="seed_closure_invoke ()" link="seed-SeedClosure.html#seed-closure-invoke"/> + <keyword type="function" name="seed_closure_invoke_with_context ()" link="seed-SeedClosure.html#seed-closure-invoke-with-context"/> + <keyword type="function" name="seed_closure_warn_exception ()" link="seed-SeedClosure.html#seed-closure-warn-exception"/> <keyword type="struct" name="struct SeedClosure" link="seed-SeedClosure.html#SeedClosure"/> - <keyword type="function" name="seed_closure_new ()" link="seed-SeedClosure.html#seed-closure-new"/> - <keyword type="function" name="seed_closure_get_callable ()" link="seed-SeedClosure.html#seed-closure-get-callable"/> - <keyword type="function" name="seed_closure_invoke ()" link="seed-SeedClosure.html#seed-closure-invoke"/> - <keyword type="function" name="seed_closure_invoke_with_context ()" link="seed-SeedClosure.html#seed-closure-invoke-with-context"/> - <keyword type="function" name="seed_closure_warn_exception ()" link="seed-SeedClosure.html#seed-closure-warn-exception"/> <keyword type="macro" name="CHECK_ARG_COUNT()" link="seed-Modules.html#CHECK-ARG-COUNT:CAPS"/> <keyword type="macro" name="DEFINE_ENUM_MEMBER()" link="seed-Modules.html#DEFINE-ENUM-MEMBER:CAPS"/> <keyword type="macro" name="DEFINE_ENUM_MEMBER_EXT()" link="seed-Modules.html#DEFINE-ENUM-MEMBER-EXT:CAPS"/> - <keyword type="function" name="SeedModuleInitCallback ()" link="seed-Modules.html#SeedModuleInitCallback"/> + <keyword type="function" name="SeedModuleInitCallback ()" link="seed-Modules.html#SeedModuleInitCallback"/> <keyword type="function" name="readline.readline (prompt)" link="readline-module.html#readline-readline"/> <keyword type="function" name="readline.bind (key, function)" link="readline-module.html#readline-bind"/> <keyword type="function" name="readline.done ()" link="readline-module.html#readline-done"/> @@ -177,5 +176,17 @@ <keyword type="function" name="context.add_globals()" link="Sandbox-module.html#sandbox-addglobals"/> <keyword type="function" name="context.destroy()" link="Sandbox-module.html#sandbox-destroy"/> <keyword type="function" name="context.global" link="Sandbox-module.html#sandbox-global"/> + <keyword type="constant" name="SEED_TYPE_UNDEFINED" link="seed-Native-Type-Conversion.html#SEED-TYPE-UNDEFINED:CAPS"/> + <keyword type="constant" name="SEED_TYPE_NULL" link="seed-Native-Type-Conversion.html#SEED-TYPE-NULL:CAPS"/> + <keyword type="constant" name="SEED_TYPE_BOOLEAN" link="seed-Native-Type-Conversion.html#SEED-TYPE-BOOLEAN:CAPS"/> + <keyword type="constant" name="SEED_TYPE_NUMBER" link="seed-Native-Type-Conversion.html#SEED-TYPE-NUMBER:CAPS"/> + <keyword type="constant" name="SEED_TYPE_STRING" link="seed-Native-Type-Conversion.html#SEED-TYPE-STRING:CAPS"/> + <keyword type="constant" name="SEED_TYPE_OBJECT" link="seed-Native-Type-Conversion.html#SEED-TYPE-OBJECT:CAPS"/> + <keyword type="constant" name="SEED_PROPERTY_ATTRIBUTE_NONE" link="seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-NONE:CAPS"/> + <keyword type="constant" name="SEED_PROPERTY_ATTRIBUTE_READ_ONLY" link="seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-READ-ONLY:CAPS"/> + <keyword type="constant" name="SEED_PROPERTY_ATTRIBUTE_DONT_ENUM" link="seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-DONT-ENUM:CAPS"/> + <keyword type="constant" name="SEED_PROPERTY_ATTRIBUTE_DONT_DELETE" link="seed-JavaScript-Classes.html#SEED-PROPERTY-ATTRIBUTE-DONT-DELETE:CAPS"/> + <keyword type="constant" name="SEED_CLASS_ATTRIBUTE_NONE" link="seed-JavaScript-Classes.html#SEED-CLASS-ATTRIBUTE-NONE:CAPS"/> + <keyword type="constant" name="SEED_CLASS_ATTRIBUTE_NO_SHARED_PROTOTYPE" link="seed-JavaScript-Classes.html#SEED-CLASS-ATTRIBUTE-NO-SHARED-PROTOTYPE:CAPS"/> </functions> </book> diff --git a/doc/reference/html/seed.html b/doc/reference/html/seed.html index 8ba56b2..c201077 100644 --- a/doc/reference/html/seed.html +++ b/doc/reference/html/seed.html @@ -2,29 +2,29 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Part I. Seed Overview</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Part I. Seed Overview: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="index.html" title="Seed Reference Manual"> <link rel="prev" href="index.html" title="Seed Reference Manual"> <link rel="next" href="seed-introduction.html" title="Introduction"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td> </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-introduction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> +<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-introduction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="part"> <div class="titlepage"><div><div><h1 class="title"> <a name="seed"></a>Part I. Seed Overview</h1></div></div></div> <div class="toc"> <p><b>Table of Contents</b></p> -<dl> +<dl class="toc"> <dt> <span class="refentrytitle"><a href="seed-introduction.html">Introduction</a></span><span class="refpurpose"> — What Seed is all about @@ -44,7 +44,6 @@ Where to find help, ask questions, or bring patches </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/sqlite-module.html b/doc/reference/html/sqlite-module.html index 7aa6d31..f0711dc 100644 --- a/doc/reference/html/sqlite-module.html +++ b/doc/reference/html/sqlite-module.html @@ -2,22 +2,22 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SQLite</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>SQLite: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="Seed Reference Manual"> <link rel="up" href="modules.html" title="Part IV. Seed Module Reference"> <link rel="prev" href="readline-module.html" title="readline"> <link rel="next" href="GtkBuilder-module.html" title="GtkBuilder"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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="readline-module.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="modules.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="GtkBuilder-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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="modules.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="readline-module.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GtkBuilder-module.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div> @@ -33,7 +33,7 @@ </div></div> </div></div> <div class="refsect1"> -<a name="idp9619168"></a><h2>API Reference</h2> +<a name="id-1.5.4.3"></a><h2>API Reference</h2> <p> The sqlite module allows for manipulation and querying of sqlite databases. </p> @@ -56,8 +56,11 @@ sqlite.[OK, ERROR, INTERNAL, PERM ABORT, BUSY, <div class="refsect2"> <a name="sqlite-database"></a><h3>new sqlite.Database(filename)</h3> <p>Constructs a new sqlite.Database</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>filename</code></em></span></p></td> @@ -77,8 +80,11 @@ sqlite.[OK, ERROR, INTERNAL, PERM ABORT, BUSY, <a name="sqlite-exec"></a><h3>database.exec(command, callback)</h3> <p>Executes the SQLite <em class="parameter"><code>command</code></em> on the given database. If <em class="parameter"><code>callback</code></em> is defined, it is called with each table entry from the given command, with a single argument. The argument has properties for each value in the returned table entry.</p> <p>Keep in mind that, just like in C, it is necessary to sanitize user input in your SQL before passing it to the database.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>command</code></em></span></p></td> @@ -106,7 +112,7 @@ sqlite.[OK, ERROR, INTERNAL, PERM ABORT, BUSY, </p> </div> <div class="refsect1"> -<a name="idp6699632"></a><h2>Examples</h2> +<a name="id-1.5.4.4"></a><h2>Examples</h2> <p>Below are several examples of using the Seed sqlite module. For additional resources, consult the examples/ folder of the Seed source</p> <div class="example"> <a name="readline-repl-example"></a><p class="title"><b>Example 15. </b></p> @@ -133,7 +139,6 @@ db.close(); </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/style.css b/doc/reference/html/style.css index d6f6c26..3675420 100644 --- a/doc/reference/html/style.css +++ b/doc/reference/html/style.css @@ -1,15 +1,23 @@ +body +{ + font-family: cantarell, sans-serif; +} .synopsis, .classsynopsis { /* tango:aluminium 1/2 */ background: #eeeeec; - border: solid 1px #d3d7cf; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); padding: 0.5em; } .programlisting { /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ background: #e6f3ff; border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); padding: 0.5em; } .variablelist @@ -22,89 +30,6 @@ vertical-align: top; } -@media screen { - sup a.footnote - { - position: relative; - top: 0em ! important; - - } - /* this is needed so that the local anchors are displayed below the naviagtion */ - div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] - { - display: inline-block; - position: relative; - top:-5em; - } - /* this seems to be a bug in the xsl style sheets when generating indexes */ - div.index div.index - { - top: 0em; - } - /* make space for the fixed navigation bar and add space at the bottom so that - * link targets appear somewhat close to top - */ - body - { - padding-top: 3.2em; - padding-bottom: 20em; - } - /* style and size the navigation bar */ - table.navigation#top - { - position: fixed; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - z-index: 10; - } - .navigation a, .navigation a:visited - { - /* tango:scarlet red 3 */ - color: #a40000; - } - .navigation a:hover - { - /* tango:scarlet red 1 */ - color: #ef2929; - } - td.shortcuts - { - /* tango:scarlet red 1 */ - color: #ef2929; - font-size: 80%; - white-space: nowrap; - } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - /* tango:scarlet red 0/1 */ - background: #ffe6e6; - border: solid 1px #ef2929; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - } -} - -.navigation .title -{ - font-size: 200%; -} - div.gallery-float { float: left; @@ -132,6 +57,72 @@ a:hover color: #729fcf; } +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + div.table table { border-collapse: collapse; @@ -154,14 +145,44 @@ div.table table th background-color: #d3d7cf; } +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + hr { - /* tango:aluminium 3 */ - color: #babdb6; - background: #babdb6; + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; border: none 0px; height: 1px; clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; } .footer @@ -173,31 +194,70 @@ hr font-size: 80%; } +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + .warning { /* tango:orange 0/1 */ background: #ffeed9; + background: rgba(252, 175, 62, 0.1); border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); } .note { /* tango:chameleon 0/0.5 */ background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); } -.note, .warning +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote { padding: 0.5em; border-width: 1px; border-style: solid; + margin: 2em; } -.note h3, .warning h3 +.note p, .warning p { - margin-top: 0.0em + margin: 0; } -.note p, .warning p + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section { - margin-bottom: 0.0em + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; } /* blob links */ @@ -210,33 +270,52 @@ h2 .extralinks, h3 .extralinks font-weight: normal; } +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + .annotation { /* tango:aluminium 5 */ color: #555753; - font-size: 80%; font-weight: normal; } +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + /* code listings */ -.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ -.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ -.listing_code .programlisting .function { color: #000000; font-weight: bold; } -.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ -.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .normal, +.listing_code .programlisting .normal a, +.listing_code .programlisting .number, +.listing_code .programlisting .cbracket, +.listing_code .programlisting .symbol { color: #555753; } +.listing_code .programlisting .comment, .listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ -.listing_code .programlisting .normal { color: #000000; } -.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .function, +.listing_code .programlisting .function a, .listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ -.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ -.listing_code .programlisting .type { color: #000000; } -.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ -.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ +.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */ +.listing_code .programlisting .keyword, +.listing_code .programlisting .usertype, +.listing_code .programlisting .type, +.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */ .listing_frame { /* tango:sky blue 1 */ border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); padding: 0px; } @@ -248,19 +327,153 @@ h2 .extralinks, h3 .extralinks .listing_lines { /* tango:sky blue 0.5 */ background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); /* tango:aluminium 6 */ color: #2e3436; } .listing_code { /* tango:sky blue 0 */ background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); } .listing_code .programlisting { /* override from previous */ border: none 0px; padding: 0px; + background: none; } .listing_lines pre, .listing_code pre { margin: 0px; } +@media screen { + /* these have a <sup> as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + diff --git a/doc/reference/html/types.html b/doc/reference/html/types.html index 418d514..51b4c68 100644 --- a/doc/reference/html/types.html +++ b/doc/reference/html/types.html @@ -2,27 +2,27 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Values and Type Conversion</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<title>Values and Type Conversion: Seed Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-Signals.html" title="GObject Signals"> <link rel="next" href="seed-Native-Type-Conversion.html" title="Type Conversion"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (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-Signals.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-Native-Type-Conversion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"></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-Signals.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="seed-Native-Type-Conversion.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> <a name="types"></a>Values and Type Conversion</h2></div></div></div> -<div class="toc"><dl> +<div class="toc"><dl class="toc"> <dt> <span class="refentrytitle"><a href="seed-Native-Type-Conversion.html">Type Conversion</a></span><span class="refpurpose"> — Moving between JavaScript and C intrinsic types</span> </dt> @@ -35,7 +35,6 @@ </dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file diff --git a/doc/reference/html/up-insensitive.png b/doc/reference/html/up-insensitive.png Binary files differnew file mode 100644 index 0000000..f404986 --- /dev/null +++ b/doc/reference/html/up-insensitive.png diff --git a/doc/reference/html/up.png b/doc/reference/html/up.png Binary files differindex 8eb591f..80b4b37 100644 --- a/doc/reference/html/up.png +++ b/doc/reference/html/up.png |
