1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
|
<?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-ECalView">
<refmeta>
<refentrytitle>ECalView</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBECAL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ECalView</refname><refpurpose>Represents a search against a calendar.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<anchor id="ECal"/>
<synopsis>
struct <link linkend="ECal-struct">ECal</link>;
#define <link linkend="E-CAL-VIEW-CAPS">E_CAL_VIEW</link> (obj)
#define <link linkend="E-CAL-VIEW-CLASS-CAPS">E_CAL_VIEW_CLASS</link> (klass)
<link linkend="GType">GType</link> <link linkend="e-cal-view-get-type">e_cal_view_get_type</link> (void);
<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,
struct <link linkend="ECal">_ECal</link> *client);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----ECal
</synopsis>
</refsect1>
<refsect1>
<title>Signal Prototypes</title>
<synopsis>
"<link linkend="ECal-backend-died">backend-died</link>"
<link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="ECal-backend-error">backend-error</link>"
<link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gchar">gchar</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="ECal-cal-opened">cal-opened</link>"
<link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="ECal-cal-set-mode">cal-set-mode</link>"
<link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="ECalSetModeStatusEnum">ECalSetModeStatusEnum</link> arg1,
<link linkend="CalModeEnum">CalModeEnum</link> arg2,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="ECal-categories-changed">categories-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gpointer">gpointer</link> arg1,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>
<refsect1>
<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>
<title>Details</title>
<refsect2>
<title><anchor id="ECal-struct"/>struct ECal</title>
<indexterm><primary>ECal</primary></indexterm><programlisting>struct ECal;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="E-CAL-VIEW-CAPS"/>E_CAL_VIEW()</title>
<indexterm><primary>E_CAL_VIEW</primary></indexterm><programlisting>#define E_CAL_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_CAL_VIEW, ECalView))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="E-CAL-VIEW-CLASS-CAPS"/>E_CAL_VIEW_CLASS()</title>
<indexterm><primary>E_CAL_VIEW_CLASS</primary></indexterm><programlisting>#define E_CAL_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_CAL_VIEW, ECalViewClass))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>klass</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-cal-view-get-type"/>e_cal_view_get_type ()</title>
<indexterm><primary>e_cal_view_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link> e_cal_view_get_type (void);</programlisting>
<para>
Registers the <link linkend="ECalView"><type>ECalView</type></link> class if necessary, and returns the type ID assigned
to it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The type ID of the <link linkend="ECalView"><type>ECalView</type></link> class.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-cal-view-new"/>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,
struct <link linkend="ECal">_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> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>listener</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>client</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly-created view object, or NULL if the request failed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="ECal-backend-died"/>The "backend-died" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para>
@:</refsect2><refsect2><title><anchor id="ECal-backend-error"/>The "backend-error" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gchar">gchar</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para>
@:
@:</refsect2><refsect2><title><anchor id="ECal-cal-opened"/>The "cal-opened" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para>
@:
@:</refsect2><refsect2><title><anchor id="ECal-cal-set-mode"/>The "cal-set-mode" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="ECalSetModeStatusEnum">ECalSetModeStatusEnum</link> arg1,
<link linkend="CalModeEnum">CalModeEnum</link> arg2,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para>
@:
@:
@:</refsect2><refsect2><title><anchor id="ECal-categories-changed"/>The "categories-changed" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="ECal">ECal</link> *ecal,
<link linkend="gpointer">gpointer</link> arg1,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para>
@:
@:</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>
|