← 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/libedataserverui/xml/e-name-selector-model.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
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* 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:
docs/reference/libedataserverui/xml/e-name-selector-model.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="ENameSelectorModel">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="ENameSelectorModel.top_of_page">ENameSelectorModel</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVERUI Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>ENameSelectorModel</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="ENameSelectorModel.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>                    <link linkend="ENameSelectorModel-struct">ENameSelectorModel</link>;
21
 
<link linkend="ENameSelectorModel"><returnvalue>ENameSelectorModel</returnvalue></link> * <link linkend="e-name-selector-model-new">e_name_selector_model_new</link>          (<parameter><type>void</type></parameter>);
22
 
<link linkend="EContactStore"><returnvalue>EContactStore</returnvalue></link> *     <link linkend="e-name-selector-model-peek-contact-store">e_name_selector_model_peek_contact_store</link>
23
 
                                                        (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>);
24
 
<link linkend="ETreeModelGenerator"><returnvalue>ETreeModelGenerator</returnvalue></link> * <link linkend="e-name-selector-model-peek-contact-filter">e_name_selector_model_peek_contact_filter</link>
25
 
                                                        (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>);
26
 
<link linkend="GList"><returnvalue>GList</returnvalue></link> *             <link linkend="e-name-selector-model-list-sections">e_name_selector_model_list_sections</link> (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>);
27
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-name-selector-model-peek-section">e_name_selector_model_peek_section</link>  (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>,
28
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
29
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **pretty_name</parameter>,
30
 
                                                         <parameter><link linkend="EDestinationStore"><type>EDestinationStore</type></link> **destination_store</parameter>);
31
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-name-selector-model-add-section">e_name_selector_model_add_section</link>   (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>,
32
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
33
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *pretty_name</parameter>,
34
 
                                                         <parameter><link linkend="EDestinationStore"><type>EDestinationStore</type></link> *destination_store</parameter>);
35
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-name-selector-model-remove-section">e_name_selector_model_remove_section</link>
36
 
                                                        (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>,
37
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
38
 
</synopsis>
39
 
</refsynopsisdiv>
40
 
<refsect1 id="ENameSelectorModel.object-hierarchy" role="object_hierarchy">
41
 
<title role="object_hierarchy.title">Object Hierarchy</title>
42
 
<synopsis>
43
 
  <link linkend="GObject">GObject</link>
44
 
   +----ENameSelectorModel
45
 
</synopsis>
46
 
</refsect1>
47
 
<refsect1 id="ENameSelectorModel.signals" role="signal_proto">
48
 
<title role="signal_proto.title">Signals</title>
49
 
<synopsis>
50
 
  &quot;<link linkend="ENameSelectorModel-section-added">section-added</link>&quot;                                  : Run Last
51
 
  &quot;<link linkend="ENameSelectorModel-section-removed">section-removed</link>&quot;                                : Run Last
52
 
</synopsis>
53
 
</refsect1>
54
 
 
55
 
<refsect1 id="ENameSelectorModel.description" role="desc">
56
 
<title role="desc.title">Description</title>
57
 
<para>
58
 
</para>
59
 
</refsect1>
60
 
<refsect1 id="ENameSelectorModel.details" role="details">
61
 
<title role="details.title">Details</title>
62
 
<refsect2 id="ENameSelectorModel-struct" role="struct">
63
 
<title>ENameSelectorModel</title>
64
 
<indexterm zone="ENameSelectorModel-struct"><primary>ENameSelectorModel</primary></indexterm>
65
 
<programlisting>typedef struct _ENameSelectorModel ENameSelectorModel;</programlisting>
66
 
<para>
67
 
</para></refsect2>
68
 
<refsect2 id="e-name-selector-model-new" role="function">
69
 
<title>e_name_selector_model_new ()</title>
70
 
<indexterm zone="e-name-selector-model-new"><primary>e_name_selector_model_new</primary></indexterm>
71
 
<programlisting><link linkend="ENameSelectorModel"><returnvalue>ENameSelectorModel</returnvalue></link> * e_name_selector_model_new          (<parameter><type>void</type></parameter>);</programlisting>
72
 
<para>
73
 
Creates a new <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>.</para>
74
 
<variablelist role="params">
75
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>.
76
 
</simpara></listitem></varlistentry>
77
 
</variablelist></refsect2>
78
 
<refsect2 id="e-name-selector-model-peek-contact-store" role="function">
79
 
<title>e_name_selector_model_peek_contact_store ()</title>
80
 
<indexterm zone="e-name-selector-model-peek-contact-store"><primary>e_name_selector_model_peek_contact_store</primary></indexterm>
81
 
<programlisting><link linkend="EContactStore"><returnvalue>EContactStore</returnvalue></link> *     e_name_selector_model_peek_contact_store
82
 
                                                        (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>);</programlisting>
83
 
<para>
84
 
Gets the <link linkend="EContactStore"><type>EContactStore</type></link> associated with <parameter>name_selector_model</parameter>.</para>
85
 
<variablelist role="params">
86
 
<varlistentry><term><parameter>name_selector_model</parameter>&#160;:</term>
87
 
<listitem><simpara>an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
88
 
</simpara></listitem></varlistentry>
89
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EContactStore"><type>EContactStore</type></link>.
90
 
</simpara></listitem></varlistentry>
91
 
</variablelist></refsect2>
92
 
<refsect2 id="e-name-selector-model-peek-contact-filter" role="function">
93
 
<title>e_name_selector_model_peek_contact_filter ()</title>
94
 
<indexterm zone="e-name-selector-model-peek-contact-filter"><primary>e_name_selector_model_peek_contact_filter</primary></indexterm>
95
 
<programlisting><link linkend="ETreeModelGenerator"><returnvalue>ETreeModelGenerator</returnvalue></link> * e_name_selector_model_peek_contact_filter
96
 
                                                        (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>);</programlisting>
97
 
<para>
98
 
Gets the <link linkend="ETreeModelGenerator"><type>ETreeModelGenerator</type></link> being used to filter and/or extend the
99
 
list of contacts in <parameter>name_selector_model</parameter>'s <link linkend="EContactStore"><type>EContactStore</type></link>.</para>
100
 
<variablelist role="params">
101
 
<varlistentry><term><parameter>name_selector_model</parameter>&#160;:</term>
102
 
<listitem><simpara>an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="ETreeModelGenerator"><type>ETreeModelGenerator</type></link>.
105
 
</simpara></listitem></varlistentry>
106
 
</variablelist></refsect2>
107
 
<refsect2 id="e-name-selector-model-list-sections" role="function">
108
 
<title>e_name_selector_model_list_sections ()</title>
109
 
<indexterm zone="e-name-selector-model-list-sections"><primary>e_name_selector_model_list_sections</primary></indexterm>
110
 
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> *             e_name_selector_model_list_sections (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>);</programlisting>
111
 
<para>
112
 
Gets a list of the destination sections in <parameter>name_selector_model</parameter>.</para>
113
 
<variablelist role="params">
114
 
<varlistentry><term><parameter>name_selector_model</parameter>&#160;:</term>
115
 
<listitem><simpara>an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
116
 
</simpara></listitem></varlistentry>
117
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to strings. The <link linkend="GList"><type>GList</type></link> and the
118
 
strings belong to the caller, and must be freed when no longer needed.
119
 
</simpara></listitem></varlistentry>
120
 
</variablelist></refsect2>
121
 
<refsect2 id="e-name-selector-model-peek-section" role="function">
122
 
<title>e_name_selector_model_peek_section ()</title>
123
 
<indexterm zone="e-name-selector-model-peek-section"><primary>e_name_selector_model_peek_section</primary></indexterm>
124
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_name_selector_model_peek_section  (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>,
125
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
126
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **pretty_name</parameter>,
127
 
                                                         <parameter><link linkend="EDestinationStore"><type>EDestinationStore</type></link> **destination_store</parameter>);</programlisting>
128
 
<para>
129
 
Gets the parameters for a destination section.</para>
130
 
<variablelist role="params">
131
 
<varlistentry><term><parameter>name_selector_model</parameter>&#160;:</term>
132
 
<listitem><simpara>an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
135
 
<listitem><simpara>internal name of the section to peek
136
 
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><parameter>pretty_name</parameter>&#160;:</term>
138
 
<listitem><simpara>location in which to store a pointer to the user-visible name of the section,
139
 
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if undesired.
140
 
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><parameter>destination_store</parameter>&#160;:</term>
142
 
<listitem><simpara>location in which to store a pointer to the <link linkend="EDestinationStore"><type>EDestinationStore</type></link> being used
143
 
by the section, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if undesired
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
146
 
</simpara></listitem></varlistentry>
147
 
</variablelist></refsect2>
148
 
<refsect2 id="e-name-selector-model-add-section" role="function">
149
 
<title>e_name_selector_model_add_section ()</title>
150
 
<indexterm zone="e-name-selector-model-add-section"><primary>e_name_selector_model_add_section</primary></indexterm>
151
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_name_selector_model_add_section   (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>,
152
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
153
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *pretty_name</parameter>,
154
 
                                                         <parameter><link linkend="EDestinationStore"><type>EDestinationStore</type></link> *destination_store</parameter>);</programlisting>
155
 
<para>
156
 
Adds a destination section to <parameter>name_selector_model</parameter>.</para>
157
 
<variablelist role="params">
158
 
<varlistentry><term><parameter>name_selector_model</parameter>&#160;:</term>
159
 
<listitem><simpara>an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
162
 
<listitem><simpara>internal name of this section
163
 
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><parameter>pretty_name</parameter>&#160;:</term>
165
 
<listitem><simpara>user-visible name of this section
166
 
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><parameter>destination_store</parameter>&#160;:</term>
168
 
<listitem><simpara>the <link linkend="EDestinationStore"><type>EDestinationStore</type></link> to use to store the destinations for this
169
 
section, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>name_selector_model</parameter> should create its own.
170
 
</simpara></listitem></varlistentry>
171
 
</variablelist></refsect2>
172
 
<refsect2 id="e-name-selector-model-remove-section" role="function">
173
 
<title>e_name_selector_model_remove_section ()</title>
174
 
<indexterm zone="e-name-selector-model-remove-section"><primary>e_name_selector_model_remove_section</primary></indexterm>
175
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_name_selector_model_remove_section
176
 
                                                        (<parameter><link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *name_selector_model</parameter>,
177
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
178
 
<para>
179
 
Removes a destination section from <parameter>name_selector_model</parameter>.</para>
180
 
<variablelist role="params">
181
 
<varlistentry><term><parameter>name_selector_model</parameter>&#160;:</term>
182
 
<listitem><simpara>an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
183
 
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
185
 
<listitem><simpara>internal name of the section to remove
186
 
</simpara></listitem></varlistentry>
187
 
</variablelist></refsect2>
188
 
 
189
 
</refsect1>
190
 
<refsect1 id="ENameSelectorModel.signal-details" role="signals">
191
 
<title role="signals.title">Signal Details</title>
192
 
<refsect2 id="ENameSelectorModel-section-added" role="signal"><title>The <literal>&quot;section-added&quot;</literal> signal</title>
193
 
<indexterm zone="ENameSelectorModel-section-added"><primary>ENameSelectorModel::section-added</primary></indexterm>
194
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *enameselectormodel,
195
 
                                                        <link linkend="gchar"><type>gchar</type></link>              *arg1,
196
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>            user_data)               : Run Last</programlisting>
197
 
<para>
198
 
</para><variablelist role="params">
199
 
<varlistentry><term><parameter>enameselectormodel</parameter>&#160;:</term>
200
 
<listitem><simpara>the object which received the signal.
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
203
 
<listitem><simpara>
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
206
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
207
 
</variablelist></refsect2><refsect2 id="ENameSelectorModel-section-removed" role="signal"><title>The <literal>&quot;section-removed&quot;</literal> signal</title>
208
 
<indexterm zone="ENameSelectorModel-section-removed"><primary>ENameSelectorModel::section-removed</primary></indexterm>
209
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link> *enameselectormodel,
210
 
                                                        <link linkend="gchar"><type>gchar</type></link>              *arg1,
211
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>            user_data)               : Run Last</programlisting>
212
 
<para>
213
 
</para><variablelist role="params">
214
 
<varlistentry><term><parameter>enameselectormodel</parameter>&#160;:</term>
215
 
<listitem><simpara>the object which received the signal.
216
 
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
218
 
<listitem><simpara>
219
 
</simpara></listitem></varlistentry>
220
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
221
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
222
 
</variablelist></refsect2>
223
 
</refsect1>
224
 
 
225
 
</refentry>