~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libecal/xml/e-cal-view-listener.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="ECalViewListener">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="ECalViewListener.top_of_page">ECalViewListener</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBECAL Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>ECalViewListener</refname>
14
 
<refpurpose>Listens for responses and event notifications sent by <link linkend="e-cal-view"><type>e-cal-view</type></link>.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="ECalViewListener.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="ECalViewListener-struct">ECalViewListener</link>;
21
 
<link linkend="ECalViewListener"><returnvalue>ECalViewListener</returnvalue></link> *  <link linkend="e-cal-view-listener-new">e_cal_view_listener_new</link>             (<parameter><type>void</type></parameter>);
22
 
</synopsis>
23
 
</refsynopsisdiv>
24
 
<refsect1 id="ECalViewListener.object-hierarchy" role="object_hierarchy">
25
 
<title role="object_hierarchy.title">Object Hierarchy</title>
26
 
<synopsis>
27
 
  <link linkend="GObject">GObject</link>
28
 
   +----<link linkend="BonoboObject">BonoboObject</link>
29
 
         +----ECalViewListener
30
 
</synopsis>
31
 
</refsect1>
32
 
<refsect1 id="ECalViewListener.signals" role="signal_proto">
33
 
<title role="signal_proto.title">Signals</title>
34
 
<synopsis>
35
 
  &quot;<link linkend="ECalViewListener-objects-added">objects-added</link>&quot;                                  : Run First
36
 
  &quot;<link linkend="ECalViewListener-objects-modified">objects-modified</link>&quot;                               : Run First
37
 
  &quot;<link linkend="ECalViewListener-objects-removed">objects-removed</link>&quot;                                : Run First
38
 
  &quot;<link linkend="ECalViewListener-view-done">view-done</link>&quot;                                      : Run First
39
 
  &quot;<link linkend="ECalViewListener-view-progress">view-progress</link>&quot;                                  : Run First
40
 
</synopsis>
41
 
</refsect1>
42
 
 
43
 
<refsect1 id="ECalViewListener.description" role="desc">
44
 
<title role="desc.title">Description</title>
45
 
<para>
46
 
</para>
47
 
</refsect1>
48
 
<refsect1 id="ECalViewListener.details" role="details">
49
 
<title role="details.title">Details</title>
50
 
<refsect2 id="ECalViewListener-struct" role="struct">
51
 
<title>ECalViewListener</title>
52
 
<indexterm zone="ECalViewListener-struct"><primary>ECalViewListener</primary></indexterm>
53
 
<programlisting>typedef struct _ECalViewListener ECalViewListener;</programlisting>
54
 
<para>
55
 
</para></refsect2>
56
 
<refsect2 id="e-cal-view-listener-new" role="function">
57
 
<title>e_cal_view_listener_new ()</title>
58
 
<indexterm zone="e-cal-view-listener-new"><primary>e_cal_view_listener_new</primary></indexterm>
59
 
<programlisting><link linkend="ECalViewListener"><returnvalue>ECalViewListener</returnvalue></link> *  e_cal_view_listener_new             (<parameter><type>void</type></parameter>);</programlisting>
60
 
<para>
61
 
Creates a new ECalViewListener object.</para>
62
 
<variablelist role="params">
63
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created ECalViewListener.
64
 
</simpara></listitem></varlistentry>
65
 
</variablelist></refsect2>
66
 
 
67
 
</refsect1>
68
 
<refsect1 id="ECalViewListener.signal-details" role="signals">
69
 
<title role="signals.title">Signal Details</title>
70
 
<refsect2 id="ECalViewListener-objects-added" role="signal"><title>The <literal>&quot;objects-added&quot;</literal> signal</title>
71
 
<indexterm zone="ECalViewListener-objects-added"><primary>ECalViewListener::objects-added</primary></indexterm>
72
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalViewListener"><type>ECalViewListener</type></link> *ecalviewlistener,
73
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          arg1,
74
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          user_data)             : Run First</programlisting>
75
 
<para>
76
 
</para><variablelist role="params">
77
 
<varlistentry><term><parameter>ecalviewlistener</parameter>&#160;:</term>
78
 
<listitem><simpara>the object which received the signal.
79
 
</simpara></listitem></varlistentry>
80
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
81
 
<listitem><simpara>
82
 
</simpara></listitem></varlistentry>
83
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
84
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
85
 
</variablelist></refsect2><refsect2 id="ECalViewListener-objects-modified" role="signal"><title>The <literal>&quot;objects-modified&quot;</literal> signal</title>
86
 
<indexterm zone="ECalViewListener-objects-modified"><primary>ECalViewListener::objects-modified</primary></indexterm>
87
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalViewListener"><type>ECalViewListener</type></link> *ecalviewlistener,
88
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          arg1,
89
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          user_data)             : Run First</programlisting>
90
 
<para>
91
 
</para><variablelist role="params">
92
 
<varlistentry><term><parameter>ecalviewlistener</parameter>&#160;:</term>
93
 
<listitem><simpara>the object which received the signal.
94
 
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
96
 
<listitem><simpara>
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
99
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
100
 
</variablelist></refsect2><refsect2 id="ECalViewListener-objects-removed" role="signal"><title>The <literal>&quot;objects-removed&quot;</literal> signal</title>
101
 
<indexterm zone="ECalViewListener-objects-removed"><primary>ECalViewListener::objects-removed</primary></indexterm>
102
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalViewListener"><type>ECalViewListener</type></link> *ecalviewlistener,
103
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          arg1,
104
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          user_data)             : Run First</programlisting>
105
 
<para>
106
 
</para><variablelist role="params">
107
 
<varlistentry><term><parameter>ecalviewlistener</parameter>&#160;:</term>
108
 
<listitem><simpara>the object which received the signal.
109
 
</simpara></listitem></varlistentry>
110
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
111
 
<listitem><simpara>
112
 
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
114
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2><refsect2 id="ECalViewListener-view-done" role="signal"><title>The <literal>&quot;view-done&quot;</literal> signal</title>
116
 
<indexterm zone="ECalViewListener-view-done"><primary>ECalViewListener::view-done</primary></indexterm>
117
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalViewListener"><type>ECalViewListener</type></link> *ecalviewlistener,
118
 
                                                        <link linkend="gint"><type>gint</type></link>              arg1,
119
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          user_data)             : Run First</programlisting>
120
 
<para>
121
 
</para><variablelist role="params">
122
 
<varlistentry><term><parameter>ecalviewlistener</parameter>&#160;:</term>
123
 
<listitem><simpara>the object which received the signal.
124
 
</simpara></listitem></varlistentry>
125
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
126
 
<listitem><simpara>
127
 
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
129
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
130
 
</variablelist></refsect2><refsect2 id="ECalViewListener-view-progress" role="signal"><title>The <literal>&quot;view-progress&quot;</literal> signal</title>
131
 
<indexterm zone="ECalViewListener-view-progress"><primary>ECalViewListener::view-progress</primary></indexterm>
132
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ECalViewListener"><type>ECalViewListener</type></link> *ecalviewlistener,
133
 
                                                        <link linkend="gchar"><type>gchar</type></link>            *arg1,
134
 
                                                        <link linkend="gint"><type>gint</type></link>              arg2,
135
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>          user_data)             : Run First</programlisting>
136
 
<para>
137
 
</para><variablelist role="params">
138
 
<varlistentry><term><parameter>ecalviewlistener</parameter>&#160;:</term>
139
 
<listitem><simpara>the object which received the signal.
140
 
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
142
 
<listitem><simpara>
143
 
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
145
 
<listitem><simpara>
146
 
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
148
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
149
 
</variablelist></refsect2>
150
 
</refsect1>
151
 
<refsect1 id="ECalViewListener.see-also">
152
 
<title>See Also</title>
153
 
<para>
154
 
<link linkend="e-cal-view"><type>e-cal-view</type></link>
155
 
</para>
156
 
</refsect1>
157
 
 
158
 
</refentry>