<?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" id="ECalView.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 id="ECalView.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="ECalView-struct">ECalView</link>;
struct <link linkend="ECal">_ECal</link>*       <link linkend="e-cal-view-get-client">e_cal_view_get_client</link>               (<link linkend="ECalView">ECalView</link> *view);
<link linkend="void">void</link>                <link linkend="e-cal-view-start">e_cal_view_start</link>                    (<link linkend="ECalView">ECalView</link> *view);
</synopsis>
</refsynopsisdiv>

<refsect1 id="ECalView.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----ECalView
</synopsis>

</refsect1>





<refsect1 id="ECalView.properties" 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 id="ECalView.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="ECalView-objects-added">objects-added</link>&quot;                                  : Run First
  &quot;<link linkend="ECalView-objects-modified">objects-modified</link>&quot;                               : Run First
  &quot;<link linkend="ECalView-objects-removed">objects-removed</link>&quot;                                : Run First
  &quot;<link linkend="ECalView-view-done">view-done</link>&quot;                                      : Run First
  &quot;<link linkend="ECalView-view-progress">view-progress</link>&quot;                                  : Run First
</synopsis>
</refsect1>


<refsect1 id="ECalView.description" 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 id="ECalView.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ECalView-struct" role="struct">
<title>ECalView</title>
<indexterm zone="ECalView-struct"><primary>ECalView</primary></indexterm><programlisting>typedef struct _ECalView ECalView;</programlisting>
<para>

</para></refsect2>
<refsect2 id="e-cal-view-get-client" role="function">
<title>e_cal_view_get_client ()</title>
<indexterm zone="e-cal-view-get-client"><primary>e_cal_view_get_client</primary></indexterm><programlisting>struct <link linkend="ECal">_ECal</link>*       e_cal_view_get_client               (<link linkend="ECalView">ECalView</link> *view);</programlisting>
<para>
Get the <link linkend="ECal"><type>ECal</type></link> associated with this view.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ECalView"><type>ECalView</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the associated client.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-view-start" role="function">
<title>e_cal_view_start ()</title>
<indexterm zone="e-cal-view-start"><primary>e_cal_view_start</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_view_start                    (<link linkend="ECalView">ECalView</link> *view);</programlisting>
<para>
Starts a live query to the calendar/tasks backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="ECalView"><type>ECalView</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

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

</refsect1>

<refsect1 id="ECalView.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="ECalView-objects-added"><title>The <literal>&quot;objects-added&quot;</literal> signal</title>
<indexterm zone="ECalView-objects-added"><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 id="ECalView-objects-modified"><title>The <literal>&quot;objects-modified&quot;</literal> signal</title>
<indexterm zone="ECalView-objects-modified"><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 id="ECalView-objects-removed"><title>The <literal>&quot;objects-removed&quot;</literal> signal</title>
<indexterm zone="ECalView-objects-removed"><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 id="ECalView-view-done"><title>The <literal>&quot;view-done&quot;</literal> signal</title>
<indexterm zone="ECalView-view-done"><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 id="ECalView-view-progress"><title>The <literal>&quot;view-progress&quot;</literal> signal</title>
<indexterm zone="ECalView-view-progress"><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 id="ECalView.see-also">
<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>
