swfdec-swfdecasobject.html

Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and rendering engine is

</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628289"></a><h3>
<a name="swfdec-as-object-run"></a>swfdec_as_object_run ()</h3>
<a class="indexterm" name="id2628299"></a><pre class="programlisting">void                swfdec_as_object_run                (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         <a href="SwfdecAsDebugger.html#SwfdecScript">SwfdecScript</a> *script);</pre>
<p>
Executes the given <em class="parameter"><code>script</code></em> with <em class="parameter"><code>object</code></em> as this pointer.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject"><span class="type">SwfdecAsObject</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>script</code></em>&#160;:</span></td>
<td> script to execute
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628379"></a><h3>
<a name="swfdec-as-object-call"></a>swfdec_as_object_call ()</h3>
<a class="indexterm" name="id2628389"></a><pre class="programlisting">void                swfdec_as_object_call               (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *name,
                                                         guint argc,
                                                         <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *argv,
                                                         <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *return_value);</pre>
<p>
Calls the function named <em class="parameter"><code>name</code></em> on the given object. This function is 
essentially equal to the folloeing Actionscript code: 
</p>
<div class="informalexample"><pre class="programlisting">
@return_value = @object.@name (@argv[0], ..., @argv[argc-1]);
</pre></div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject"><span class="type">SwfdecAsObject</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> garbage-collected string naming the function to call. 
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></td>
<td> number of arguments to provide to function
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>argv</code></em>&#160;:</span></td>
<td> arguments or <code class="literal">NULL</code> when <em class="parameter"><code>argc</code></em> is 0
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>return_value</code></em>&#160;:</span></td>
<td> location to take the return value of the call or <code class="literal">NULL</code> to 
               ignore the return value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628555"></a><h3>
<a name="swfdec-as-object-add-function"></a>swfdec_as_object_add_function ()</h3>
<a class="indexterm" name="id2628567"></a><pre class="programlisting"><a href="swfdec-SwfdecAsFunction.html#SwfdecAsFunction">SwfdecAsFunction</a>*   swfdec_as_object_add_function       (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *name,
                                                         GType type,
                                                         <a href="swfdec-SwfdecAsFunction.html#SwfdecAsNative">SwfdecAsNative</a> native,
                                                         guint min_args);</pre>
<p>
Adds <em class="parameter"><code>native</code></em> as a variable named <em class="parameter"><code>name</code></em> to <em class="parameter"><code>object</code></em>. The newly added variable
will not be enumerated.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject"><span class="type">SwfdecAsObject</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> name of the function. The string does not have to be 
       garbage-collected.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td> the required type of the this Object to make this function execute.
       May be 0 to accept any type.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>native</code></em>&#160;:</span></td>
<td> a native function or <code class="literal">NULL</code> to just not do anything
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>min_args</code></em>&#160;:</span></td>
<td> minimum number of arguments to pass to <em class="parameter"><code>native</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the newly created <a href="swfdec-SwfdecAsFunction.html#SwfdecAsFunction"><span class="type">SwfdecAsFunction</span></a> or <code class="literal">NULL</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628752"></a><h3>
<a name="swfdec-as-object-add-constructor"></a>swfdec_as_object_add_constructor ()</h3>
<a class="indexterm" name="id2628765"></a><pre class="programlisting"><a href="swfdec-SwfdecAsFunction.html#SwfdecAsFunction">SwfdecAsFunction</a>*   swfdec_as_object_add_constructor    (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *name,
                                                         GType type,
                                                         GType construct_type,
                                                         <a href="swfdec-SwfdecAsFunction.html#SwfdecAsNative">SwfdecAsNative</a> native,
                                                         guint min_args,
                                                         <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *prototype);</pre>
<p>
Adds <em class="parameter"><code>native</code></em> as a constructor named <em class="parameter"><code>name</code></em> to <em class="parameter"><code>object</code></em>. The newly added variable
will not be enumerated.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject"><span class="type">SwfdecAsObject</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> name of the function. The string does not have to be 
       garbage-collected.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td> the required type of the this Object to make this function execute.
       May be 0 to accept any type.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>construct_type</code></em>&#160;:</span></td>
<td> type used when using this function as a constructor. May 
                 be 0 to use the default type.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>native</code></em>&#160;:</span></td>
<td> a native function or <code class="literal">NULL</code> to just not do anything
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>min_args</code></em>&#160;:</span></td>
<td> minimum number of arguments to pass to <em class="parameter"><code>native</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>prototype</code></em>&#160;:</span></td>
<td> An optional object to be set as the "prototype" property of the
            new function. The prototype will be hidden and constant.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the newly created <a href="swfdec-SwfdecAsFunction.html#SwfdecAsFunction"><span class="type">SwfdecAsFunction</span></a> or <code class="literal">NULL</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628993"></a><h3>
<a name="swfdec-as-object-get-debug"></a>swfdec_as_object_get_debug ()</h3>
<a class="indexterm" name="id2629004"></a><pre class="programlisting">char*               swfdec_as_object_get_debug          (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object);</pre>
<p>
Gets a representation string suitable for debugging. This function is 
guaranteed to not modify the state of the script engine, unlike 
<a href="swfdec-SwfdecAsValue.html#swfdec-as-value-to-string"><code class="function">swfdec_as_value_to_string()</code></a> for example.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject"><span class="type">SwfdecAsObject</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A newly allocated string. Free it with <code class="function">g_free()</code> after use.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629092"></a><h3>
<a name="swfdec-as-object-resolve"></a>swfdec_as_object_resolve ()</h3>
<a class="indexterm" name="id2629106"></a><pre class="programlisting"><a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a>*     swfdec_as_object_resolve            (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object);</pre>
<p>
Resolves the object to its real object. Some internal objects should not be
exposed to scripts, for example <a href="swfdec-SwfdecAsFrame.html#SwfdecAsFrame"><span class="type">SwfdecAsFrame</span></a> objects. If an object you want
to expose might be internal, call this function to resolve it to an object
that is safe to expose.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject"><span class="type">SwfdecAsObject</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a non-internal object
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2629187"></a><div class="refsect2" lang="en"><a name="id2629188"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2629189"></a></div>
</div>
</div>
</body>
</html>