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
214
215
216
|
<?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>
"<link linkend="ECalView--client">client</link>" <link linkend="ECal">ECal</link>* : Read / Write / Construct Only
"<link linkend="ECalView--listener">listener</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="ECalView--view">view</link>" <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>
"<link linkend="ECalView-objects-added">objects-added</link>" : Run First
"<link linkend="ECalView-objects-modified">objects-modified</link>" : Run First
"<link linkend="ECalView-objects-removed">objects-removed</link>" : Run First
"<link linkend="ECalView-view-done">view-done</link>" : Run First
"<link linkend="ECalView-view-progress">view-progress</link>" : 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> :</term>
<listitem><simpara> A <link linkend="ECalView"><type>ECalView</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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> :</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>"client"</literal> property</title>
<indexterm zone="ECalView--client"><primary>ECalView:client</primary></indexterm><programlisting> "client" <link linkend="ECal">ECal</link>* : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2 id="ECalView--listener"><title>The <literal>"listener"</literal> property</title>
<indexterm zone="ECalView--listener"><primary>ECalView:listener</primary></indexterm><programlisting> "listener" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2 id="ECalView--view"><title>The <literal>"view"</literal> property</title>
<indexterm zone="ECalView--view"><primary>ECalView:view</primary></indexterm><programlisting> "view" <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>"objects-added"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</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>"objects-modified"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</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>"objects-removed"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</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>"view-done"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</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>"view-progress"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</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>
|
