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>context</code></em>&#160;:</span></td>
<td> <a href="SwfdecAsContext.html" title="SwfdecAsContext"><span class="type">SwfdecAsContext</span></a> that should manage the object
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> size the object currently uses
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626464"></a><h3>
<a name="swfdec-as-object-set-constructor"></a>swfdec_as_object_set_constructor ()</h3>
<a class="indexterm" name="id2626477"></a><pre class="programlisting">void                swfdec_as_object_set_constructor    (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *construct);</pre>
<p>
Sets the constructor variables for <em class="parameter"><code>object</code></em>. Most objects get these 
variables set automatically, but for objects you created yourself, you want
to call this function. This is essentially the same as the following script
code:
</p>
<div class="informalexample"><pre class="programlisting"> object.constructor = construct;
object.__proto__ = construct.prototype; </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>construct</code></em>&#160;:</span></td>
<td> the constructor of <em class="parameter"><code>object</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626552"></a><h3>
<a name="SwfdecAsVariableFlag"></a>enum SwfdecAsVariableFlag</h3>
<a class="indexterm" name="id2626563"></a><pre class="programlisting">typedef enum {
  SWFDEC_AS_VARIABLE_HIDDEN = (1 &lt;&lt; 0),
  SWFDEC_AS_VARIABLE_PERMANENT = (1 &lt;&lt; 1),
  SWFDEC_AS_VARIABLE_CONSTANT = (1 &lt;&lt; 2),

  SWFDEC_AS_VARIABLE_VERSION_6_UP = (1 &lt;&lt; 7),
  SWFDEC_AS_VARIABLE_VERSION_NOT_6 = (1 &lt;&lt; 8),
  SWFDEC_AS_VARIABLE_VERSION_7_UP = (1 &lt;&lt; 10),
  SWFDEC_AS_VARIABLE_VERSION_8_UP = (1 &lt;&lt; 12),
} SwfdecAsVariableFlag;
</pre>
<p>
These flags are used to describe various properties of a variable inside
Swfdec. You can manually set them with <a href="swfdec-SwfdecAsObject.html#swfdec-as-object-set-variable-flags"><code class="function">swfdec_as_object_set_variable_flags()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="SWFDEC-AS-VARIABLE-HIDDEN:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_HIDDEN</code></span></td>
<td> Do not include variable in enumerations and
                               <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"><a name="SWFDEC-AS-VARIABLE-PERMANENT:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_PERMANENT</code></span></td>
<td> Do not all <a href="swfdec-SwfdecAsObject.html#swfdec-as-object-delete-variable"><code class="function">swfdec_as_object_delete_variable()</code></a>
                               to delete this variable.
</td>
</tr>
<tr>
<td><span class="term"><a name="SWFDEC-AS-VARIABLE-CONSTANT:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_CONSTANT</code></span></td>
<td> Do not allow changing the value with
                              <a href="swfdec-SwfdecAsObject.html#swfdec-as-object-set-variable"><code class="function">swfdec_as_object_set_variable()</code></a>.
</td>
</tr>
<tr>
<td><span class="term"><a name="SWFDEC-AS-VARIABLE-VERSION-6-UP:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_VERSION_6_UP</code></span></td>
<td> This symbol is only visible in version 6 
                                  and above.
</td>
</tr>
<tr>
<td><span class="term"><a name="SWFDEC-AS-VARIABLE-VERSION-NOT-6:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_VERSION_NOT_6</code></span></td>
<td> This symbols is visible in all versions 
                                   but version 6.
</td>
</tr>
<tr>
<td><span class="term"><a name="SWFDEC-AS-VARIABLE-VERSION-7-UP:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_VERSION_7_UP</code></span></td>
<td> This symbol is only visible in version 7 
                                  and above.
</td>
</tr>
<tr>
<td><span class="term"><a name="SWFDEC-AS-VARIABLE-VERSION-8-UP:CAPS"></a><code class="literal">SWFDEC_AS_VARIABLE_VERSION_8_UP</code></span></td>
<td> This symbol is only visible in version 8 
                                  and above.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626785"></a><h3>
<a name="swfdec-as-object-get-variable"></a>swfdec_as_object_get_variable()</h3>
<a class="indexterm" name="id2626798"></a><pre class="programlisting">#define             swfdec_as_object_get_variable(object, variable, value)</pre>
<p>
Gets the value of the given <em class="parameter"><code>variable</code></em> on <em class="parameter"><code>object</code></em>. It walks the prototype 
chain. This is a shortcut macro for 
<a href="swfdec-SwfdecAsObject.html#swfdec-as-object-get-variable-and-flags"><code class="function">swfdec_as_object_get_variable_and_flags()</code></a>.</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> a garbage-collected string containing the name of the variable
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> pointer to a <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue"><span class="type">SwfdecAsValue</span></a> that takes the return value or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626903"></a><h3>
<a name="swfdec-as-object-get-variable-and-flags"></a>swfdec_as_object_get_variable_and_flags ()</h3>
<a class="indexterm" name="id2626916"></a><pre class="programlisting">gboolean            swfdec_as_object_get_variable_and_flags
                                                        (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable,
                                                         <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *value,
                                                         guint *flags,
                                                         <a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> **pobject);</pre>
<p>
Looks up <em class="parameter"><code>variable</code></em> on <em class="parameter"><code>object</code></em>. It also walks the object's prototype chain.
If the variable exists, its value, flags and the real object containing the
variable will be set and <code class="literal">TRUE</code> will be returned.</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> a garbage-collected string containing the name of the variable
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> pointer to a <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue"><span class="type">SwfdecAsValue</span></a> that takes the return value or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> pointer to a guint taking the variable's flags or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pobject</code></em>&#160;:</span></td>
<td> pointer to set to the object that really holds the property or 
          <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the variable exists, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627127"></a><h3>
<a name="swfdec-as-object-set-variable"></a>swfdec_as_object_set_variable()</h3>
<a class="indexterm" name="id2627139"></a><pre class="programlisting">#define             swfdec_as_object_set_variable(object, variable, value)</pre>
<p>
Sets a variable on <em class="parameter"><code>object</code></em>. It is not guaranteed that getting the variable
after setting it results in the same value. This is a mcaro that calls 
<a href="swfdec-SwfdecAsObject.html#swfdec-as-object-set-variable-and-flags"><code class="function">swfdec_as_object_set_variable_and_flags()</code></a></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 to set
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> value to set the variable to
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627224"></a><h3>
<a name="swfdec-as-object-set-variable-and-flags"></a>swfdec_as_object_set_variable_and_flags ()</h3>
<a class="indexterm" name="id2627237"></a><pre class="programlisting">void                swfdec_as_object_set_variable_and_flags
                                                        (<a href="swfdec-SwfdecAsObject.html#SwfdecAsObject">SwfdecAsObject</a> *object,
                                                         const char *variable,
                                                         const <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *value,
                                                         guint default_flags);</pre>
<p>
Sets a variable on <em class="parameter"><code>object</code></em>. It is not guaranteed that getting the variable
after setting it results in the same value, because various mechanisms (like
the Actionscript Object.addProperty function or constant variables) can 
avoid this.</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 to set
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> value to set the variable to
</td>
</tr>
<tr>