enumerations.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="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="SwfdecAsContextState">SwfdecAsContextState</link>;
enum                <link linkend="SwfdecAsDeleteReturn">SwfdecAsDeleteReturn</link>;
enum                <link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link>;
enum                <link linkend="SwfdecLoaderRequest">SwfdecLoaderRequest</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="SwfdecAlignment">SwfdecAlignment</link>;
enum                <link linkend="SwfdecKey">SwfdecKey</link>;
enum                <link linkend="SwfdecMouseCursor">SwfdecMouseCursor</link>;
enum                <link linkend="SwfdecScaleMode">SwfdecScaleMode</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="SwfdecAsContextState" role="enum"/>enum SwfdecAsContextState</title>
<indexterm><primary>SwfdecAsContextState</primary></indexterm><programlisting>typedef enum {
  SWFDEC_AS_CONTEXT_NEW,
  SWFDEC_AS_CONTEXT_RUNNING,
  SWFDEC_AS_CONTEXT_INTERRUPTED,
  SWFDEC_AS_CONTEXT_ABORTED
} SwfdecAsContextState;
</programlisting>
<para>
The state of the context describes what operations are possible on the context.
It will be in the state <parameter>SWFDEC_AS_CONTEXT_STATE_RUNNING</parameter> almost all the time. If
it is in the state <parameter>SWFDEC_AS_CONTEXT_STATE_ABORTED</parameter>, it will not work anymore and
every operation on it will instantly fail.</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SWFDEC-AS-CONTEXT-NEW:CAPS" role="constant"/><literal>SWFDEC_AS_CONTEXT_NEW</literal></term>
<listitem><simpara> the context is not yet initialized, 
                        <link linkend="swfdec-as-context-startup"><function>swfdec_as_context_startup()</function></link> needs to be called.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-AS-CONTEXT-RUNNING:CAPS" role="constant"/><literal>SWFDEC_AS_CONTEXT_RUNNING</literal></term>
<listitem><simpara> the context is running normally
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-AS-CONTEXT-INTERRUPTED:CAPS" role="constant"/><literal>SWFDEC_AS_CONTEXT_INTERRUPTED</literal></term>
<listitem><simpara> the context has been interrupted by a 
                            debugger
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-AS-CONTEXT-ABORTED:CAPS" role="constant"/><literal>SWFDEC_AS_CONTEXT_ABORTED</literal></term>
<listitem><simpara> the context has aborted execution due to a 
                        fatal error
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SwfdecAsDeleteReturn" role="enum"/>enum SwfdecAsDeleteReturn</title>
<indexterm><primary>SwfdecAsDeleteReturn</primary></indexterm><programlisting>typedef enum {
  SWFDEC_AS_DELETE_NOT_FOUND = 0,
  SWFDEC_AS_DELETE_DELETED,
  SWFDEC_AS_DELETE_NOT_DELETED
} SwfdecAsDeleteReturn;
</programlisting>
<para>
This is the return value used by <link linkend="swfdec-as-object-delete-variable"><function>swfdec_as_object_delete_variable()</function></link>. It 
describes the various outcomes of trying to delete a variable.</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SWFDEC-AS-DELETE-NOT-FOUND:CAPS" role="constant"/><literal>SWFDEC_AS_DELETE_NOT_FOUND</literal></term>
<listitem><simpara> The variable was not found and therefore 
                             couldn't be deleted.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-AS-DELETE-DELETED:CAPS" role="constant"/><literal>SWFDEC_AS_DELETE_DELETED</literal></term>
<listitem><simpara> The variable was deleted.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-AS-DELETE-NOT-DELETED:CAPS" role="constant"/><literal>SWFDEC_AS_DELETE_NOT_DELETED</literal></term>
<listitem><simpara> The variable was found but could not be 
                               deleted.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<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="SwfdecLoaderRequest" role="enum"/>enum SwfdecLoaderRequest</title>
<indexterm><primary>SwfdecLoaderRequest</primary></indexterm><programlisting>typedef enum {
  SWFDEC_LOADER_REQUEST_DEFAULT = 0,
  SWFDEC_LOADER_REQUEST_GET = 1,
  SWFDEC_LOADER_REQUEST_POST = 2
} SwfdecLoaderRequest;
</programlisting>
<para>
Describes the moethod to use for requesting a given URL. These methods map
naturally to HTTP methods, since HTTP is the common method for requesting 
Flash content.</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SWFDEC-LOADER-REQUEST-DEFAULT:CAPS" role="constant"/><literal>SWFDEC_LOADER_REQUEST_DEFAULT</literal></term>
<listitem><simpara> Use the default method (this most likely is 
                                equal to HTTPget)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-LOADER-REQUEST-GET:CAPS" role="constant"/><literal>SWFDEC_LOADER_REQUEST_GET</literal></term>
<listitem><simpara> Use HTTP get
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-LOADER-REQUEST-POST:CAPS" role="constant"/><literal>SWFDEC_LOADER_REQUEST_POST</literal></term>
<listitem><simpara> Use HTTP post
</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="SwfdecAlignment" role="enum"/>enum SwfdecAlignment</title>
<indexterm><primary>SwfdecAlignment</primary></indexterm><programlisting>typedef enum {
  SWFDEC_ALIGNMENT_TOP_LEFT,
  SWFDEC_ALIGNMENT_TOP,
  SWFDEC_ALIGNMENT_TOP_RIGHT,
  SWFDEC_ALIGNMENT_LEFT,
  SWFDEC_ALIGNMENT_CENTER,
  SWFDEC_ALIGNMENT_RIGHT,
  SWFDEC_ALIGNMENT_BOTTOM_LEFT,
  SWFDEC_ALIGNMENT_BOTTOM,
  SWFDEC_ALIGNMENT_BOTTOM_RIGHT
} SwfdecAlignment;
</programlisting>
<para>
These are the possible values for the alignment of an unscaled movie.</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-TOP-LEFT:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_TOP_LEFT</literal></term>
<listitem><simpara> top left
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-TOP:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_TOP</literal></term>
<listitem><simpara> top
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-TOP-RIGHT:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_TOP_RIGHT</literal></term>
<listitem><simpara> top right
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-LEFT:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_LEFT</literal></term>
<listitem><simpara> left
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-CENTER:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_CENTER</literal></term>
<listitem><simpara> center
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-RIGHT:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_RIGHT</literal></term>
<listitem><simpara> right
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-BOTTOM-LEFT:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_BOTTOM_LEFT</literal></term>
<listitem><simpara> left
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-BOTTOM:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_BOTTOM</literal></term>
<listitem><simpara> bottom
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SWFDEC-ALIGNMENT-BOTTOM-RIGHT:CAPS" role="constant"/><literal>SWFDEC_ALIGNMENT_BOTTOM_RIGHT</literal></term>
<listitem><simpara> bottom right
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SwfdecKey" role="enum"/>enum SwfdecKey</title>
<indexterm><primary>SwfdecKey</primary></indexterm><programlisting>typedef enum {
  SWFDEC_KEY_BACKSPACE = 8,
  SWFDEC_KEY_TAB = 9,
  SWFDEC_KEY_CLEAR = 12,
  SWFDEC_KEY_ENTER = 13,
  SWFDEC_KEY_SHIFT = 16,
  SWFDEC_KEY_CONTROL = 17,
  SWFDEC_KEY_ALT = 18,
  SWFDEC_KEY_CAPS_LOCK = 20,
  SWFDEC_KEY_ESCAPE = 27,
  SWFDEC_KEY_SPACE = 32,
  SWFDEC_KEY_PAGE_UP = 33,
  SWFDEC_KEY_PAGE_DOWN = 34,
  SWFDEC_KEY_END = 35,
  SWFDEC_KEY_HOME = 36,
  SWFDEC_KEY_LEFT = 37,
  SWFDEC_KEY_UP = 38,
  SWFDEC_KEY_RIGHT = 39,
  SWFDEC_KEY_DOWN = 40,
  SWFDEC_KEY_INSERT = 45,
  SWFDEC_KEY_DELETE = 46,
  SWFDEC_KEY_HELP = 47,
  SWFDEC_KEY_0 = 48,
  SWFDEC_KEY_1 = 49,
  SWFDEC_KEY_2 = 50,
  SWFDEC_KEY_3 = 51,
  SWFDEC_KEY_4 = 52,
  SWFDEC_KEY_5 = 53,
  SWFDEC_KEY_6 = 54,
  SWFDEC_KEY_7 = 55,
  SWFDEC_KEY_8 = 56,
  SWFDEC_KEY_9 = 57,
  SWFDEC_KEY_A = 65,