<?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="libedata-cal-EDataCalFactory">
<refmeta>
<refentrytitle role="top_of_page" id="libedata-cal-EDataCalFactory.top_of_page">EDataCalFactory</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATA-CAL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EDataCalFactory</refname>
<refpurpose>Implementation of the calendar CORBA factory.</refpurpose>
</refnamediv>

<refsynopsisdiv id="libedata-cal-EDataCalFactory.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
#define             <link linkend="E-DATA-CAL-FACTORY-ERROR--CAPS">E_DATA_CAL_FACTORY_ERROR</link>
enum                <link linkend="EDataCalFactoryError">EDataCalFactoryError</link>;
                    <link linkend="EDataCalFactory">EDataCalFactory</link>;
<link linkend="void">void</link>                <link linkend="e-data-cal-factory-register-backend">e_data_cal_factory_register_backend</link> (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
                                                         <link linkend="ECalBackendFactory">ECalBackendFactory</link> *backend_factory);
<link linkend="void">void</link>                <link linkend="e-data-cal-factory-register-backends">e_data_cal_factory_register_backends</link>
                                                        (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);
<link linkend="gint">gint</link>                <link linkend="e-data-cal-factory-get-n-backends">e_data_cal_factory_get_n_backends</link>   (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);
<link linkend="void">void</link>                <link linkend="e-data-cal-factory-dump-active-backends">e_data_cal_factory_dump_active_backends</link>
                                                        (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);
<link linkend="void">void</link>                <link linkend="e-data-cal-factory-set-backend-mode">e_data_cal_factory_set_backend_mode</link> (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
                                                         <link linkend="gint">gint</link> mode);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libedata-cal-EDataCalFactory.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libedata-cal-EDataCalFactory.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="E-DATA-CAL-FACTORY-ERROR--CAPS" role="macro">
<title>E_DATA_CAL_FACTORY_ERROR</title>
<indexterm zone="E-DATA-CAL-FACTORY-ERROR--CAPS"><primary sortas="E_DATA_CAL_FACTORY_ERROR">E_DATA_CAL_FACTORY_ERROR</primary></indexterm><programlisting>#define E_DATA_CAL_FACTORY_ERROR e_data_cal_factory_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="EDataCalFactoryError" role="enum">
<title>enum EDataCalFactoryError</title>
<indexterm zone="EDataCalFactoryError"><primary sortas="EDataCalFactoryError">EDataCalFactoryError</primary></indexterm><programlisting>typedef enum {
	E_DATA_CAL_FACTORY_ERROR_GENERIC
} EDataCalFactoryError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="EDataCalFactory" role="struct">
<title>EDataCalFactory</title>
<indexterm zone="EDataCalFactory"><primary sortas="EDataCalFactory">EDataCalFactory</primary></indexterm><programlisting>typedef struct {
	GObject parent;
	EDataCalFactoryPrivate *priv;
} EDataCalFactory;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="e-data-cal-factory-register-backend" role="function">
<title>e_data_cal_factory_register_backend ()</title>
<indexterm zone="e-data-cal-factory-register-backend"><primary sortas="e_data_cal_factory_register_backend">e_data_cal_factory_register_backend</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_cal_factory_register_backend (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
                                                         <link linkend="ECalBackendFactory">ECalBackendFactory</link> *backend_factory);</programlisting>
<para>
Registers an <link linkend="ECalBackend"><type>ECalBackend</type></link> subclass that will be used to handle URIs
with a particular method.  When the factory is asked to open a
particular URI, it will look in its list of registered methods and
create a backend of the appropriate type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>backend_factory</parameter>&#160;:</term>
<listitem><simpara> The object responsible for creating backends.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-cal-factory-register-backends" role="function">
<title>e_data_cal_factory_register_backends ()</title>
<indexterm zone="e-data-cal-factory-register-backends"><primary sortas="e_data_cal_factory_register_backends">e_data_cal_factory_register_backends</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_cal_factory_register_backends
                                                        (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);</programlisting>
<para>
Register all backends for the given factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-cal-factory-get-n-backends" role="function">
<title>e_data_cal_factory_get_n_backends ()</title>
<indexterm zone="e-data-cal-factory-get-n-backends"><primary sortas="e_data_cal_factory_get_n_backends">e_data_cal_factory_get_n_backends</primary></indexterm><programlisting><link linkend="gint">gint</link>                e_data_cal_factory_get_n_backends   (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);</programlisting>
<para>
Get the number of backends currently active in the given factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of backends.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-cal-factory-dump-active-backends" role="function">
<title>e_data_cal_factory_dump_active_backends ()</title>
<indexterm zone="e-data-cal-factory-dump-active-backends"><primary sortas="e_data_cal_factory_dump_active_backends">e_data_cal_factory_dump_active_backends</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_cal_factory_dump_active_backends
                                                        (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory);</programlisting>
<para>
Dumps to standard output a list of all active backends for the given
factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-cal-factory-set-backend-mode" role="function">
<title>e_data_cal_factory_set_backend_mode ()</title>
<indexterm zone="e-data-cal-factory-set-backend-mode"><primary sortas="e_data_cal_factory_set_backend_mode">e_data_cal_factory_set_backend_mode</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_cal_factory_set_backend_mode (<link linkend="EDataCalFactory">EDataCalFactory</link> *factory,
                                                         <link linkend="gint">gint</link> mode);</programlisting>
<para>
Sets the online mode for all backends created by the given factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> A calendar factory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
<listitem><simpara> Online mode to set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
