swfdec-swfdecasobject.html

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

<td><span class="term"><em class="parameter"><code>default_flags</code></em>&#160;:</span></td>
<td> flags to use if creating the variable anew - the flags will
                be ignored if the property already exists.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627359"></a><h3>
<a name="swfdec-as-object-add-variable"></a>swfdec_as_object_add_variable ()</h3>
<a class="indexterm" name="id2627371"></a><pre class="programlisting">void                swfdec_as_object_add_variable       (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable,
                                                         <a href="swfdec-SwfdecAsFunction.html#SwfdecAsFunction">SwfdecAsFunction</a> *get,
                                                         <a href="swfdec-SwfdecAsFunction.html#SwfdecAsFunction">SwfdecAsFunction</a> *set);</pre>
<p>
Adds a variable to <em class="parameter"><code>object</code></em> in the same way as the Actionscript code 
"object.<code class="function">addProperty()</code>" would do. Accessing the variable will from now on be
handled by calling the <em class="parameter"><code>get</code></em> or <em class="parameter"><code>set</code></em> functions. A previous value of the 
variable or a previous call to this function will be overwritten.</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>variable</code></em>&#160;:</span></td>
<td> name of the variable
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>get</code></em>&#160;:</span></td>
<td> getter function to call when reading the variable
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>set</code></em>&#160;:</span></td>
<td> setter function to call when writing the variable or <code class="literal">NULL</code> if read-only
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627518"></a><h3>
<a name="swfdec-as-object-set-variable-flags"></a>swfdec_as_object_set_variable_flags ()</h3>
<a class="indexterm" name="id2627531"></a><pre class="programlisting">void                swfdec_as_object_set_variable_flags (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable,
                                                         <a href="swfdec-SwfdecAsObject.html#SwfdecAsVariableFlag">SwfdecAsVariableFlag</a> flags);</pre>
<p>
Sets the given flags for the given variable.</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>variable</code></em>&#160;:</span></td>
<td> the variable to modify
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> flags to set
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627621"></a><h3>
<a name="swfdec-as-object-unset-variable-flags"></a>swfdec_as_object_unset_variable_flags ()</h3>
<a class="indexterm" name="id2627634"></a><pre class="programlisting">void                swfdec_as_object_unset_variable_flags
                                                        (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable,
                                                         <a href="swfdec-SwfdecAsObject.html#SwfdecAsVariableFlag">SwfdecAsVariableFlag</a> flags);</pre>
<p>
Unsets the given flags for the given variable. The variable must exist in 
<em class="parameter"><code>object</code></em>.</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>variable</code></em>&#160;:</span></td>
<td> the variable to modify
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> flags to unset
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627731"></a><h3>
<a name="swfdec-as-object-delete-variable"></a>swfdec_as_object_delete_variable ()</h3>
<a class="indexterm" name="id2627743"></a><pre class="programlisting"><a href="swfdec-Enumerations.html#SwfdecAsDeleteReturn">SwfdecAsDeleteReturn</a> swfdec_as_object_delete_variable   (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable);</pre>
<p>
Deletes the given variable if possible. If the variable is protected from 
deletion, it will not be deleted.</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>variable</code></em>&#160;:</span></td>
<td> garbage-collected name of the variable
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> See <span class="type">SwfdecAsDeleteReutnr</span> for details of the return value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627832"></a><h3>
<a name="SwfdecAsVariableForeach"></a>SwfdecAsVariableForeach ()</h3>
<a class="indexterm" name="id2627843"></a><pre class="programlisting">gboolean            (*SwfdecAsVariableForeach)          (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable,
                                                         <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *value,
                                                         guint flags,
                                                         gpointer data);</pre>
<p>
Function prototype for the <a href="swfdec-SwfdecAsObject.html#swfdec-as-object-foreach"><code class="function">swfdec_as_object_foreach()</code></a> function.</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> The object this function is run on
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>variable</code></em>&#160;:</span></td>
<td> garbage-collected name of the current variables
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> value of the current variable
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> Flags associated with the current variable
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> User dta passed to <a href="swfdec-SwfdecAsObject.html#swfdec-as-object-foreach"><code class="function">swfdec_as_object_foreach()</code></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> to continue running the foreach function, <code class="literal">FALSE</code> to stop
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628010"></a><h3>
<a name="swfdec-as-object-foreach"></a>swfdec_as_object_foreach ()</h3>
<a class="indexterm" name="id2628021"></a><pre class="programlisting">gboolean            swfdec_as_object_foreach            (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         <a href="swfdec-SwfdecAsObject.html#SwfdecAsVariableForeach">SwfdecAsVariableForeach</a> func,
                                                         gpointer data);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for every variable of <em class="parameter"><code>object</code></em> or until <em class="parameter"><code>func</code></em> returns <code class="literal">FALSE</code>. The
variables of <em class="parameter"><code>object</code></em> must not be modified by <em class="parameter"><code>func</code></em>.</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>func</code></em>&#160;:</span></td>
<td> function to call
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> data to pass to <em class="parameter"><code>func</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>func</code></em> always returned <code class="literal">TRUE</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628180"></a><h3>
<a name="swfdec-as-object-has-function"></a>swfdec_as_object_has_function ()</h3>
<a class="indexterm" name="id2628192"></a><pre class="programlisting">gboolean            swfdec_as_object_has_function       (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *name);</pre>
<p>
Convenience function that checks of <em class="parameter"><code>object</code></em> has a variable that references 
a function.</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> garbage-collected name of th function
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if object.name is a function.
</td>
</tr>