swfdecasobject.xml

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

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected name of the variable to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> value to set the variable to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-set-variable-and-flags" role="function"/>swfdec_as_object_set_variable_and_flags ()</title>
<indexterm><primary>swfdec_as_object_set_variable_and_flags</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_object_set_variable_and_flags
                                                        (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *variable,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value,
                                                         <link linkend="guint">guint</link> default_flags);</programlisting>
<para>
Sets a variable on <parameter>object</parameter>. 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.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected name of the variable to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> value to set the variable to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>default_flags</parameter>&nbsp;:</term>
<listitem><simpara> flags to use if creating the variable anew - the flags will
                be ignored if the property already exists.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-add-variable" role="function"/>swfdec_as_object_add_variable ()</title>
<indexterm><primary>swfdec_as_object_add_variable</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_object_add_variable       (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="SwfdecAsFunction">SwfdecAsFunction</link> *get,
                                                         <link linkend="SwfdecAsFunction">SwfdecAsFunction</link> *set);</programlisting>
<para>
Adds a variable to <parameter>object</parameter> in the same way as the Actionscript code 
"object.<link linkend="addProperty"><function>addProperty()</function></link>" would do. Accessing the variable will from now on be
handled by calling the <parameter>get</parameter> or <parameter>set</parameter> functions. A previous value of the 
variable or a previous call to this function will be overwritten.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> name of the variable
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>get</parameter>&nbsp;:</term>
<listitem><simpara> getter function to call when reading the variable
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>set</parameter>&nbsp;:</term>
<listitem><simpara> setter function to call when writing the variable or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if read-only
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-set-variable-flags" role="function"/>swfdec_as_object_set_variable_flags ()</title>
<indexterm><primary>swfdec_as_object_set_variable_flags</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_object_set_variable_flags (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="SwfdecAsVariableFlag">SwfdecAsVariableFlag</link> flags);</programlisting>
<para>
Sets the given flags for the given variable.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> the variable to modify
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> flags to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-unset-variable-flags" role="function"/>swfdec_as_object_unset_variable_flags ()</title>
<indexterm><primary>swfdec_as_object_unset_variable_flags</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_object_unset_variable_flags
                                                        (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="SwfdecAsVariableFlag">SwfdecAsVariableFlag</link> flags);</programlisting>
<para>
Unsets the given flags for the given variable. The variable must exist in 
<parameter>object</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> the variable to modify
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> flags to unset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-delete-variable" role="function"/>swfdec_as_object_delete_variable ()</title>
<indexterm><primary>swfdec_as_object_delete_variable</primary></indexterm><programlisting><link linkend="SwfdecAsDeleteReturn">SwfdecAsDeleteReturn</link> swfdec_as_object_delete_variable   (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *variable);</programlisting>
<para>
Deletes the given variable if possible. If the variable is protected from 
deletion, it will not be deleted.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected name of the variable
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> See <link linkend="SwfdecAsDeleteReutnr"><type>SwfdecAsDeleteReutnr</type></link> for details of the return value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SwfdecAsVariableForeach" role="function"/>SwfdecAsVariableForeach ()</title>
<indexterm><primary>SwfdecAsVariableForeach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*SwfdecAsVariableForeach)          (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value,
                                                         <link linkend="guint">guint</link> flags,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Function prototype for the <link linkend="swfdec-as-object-foreach"><function>swfdec_as_object_foreach()</function></link> function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> The object this function is run on
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected name of the current variables
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> value of the current variable
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> Flags associated with the current variable
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> User dta passed to <link linkend="swfdec-as-object-foreach"><function>swfdec_as_object_foreach()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to continue running the foreach function, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to stop
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-foreach" role="function"/>swfdec_as_object_foreach ()</title>
<indexterm><primary>swfdec_as_object_foreach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_object_foreach            (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         <link linkend="SwfdecAsVariableForeach">SwfdecAsVariableForeach</link> func,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Calls <parameter>func</parameter> for every variable of <parameter>object</parameter> or until <parameter>func</parameter> returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>. The
variables of <parameter>object</parameter> must not be modified by <parameter>func</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
<listitem><simpara> function to call
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> data to pass to <parameter>func</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>func</parameter> always returned <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-has-function" role="function"/>swfdec_as_object_has_function ()</title>
<indexterm><primary>swfdec_as_object_has_function</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_as_object_has_function       (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *name);</programlisting>
<para>