<?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="libecal-ECalListener">
<refmeta>
<refentrytitle role="top_of_page">ECalListener</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBECAL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ECalListener</refname>
<refpurpose>Listens for responses and event notifications sent by an <link linkend="e-cal"><type>e-cal</type></link>.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



<link linkend="void">void</link>                (<link linkend="ECalListenerCalSetModeFn">*ECalListenerCalSetModeFn</link>)         (<link linkend="ECalListener">ECalListener</link> *listener,
                                                         <link linkend="GNOME-Evolution-Calendar-CalListener-SetModeStatus">GNOME_Evolution_Calendar_CalListener_SetModeStatus</link> status,
                                                         <link linkend="GNOME-Evolution-Calendar-CalMode">GNOME_Evolution_Calendar_CalMode</link> mode,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="ECalListener">ECalListener</link>*       <link linkend="e-cal-listener-construct">e_cal_listener_construct</link>            (<link linkend="ECalListener">ECalListener</link> *listener,
                                                         <link linkend="ECalListenerCalSetModeFn">ECalListenerCalSetModeFn</link> cal_set_mode_fn,
                                                         <link linkend="gpointer">gpointer</link> fn_data);
<link linkend="ECalListener">ECalListener</link>*       <link linkend="e-cal-listener-new">e_cal_listener_new</link>                  (<link linkend="ECalListenerCalSetModeFn">ECalListenerCalSetModeFn</link> cal_set_mode_fn,
                                                         <link linkend="gpointer">gpointer</link> fn_data);
<link linkend="void">void</link>                <link linkend="e-cal-listener-stop-notification">e_cal_listener_stop_notification</link>    (<link linkend="ECalListener">ECalListener</link> *listener);

</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Contrast with the <link linkend="e-cal-view-listener"><type>e-cal-view-listener</type></link>, which listens to <link linkend="e-cal-view"><type>e-cal-view</type></link>.
</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="ECalListenerCalSetModeFn" role="function"/>ECalListenerCalSetModeFn ()</title>
<indexterm><primary>ECalListenerCalSetModeFn</primary></indexterm><programlisting><link linkend="void">void</link>                (*ECalListenerCalSetModeFn)         (<link linkend="ECalListener">ECalListener</link> *listener,
                                                         <link linkend="GNOME-Evolution-Calendar-CalListener-SetModeStatus">GNOME_Evolution_Calendar_CalListener_SetModeStatus</link> status,
                                                         <link linkend="GNOME-Evolution-Calendar-CalMode">GNOME_Evolution_Calendar_CalMode</link> mode,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>listener</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-cal-listener-construct" role="function"/>e_cal_listener_construct ()</title>
<indexterm><primary>e_cal_listener_construct</primary></indexterm><programlisting><link linkend="ECalListener">ECalListener</link>*       e_cal_listener_construct            (<link linkend="ECalListener">ECalListener</link> *listener,
                                                         <link linkend="ECalListenerCalSetModeFn">ECalListenerCalSetModeFn</link> cal_set_mode_fn,
                                                         <link linkend="gpointer">gpointer</link> fn_data);</programlisting>
<para>
Constructs all internal information for a calendar listener. This function
usually does not need to be called, unless creating a ECalListener-derived
class.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>listener</parameter>&nbsp;:</term>
<listitem><simpara> A calendar listener.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal_set_mode_fn</parameter>&nbsp;:</term>
<listitem><simpara> Function callback for notification that a
calendar changed modes.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fn_data</parameter>&nbsp;:</term>
<listitem><simpara> Closure data pointer that will be passed to the notification
functions.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the calendar listener ready to be used.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-cal-listener-new" role="function"/>e_cal_listener_new ()</title>
<indexterm><primary>e_cal_listener_new</primary></indexterm><programlisting><link linkend="ECalListener">ECalListener</link>*       e_cal_listener_new                  (<link linkend="ECalListenerCalSetModeFn">ECalListenerCalSetModeFn</link> cal_set_mode_fn,
                                                         <link linkend="gpointer">gpointer</link> fn_data);</programlisting>
<para>
Creates a new <link linkend="ECalListener"><type>ECalListener</type></link> object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>cal_set_mode_fn</parameter>&nbsp;:</term>
<listitem><simpara> Function callback for notification that a
calendar changed modes.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fn_data</parameter>&nbsp;:</term>
<listitem><simpara> Closure data pointer that will be passed to the notification
functions.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly-created <link linkend="ECalListener"><type>ECalListener</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-cal-listener-stop-notification" role="function"/>e_cal_listener_stop_notification ()</title>
<indexterm><primary>e_cal_listener_stop_notification</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_listener_stop_notification    (<link linkend="ECalListener">ECalListener</link> *listener);</programlisting>
<para>
Informs a calendar listener that no further notification is desired.  The
callbacks specified when the listener was created will no longer be invoked
after this function is called.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>listener</parameter>&nbsp;:</term>
<listitem><simpara> A calendar listener.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
<link linkend="ECal"><type>ECal</type></link>, <link linkend="ECalViewListener"><type>ECalViewListener</type></link>
</para>
</refsect1>

</refentry>
