swfdecgtkwidget.xml

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

<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> to display or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-get-interactive" role="function"/>swfdec_gtk_widget_get_interactive ()</title>
<indexterm><primary>swfdec_gtk_widget_get_interactive</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_widget_get_interactive   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
<para>
Queries if the <parameter>widget</parameter> is currently interactive. See 
<link linkend="swfdec-gtk-widget-set-interactive"><function>swfdec_gtk_widget_set_interactive()</function></link> for details.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the widget is interactive, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-set-interactive" role="function"/>swfdec_gtk_widget_set_interactive ()</title>
<indexterm><primary>swfdec_gtk_widget_set_interactive</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_interactive   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
                                                         <link linkend="gboolean">gboolean</link> interactive);</programlisting>
<para>
Sets the widget to be interactive or not. An interactive widget processes 
mouse and keyboard events, while a non-interactive widget does not care about
user input. Widgets are interactive by default.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>interactive</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to make the widget interactive
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-get-renderer" role="function"/>swfdec_gtk_widget_get_renderer ()</title>
<indexterm><primary>swfdec_gtk_widget_get_renderer</primary></indexterm><programlisting><link linkend="cairo-surface-type-t">cairo_surface_type_t</link> swfdec_gtk_widget_get_renderer     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
<para>
Gets the intermediate renderer that is or would be in use by <parameter>widget</parameter>. Use
<link linkend="swfdec-gtk-widget-uses-renderer"><function>swfdec_gtk_widget_uses_renderer()</function></link> to check if an intermediate renderer is in
use. See <link linkend="swfdec-gtk-widget-set-renderer"><function>swfdec_gtk_widget_set_renderer()</function></link> for details.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the type of the intermediate renderer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-uses-renderer" role="function"/>swfdec_gtk_widget_uses_renderer ()</title>
<indexterm><primary>swfdec_gtk_widget_uses_renderer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_widget_uses_renderer     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
<para>
Queries if an intermediate renderer set via <link linkend="swfdec-gtk-widget-set-renderer"><function>swfdec_gtk_widget_set_renderer()</function></link>
is currently in use.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if an intermediate renderer is used.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-set-renderer" role="function"/>swfdec_gtk_widget_set_renderer ()</title>
<indexterm><primary>swfdec_gtk_widget_set_renderer</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_renderer      (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
                                                         <link linkend="cairo-surface-type-t">cairo_surface_type_t</link> renderer);</programlisting>
<para>
Tells <parameter>widget</parameter> to use an intermediate surface for rendering. This is
useful for debugging or performance measurements inside swfdec and is 
probably not interesting for anyone else.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="cairo-surface-type-t"><type>cairo_surface_type_t</type></link> for the intermediate renderer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-unset-renderer" role="function"/>swfdec_gtk_widget_unset_renderer ()</title>
<indexterm><primary>swfdec_gtk_widget_unset_renderer</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_unset_renderer    (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
<para>
Unsets the use of an intermediate rendering surface. See 
<link linkend="swfdec-gtk-widget-set-renderer"><function>swfdec_gtk_widget_set_renderer()</function></link> for details.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-keycode-from-hardware-keycode" role="function"/>swfdec_gtk_keycode_from_hardware_keycode ()</title>
<indexterm><primary>swfdec_gtk_keycode_from_hardware_keycode</primary></indexterm><programlisting><link linkend="guint">guint</link>               swfdec_gtk_keycode_from_hardware_keycode
                                                        (<link linkend="guint">guint</link> hardware_keycode);</programlisting>
<para>
Tries to transform an X hardware keycode to the corresponding <link linkend="SwfdecKey"><type>SwfdecKey</type></link>.
This is a utility function for cases where key events need to be transformed
manually.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hardware_keycode</parameter>&nbsp;:</term>
<listitem><simpara> a hardware keycode sent from the X server
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the corresponding key code as used in Flash.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="SwfdecGtkWidget--interactive"/>The <literal>&quot;interactive&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkWidget:interactive</primary></indexterm><programlisting>  &quot;interactive&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>if mouse events are processed.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecGtkWidget--player"/>The <literal>&quot;player&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkWidget:player</primary></indexterm><programlisting>  &quot;player&quot;                   <link linkend="SwfdecPlayer">SwfdecPlayer</link>          : Read / Write / Construct</programlisting>
<para>player that is displayed.</para></refsect2>
<refsect2><title><anchor id="SwfdecGtkWidget--renderer"/>The <literal>&quot;renderer&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkWidget:renderer</primary></indexterm><programlisting>  &quot;renderer&quot;                 <link linkend="guint">guint</link>                 : Read / Write</programlisting>
<para>cairo_surface_type_t of intermediate renderer to use.</para><para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="SwfdecGtkWidget--renderer-set"/>The <literal>&quot;renderer-set&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkWidget:renderer-set</primary></indexterm><programlisting>  &quot;renderer-set&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>if an intermediate renderer should be used.</para><para>Default value: TRUE</para>
</refsect2>

</refsect1>





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