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

<refnamediv>
<refname>ECalView</refname>
<refpurpose>Represents a search against a calendar.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



            <link linkend="ECalView-struct">ECalView</link>;
<link linkend="ECalView">ECalView</link>*   <link linkend="e-cal-view-new">e_cal_view_new</link>                  (<link linkend="GNOME-Evolution-Calendar-CalView">GNOME_Evolution_Calendar_CalView</link> corba_view,
                                             <link linkend="ECalViewListener">ECalViewListener</link> *listener,
                                             <link linkend="struct--ECal">struct _ECal</link> *client);


</synopsis>
</refsynopsisdiv>

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

  <link linkend="GObject">GObject</link>
   +----ECalView
</synopsis>

</refsect1>





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

  &quot;<link linkend="ECalView--client">client</link>&quot;               <link linkend="ECal">ECal</link>                  : Read / Write / Construct Only
  &quot;<link linkend="ECalView--listener">listener</link>&quot;             <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
  &quot;<link linkend="ECalView--view">view</link>&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
</synopsis>
</refsect1>

<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>

&quot;<link linkend="ECalView-objects-added">objects-added</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gpointer">gpointer</link>  arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first
&quot;<link linkend="ECalView-objects-modified">objects-modified</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gpointer">gpointer</link>  arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first
&quot;<link linkend="ECalView-objects-removed">objects-removed</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gpointer">gpointer</link>  arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first
&quot;<link linkend="ECalView-view-done">view-done</link>&quot; <link linkend="void">void</link>        user_function      (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gint">gint</link>      arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first
&quot;<link linkend="ECalView-view-progress">view-progress</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gchar">gchar</link>    *arg1,
                                            <link linkend="gint">gint</link>      arg2,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first
</synopsis>
</refsect1>


<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
In the same way that an EBookView represents a view of an addressbook, the
ECalView is a view of the ECal.
</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="ECalView-struct" role="struct"/>ECalView</title>
<indexterm><primary>ECalView</primary></indexterm><programlisting>typedef struct _ECalView ECalView;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="e-cal-view-new" role="function"/>e_cal_view_new ()</title>
<indexterm><primary>e_cal_view_new</primary></indexterm><programlisting><link linkend="ECalView">ECalView</link>*   e_cal_view_new                  (<link linkend="GNOME-Evolution-Calendar-CalView">GNOME_Evolution_Calendar_CalView</link> corba_view,
                                             <link linkend="ECalViewListener">ECalViewListener</link> *listener,
                                             <link linkend="struct--ECal">struct _ECal</link> *client);</programlisting>
<para>
Creates a new view object by issuing the view creation request to the
calendar server.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>corba_view</parameter>&nbsp;:</term>
<listitem><simpara> The CORBA object for the view.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>listener</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalViewListener"><type>ECalViewListener</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>client</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECal"><type>ECal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly-created view object, or NULL if the request failed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="ECalView--client"/>The &quot;<literal>client</literal>&quot; property</title>
<indexterm><primary>ECalView:client</primary></indexterm><programlisting>  &quot;client&quot;               <link linkend="ECal">ECal</link>                  : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ECalView--listener"/>The &quot;<literal>listener</literal>&quot; property</title>
<indexterm><primary>ECalView:listener</primary></indexterm><programlisting>  &quot;listener&quot;             <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ECalView--view"/>The &quot;<literal>view</literal>&quot; property</title>
<indexterm><primary>ECalView:view</primary></indexterm><programlisting>  &quot;view&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
<para></para></refsect2>

</refsect1>

<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="ECalView-objects-added"/>The &quot;objects-added&quot; signal</title>
<indexterm><primary>ECalView::objects-added</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gpointer">gpointer</link>  arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ecalview</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ECalView-objects-modified"/>The &quot;objects-modified&quot; signal</title>
<indexterm><primary>ECalView::objects-modified</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gpointer">gpointer</link>  arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ecalview</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ECalView-objects-removed"/>The &quot;objects-removed&quot; signal</title>
<indexterm><primary>ECalView::objects-removed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gpointer">gpointer</link>  arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ecalview</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ECalView-view-done"/>The &quot;view-done&quot; signal</title>
<indexterm><primary>ECalView::view-done</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gint">gint</link>      arg1,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ecalview</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ECalView-view-progress"/>The &quot;view-progress&quot; signal</title>
<indexterm><primary>ECalView::view-progress</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="ECalView">ECalView</link> *ecalview,
                                            <link linkend="gchar">gchar</link>    *arg1,
                                            <link linkend="gint">gint</link>      arg2,
                                            <link linkend="gpointer">gpointer</link>  user_data)      : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ecalview</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>


<refsect1>
<title>See Also</title>
<para>
<link linkend="e-cal"><type>e-cal</type></link>, <link linkend="e-cal-view-listener"><type>e-cal-view-listener</type></link>
</para>
</refsect1>

</refentry>
