enumerations.xml

Swfdec still is development software, but has also followed a rigid no-crashes-allowed policy. I b

<?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="swfdec-Enumerations">
<refmeta>
<refentrytitle role="top_of_page">Enumerations</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Enumerations</refname>
<refpurpose>enumerations used in Swfdec</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



enum                <link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link>;
const <link linkend="char">char</link>*         <link linkend="swfdec-loader-data-type-get-extension">swfdec_loader_data_type_get_extension</link>
                                                        (<link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link> type);
enum                <link linkend="SwfdecMouseCursor">SwfdecMouseCursor</link>;

</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
This file lists all of the enumerations used in various parts of Swfdec.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecLoaderDataType" role="enum"/>enum SwfdecLoaderDataType</title>
<indexterm><primary>SwfdecLoaderDataType</primary></indexterm><programlisting>typedef enum {
  SWFDEC_LOADER_DATA_UNKNOWN,
  SWFDEC_LOADER_DATA_SWF,
  SWFDEC_LOADER_DATA_FLV,
  SWFDEC_LOADER_DATA_XML,
  SWFDEC_LOADER_DATA_TEXT
} SwfdecLoaderDataType;
</programlisting>
<para>
This type describes the different types of data that can be loaded inside 
Swfdec. Swfdec identifies its data streams and you can use the 
<link linkend="swfdec-loader-get-data-type"><function>swfdec_loader_get_data_type()</function></link> to acquire more information about the data
inside a <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link>.</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SWFDEC-LOADER-DATA-UNKNOWN:CAPS" role="constant"/><literal>SWFDEC_LOADER_DATA_UNKNOWN</literal></term>
<listitem><simpara> Unidentified data or data that cannot be 
                             identified.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-LOADER-DATA-SWF:CAPS" role="constant"/><literal>SWFDEC_LOADER_DATA_SWF</literal></term>
<listitem><simpara> Data describing a normal Flash file.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-LOADER-DATA-FLV:CAPS" role="constant"/><literal>SWFDEC_LOADER_DATA_FLV</literal></term>
<listitem><simpara> Data describing a Flash video stream.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-LOADER-DATA-XML:CAPS" role="constant"/><literal>SWFDEC_LOADER_DATA_XML</literal></term>
<listitem><simpara> Data in XML format.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-LOADER-DATA-TEXT:CAPS" role="constant"/><literal>SWFDEC_LOADER_DATA_TEXT</literal></term>
<listitem><simpara> Textual data.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-data-type-get-extension" role="function"/>swfdec_loader_data_type_get_extension ()</title>
<indexterm><primary>swfdec_loader_data_type_get_extension</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_loader_data_type_get_extension
                                                        (<link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link> type);</programlisting>
<para>
Queries the extension to be used for data of the given <parameter>type</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecLoaderDataType"><type>SwfdecLoaderDataType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the typical extension for this data type or the empty string
         if the type has no extension
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SwfdecMouseCursor" role="enum"/>enum SwfdecMouseCursor</title>
<indexterm><primary>SwfdecMouseCursor</primary></indexterm><programlisting>typedef enum {
  SWFDEC_MOUSE_CURSOR_NORMAL,
  SWFDEC_MOUSE_CURSOR_NONE,
  SWFDEC_MOUSE_CURSOR_TEXT,
  SWFDEC_MOUSE_CURSOR_CLICK
} SwfdecMouseCursor;
</programlisting>
<para>
This enumeration describes the possible types for the SwfdecPlayer::mouse-cursor
property.</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SWFDEC-MOUSE-CURSOR-NORMAL:CAPS" role="constant"/><literal>SWFDEC_MOUSE_CURSOR_NORMAL</literal></term>
<listitem><simpara> a normal mouse cursor
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-MOUSE-CURSOR-NONE:CAPS" role="constant"/><literal>SWFDEC_MOUSE_CURSOR_NONE</literal></term>
<listitem><simpara> no mouse image
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-MOUSE-CURSOR-TEXT:CAPS" role="constant"/><literal>SWFDEC_MOUSE_CURSOR_TEXT</literal></term>
<listitem><simpara> a mouse cursor suitable for text editing
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-MOUSE-CURSOR-CLICK:CAPS" role="constant"/><literal>SWFDEC_MOUSE_CURSOR_CLICK</literal></term>
<listitem><simpara> a mouse cursor for clicking a hyperlink or a 
                            button
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>