← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-iterator.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.10.5 upstream)
  • mto: This revision was merged to the branch mainline in revision 128.
  • Revision ID: james.westby@ubuntu.com-20100517170206-xu1wmjuy40nt2sk0
Tags: upstream-2.30.1
Import upstream version 2.30.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/xml/e-iterator.xml
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="EIterator">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EIterator.top_of_page">EIterator</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVER Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EIterator</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="EIterator.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="EIterator-struct">EIterator</link>;
21
 
const <link linkend="void"><returnvalue>void</returnvalue></link> *        <link linkend="e-iterator-get">e_iterator_get</link>                      (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
22
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-iterator-reset">e_iterator_reset</link>                    (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
23
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-iterator-last">e_iterator_last</link>                     (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
24
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-iterator-next">e_iterator_next</link>                     (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
25
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-iterator-prev">e_iterator_prev</link>                     (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
26
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-iterator-delete">e_iterator_delete</link>                   (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
27
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-iterator-insert">e_iterator_insert</link>                   (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>,
28
 
                                                         <parameter><link linkend="gconstpointer"><type>gconstpointer</type></link> object</parameter>,
29
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> before</parameter>);
30
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-iterator-set">e_iterator_set</link>                      (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>,
31
 
                                                         <parameter><link linkend="gconstpointer"><type>gconstpointer</type></link> object</parameter>);
32
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-iterator-is-valid">e_iterator_is_valid</link>                 (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
33
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-iterator-invalidate">e_iterator_invalidate</link>               (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);
34
 
</synopsis>
35
 
</refsynopsisdiv>
36
 
<refsect1 id="EIterator.object-hierarchy" role="object_hierarchy">
37
 
<title role="object_hierarchy.title">Object Hierarchy</title>
38
 
<synopsis>
39
 
  <link linkend="GObject">GObject</link>
40
 
   +----EIterator
41
 
         +----<link linkend="EListIterator">EListIterator</link>
42
 
</synopsis>
43
 
</refsect1>
44
 
<refsect1 id="EIterator.signals" role="signal_proto">
45
 
<title role="signal_proto.title">Signals</title>
46
 
<synopsis>
47
 
  &quot;<link linkend="EIterator-invalidate">invalidate</link>&quot;                                     : Run Last
48
 
</synopsis>
49
 
</refsect1>
50
 
 
51
 
<refsect1 id="EIterator.description" role="desc">
52
 
<title role="desc.title">Description</title>
53
 
<para>
54
 
</para>
55
 
</refsect1>
56
 
<refsect1 id="EIterator.details" role="details">
57
 
<title role="details.title">Details</title>
58
 
<refsect2 id="EIterator-struct" role="struct">
59
 
<title>EIterator</title>
60
 
<indexterm zone="EIterator-struct"><primary>EIterator</primary></indexterm>
61
 
<programlisting>typedef struct _EIterator EIterator;</programlisting>
62
 
<para>
63
 
</para></refsect2>
64
 
<refsect2 id="e-iterator-get" role="function">
65
 
<title>e_iterator_get ()</title>
66
 
<indexterm zone="e-iterator-get"><primary>e_iterator_get</primary></indexterm>
67
 
<programlisting>const <link linkend="void"><returnvalue>void</returnvalue></link> *        e_iterator_get                      (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
68
 
<para>
69
 
</para><variablelist role="params">
70
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
71
 
<listitem><simpara>
72
 
</simpara></listitem></varlistentry>
73
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
74
 
</simpara></listitem></varlistentry>
75
 
</variablelist></refsect2>
76
 
<refsect2 id="e-iterator-reset" role="function">
77
 
<title>e_iterator_reset ()</title>
78
 
<indexterm zone="e-iterator-reset"><primary>e_iterator_reset</primary></indexterm>
79
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_iterator_reset                    (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
80
 
<para>
81
 
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
83
 
<listitem><simpara>
84
 
</simpara></listitem></varlistentry>
85
 
</variablelist></refsect2>
86
 
<refsect2 id="e-iterator-last" role="function">
87
 
<title>e_iterator_last ()</title>
88
 
<indexterm zone="e-iterator-last"><primary>e_iterator_last</primary></indexterm>
89
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_iterator_last                     (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
90
 
<para>
91
 
</para><variablelist role="params">
92
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
93
 
<listitem><simpara>
94
 
</simpara></listitem></varlistentry>
95
 
</variablelist></refsect2>
96
 
<refsect2 id="e-iterator-next" role="function">
97
 
<title>e_iterator_next ()</title>
98
 
<indexterm zone="e-iterator-next"><primary>e_iterator_next</primary></indexterm>
99
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_iterator_next                     (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
100
 
<para>
101
 
</para><variablelist role="params">
102
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
103
 
<listitem><simpara>
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
106
 
</simpara></listitem></varlistentry>
107
 
</variablelist></refsect2>
108
 
<refsect2 id="e-iterator-prev" role="function">
109
 
<title>e_iterator_prev ()</title>
110
 
<indexterm zone="e-iterator-prev"><primary>e_iterator_prev</primary></indexterm>
111
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_iterator_prev                     (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
112
 
<para>
113
 
</para><variablelist role="params">
114
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
115
 
<listitem><simpara>
116
 
</simpara></listitem></varlistentry>
117
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
118
 
</simpara></listitem></varlistentry>
119
 
</variablelist></refsect2>
120
 
<refsect2 id="e-iterator-delete" role="function">
121
 
<title>e_iterator_delete ()</title>
122
 
<indexterm zone="e-iterator-delete"><primary>e_iterator_delete</primary></indexterm>
123
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_iterator_delete                   (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
124
 
<para>
125
 
</para><variablelist role="params">
126
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
127
 
<listitem><simpara>
128
 
</simpara></listitem></varlistentry>
129
 
</variablelist></refsect2>
130
 
<refsect2 id="e-iterator-insert" role="function">
131
 
<title>e_iterator_insert ()</title>
132
 
<indexterm zone="e-iterator-insert"><primary>e_iterator_insert</primary></indexterm>
133
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_iterator_insert                   (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>,
134
 
                                                         <parameter><link linkend="gconstpointer"><type>gconstpointer</type></link> object</parameter>,
135
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> before</parameter>);</programlisting>
136
 
<para>
137
 
</para><variablelist role="params">
138
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
139
 
<listitem><simpara>
140
 
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><parameter>object</parameter>&#160;:</term>
142
 
<listitem><simpara>
143
 
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>before</parameter>&#160;:</term>
145
 
<listitem><simpara>
146
 
</simpara></listitem></varlistentry>
147
 
</variablelist></refsect2>
148
 
<refsect2 id="e-iterator-set" role="function">
149
 
<title>e_iterator_set ()</title>
150
 
<indexterm zone="e-iterator-set"><primary>e_iterator_set</primary></indexterm>
151
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_iterator_set                      (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>,
152
 
                                                         <parameter><link linkend="gconstpointer"><type>gconstpointer</type></link> object</parameter>);</programlisting>
153
 
<para>
154
 
</para><variablelist role="params">
155
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
156
 
<listitem><simpara>
157
 
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>object</parameter>&#160;:</term>
159
 
<listitem><simpara>
160
 
</simpara></listitem></varlistentry>
161
 
</variablelist></refsect2>
162
 
<refsect2 id="e-iterator-is-valid" role="function">
163
 
<title>e_iterator_is_valid ()</title>
164
 
<indexterm zone="e-iterator-is-valid"><primary>e_iterator_is_valid</primary></indexterm>
165
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_iterator_is_valid                 (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
166
 
<para>
167
 
</para><variablelist role="params">
168
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
169
 
<listitem><simpara>
170
 
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
172
 
</simpara></listitem></varlistentry>
173
 
</variablelist></refsect2>
174
 
<refsect2 id="e-iterator-invalidate" role="function">
175
 
<title>e_iterator_invalidate ()</title>
176
 
<indexterm zone="e-iterator-invalidate"><primary>e_iterator_invalidate</primary></indexterm>
177
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_iterator_invalidate               (<parameter><link linkend="EIterator"><type>EIterator</type></link> *iterator</parameter>);</programlisting>
178
 
<para>
179
 
</para><variablelist role="params">
180
 
<varlistentry><term><parameter>iterator</parameter>&#160;:</term>
181
 
<listitem><simpara>
182
 
</simpara></listitem></varlistentry>
183
 
</variablelist></refsect2>
184
 
 
185
 
</refsect1>
186
 
<refsect1 id="EIterator.signal-details" role="signals">
187
 
<title role="signals.title">Signal Details</title>
188
 
<refsect2 id="EIterator-invalidate" role="signal"><title>The <literal>&quot;invalidate&quot;</literal> signal</title>
189
 
<indexterm zone="EIterator-invalidate"><primary>EIterator::invalidate</primary></indexterm>
190
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="EIterator"><type>EIterator</type></link> *eiterator,
191
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>   user_data)      : Run Last</programlisting>
192
 
<para>
193
 
</para><variablelist role="params">
194
 
<varlistentry><term><parameter>eiterator</parameter>&#160;:</term>
195
 
<listitem><simpara>the object which received the signal.
196
 
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
198
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
199
 
</variablelist></refsect2>
200
 
</refsect1>
201
 
 
202
 
</refentry>