swfdecasobject.xml

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

Convenience function that checks of <parameter>object</parameter> has a variable that references 
a function.</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>name</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected name of th function
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if object.name is a function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-run" role="function"/>swfdec_as_object_run ()</title>
<indexterm><primary>swfdec_as_object_run</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_object_run                (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         <link linkend="SwfdecScript">SwfdecScript</link> *script);</programlisting>
<para>
Executes the given <parameter>script</parameter> with <parameter>object</parameter> as this pointer.</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>script</parameter>&nbsp;:</term>
<listitem><simpara> script to execute
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-call" role="function"/>swfdec_as_object_call ()</title>
<indexterm><primary>swfdec_as_object_call</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_object_call               (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *name,
                                                         <link linkend="guint">guint</link> argc,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *argv,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *return_value);</programlisting>
<para>
Calls the function named <parameter>name</parameter> on the given object. This function is 
essentially equal to the folloeing Actionscript code: 
<informalexample><programlisting>
@return_value = @object.@name (@argv[0], ..., @argv[argc-1]);
</programlisting></informalexample></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>name</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected string naming the function to call. 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argc</parameter>&nbsp;:</term>
<listitem><simpara> number of arguments to provide to function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
<listitem><simpara> arguments or <link linkend="NULL:CAPS"><literal>NULL</literal></link> when <parameter>argc</parameter> is 0
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>return_value</parameter>&nbsp;:</term>
<listitem><simpara> location to take the return value of the call or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to 
               ignore the return value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-add-function" role="function"/>swfdec_as_object_add_function ()</title>
<indexterm><primary>swfdec_as_object_add_function</primary></indexterm><programlisting><link linkend="SwfdecAsFunction">SwfdecAsFunction</link>*   swfdec_as_object_add_function       (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *name,
                                                         <link linkend="GType">GType</link> type,
                                                         <link linkend="SwfdecAsNative">SwfdecAsNative</link> native,
                                                         <link linkend="guint">guint</link> min_args);</programlisting>
<para>
Adds <parameter>native</parameter> as a variable named <parameter>name</parameter> to <parameter>object</parameter>. The newly added variable
will not be enumerated.</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>name</parameter>&nbsp;:</term>
<listitem><simpara> name of the function. The string does not have to be 
       garbage-collected.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> the required type of the this Object to make this function execute.
       May be 0 to accept any type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>native</parameter>&nbsp;:</term>
<listitem><simpara> a native function or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to just not do anything
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_args</parameter>&nbsp;:</term>
<listitem><simpara> minimum number of arguments to pass to <parameter>native</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly created <link linkend="SwfdecAsFunction"><type>SwfdecAsFunction</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-add-constructor" role="function"/>swfdec_as_object_add_constructor ()</title>
<indexterm><primary>swfdec_as_object_add_constructor</primary></indexterm><programlisting><link linkend="SwfdecAsFunction">SwfdecAsFunction</link>*   swfdec_as_object_add_constructor    (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object,
                                                         const <link linkend="char">char</link> *name,
                                                         <link linkend="GType">GType</link> type,
                                                         <link linkend="GType">GType</link> construct_type,
                                                         <link linkend="SwfdecAsNative">SwfdecAsNative</link> native,
                                                         <link linkend="guint">guint</link> min_args,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *prototype);</programlisting>
<para>
Adds <parameter>native</parameter> as a constructor named <parameter>name</parameter> to <parameter>object</parameter>. The newly added variable
will not be enumerated.</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>name</parameter>&nbsp;:</term>
<listitem><simpara> name of the function. The string does not have to be 
       garbage-collected.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> the required type of the this Object to make this function execute.
       May be 0 to accept any type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>construct_type</parameter>&nbsp;:</term>
<listitem><simpara> type used when using this function as a constructor. May 
                 be 0 to use the default type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>native</parameter>&nbsp;:</term>
<listitem><simpara> a native function or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to just not do anything
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_args</parameter>&nbsp;:</term>
<listitem><simpara> minimum number of arguments to pass to <parameter>native</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prototype</parameter>&nbsp;:</term>
<listitem><simpara> An optional object to be set as the "prototype" property of the
            new function. The prototype will be hidden and constant.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly created <link linkend="SwfdecAsFunction"><type>SwfdecAsFunction</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-get-debug" role="function"/>swfdec_as_object_get_debug ()</title>
<indexterm><primary>swfdec_as_object_get_debug</primary></indexterm><programlisting><link linkend="char">char</link>*               swfdec_as_object_get_debug          (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object);</programlisting>
<para>
Gets a representation string suitable for debugging. This function is 
guaranteed to not modify the state of the script engine, unlike 
<link linkend="swfdec-as-value-to-string"><function>swfdec_as_value_to_string()</function></link> for example.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly allocated string. Free it with <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-object-resolve" role="function"/>swfdec_as_object_resolve ()</title>
<indexterm><primary>swfdec_as_object_resolve</primary></indexterm><programlisting><link linkend="SwfdecAsObject">SwfdecAsObject</link>*     swfdec_as_object_resolve            (<link linkend="SwfdecAsObject">SwfdecAsObject</link> *object);</programlisting>
<para>
Resolves the object to its real object. Some internal objects should not be
exposed to scripts, for example <link linkend="SwfdecAsFrame"><type>SwfdecAsFrame</type></link> 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.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a non-internal object
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>