swfdecgtkwidget.xml

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

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="SwfdecGtkWidget">
<refmeta>
<refentrytitle role="top_of_page">SwfdecGtkWidget</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecGtkWidget</refname>
<refpurpose>a <link linkend="GtkWidget"><type>GtkWidget</type></link> for embedding SWF files</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



                    <link linkend="SwfdecGtkWidget-struct">SwfdecGtkWidget</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="swfdec-gtk-widget-new">swfdec_gtk_widget_new</link>               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="SwfdecPlayer">SwfdecPlayer</link>*       <link linkend="swfdec-gtk-widget-get-player">swfdec_gtk_widget_get_player</link>        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-widget-set-player">swfdec_gtk_widget_set_player</link>        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
                                                         <link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-gtk-widget-get-interactive">swfdec_gtk_widget_get_interactive</link>   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-widget-set-interactive">swfdec_gtk_widget_set_interactive</link>   (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
                                                         <link linkend="gboolean">gboolean</link> interactive);
<link linkend="cairo-surface-type-t">cairo_surface_type_t</link> <link linkend="swfdec-gtk-widget-get-renderer">swfdec_gtk_widget_get_renderer</link>     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-gtk-widget-uses-renderer">swfdec_gtk_widget_uses_renderer</link>     (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-widget-set-renderer">swfdec_gtk_widget_set_renderer</link>      (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
                                                         <link linkend="cairo-surface-type-t">cairo_surface_type_t</link> renderer);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-widget-unset-renderer">swfdec_gtk_widget_unset_renderer</link>    (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);
<link linkend="guint">guint</link>               <link linkend="swfdec-gtk-keycode-from-hardware-keycode">swfdec_gtk_keycode_from_hardware_keycode</link>
                                                        (<link linkend="guint">guint</link> hardware_keycode);

</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----SwfdecGtkWidget
</synopsis>

</refsect1>



<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
SwfdecGtkWidget implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>

</refsect1>


<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>

  &quot;<link linkend="SwfdecGtkWidget--interactive">interactive</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="SwfdecGtkWidget--player">player</link>&quot;                   <link linkend="SwfdecPlayer">SwfdecPlayer</link>          : Read / Write / Construct
  &quot;<link linkend="SwfdecGtkWidget--renderer">renderer</link>&quot;                 <link linkend="guint">guint</link>                 : Read / Write
  &quot;<link linkend="SwfdecGtkWidget--renderer-set">renderer-set</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
</synopsis>
</refsect1>



<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
This is a widget for playing Flash movies rendered with Swfdec in a Gtk 
application. It supports a lot of advanced features, if you want to use
them. If you don't want to use them and just want to embed a movie in 
your application, <link linkend="swfdec-gtk-widget-new"><function>swfdec_gtk_widget_new()</function></link> will probably be the only 
function you need.
</para>
<para>
<parameter>see_also</parameter>: SwfdecGtkPlayer</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecGtkWidget-struct" role="struct"/>SwfdecGtkWidget</title>
<indexterm><primary>SwfdecGtkWidget</primary></indexterm><programlisting>typedef struct _SwfdecGtkWidget SwfdecGtkWidget;</programlisting>
<para>
The structure for the Swfdec Gtk widget contains no public fields.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-new" role="function"/>swfdec_gtk_widget_new ()</title>
<indexterm><primary>swfdec_gtk_widget_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          swfdec_gtk_widget_new               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Creates a new <link linkend="SwfdecGtkWidget"><type>SwfdecGtkWidget</type></link> to display <parameter>player</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new widget that displays <parameter>player</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-get-player" role="function"/>swfdec_gtk_widget_get_player ()</title>
<indexterm><primary>swfdec_gtk_widget_get_player</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_gtk_widget_get_player        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget);</programlisting>
<para>
Gets the player that is currently played back in this <parameter>widget</parameter>.</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 <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-widget-set-player" role="function"/>swfdec_gtk_widget_set_player ()</title>
<indexterm><primary>swfdec_gtk_widget_set_player</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_widget_set_player        (<link linkend="SwfdecGtkWidget">SwfdecGtkWidget</link> *widget,
                                                         <link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Sets the new player to display in <parameter>widget</parameter>.</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>