← 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-entry.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-entry.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="ENameSelectorEntry">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="ENameSelectorEntry.top_of_page">ENameSelectorEntry</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVERUI Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>ENameSelectorEntry</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="ENameSelectorEntry.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>#define             <link linkend="MINIMUM-QUERY-LENGTH:CAPS">MINIMUM_QUERY_LENGTH</link>
21
 
#define             <link linkend="FORCE-SHOW-ADDRESS:CAPS">FORCE_SHOW_ADDRESS</link>
22
 
#define             <link linkend="USER-QUERY-FIELDS:CAPS">USER_QUERY_FIELDS</link>
23
 
                    <link linkend="ENameSelectorEntry-struct">ENameSelectorEntry</link>;
24
 
<link linkend="ENameSelectorEntry"><returnvalue>ENameSelectorEntry</returnvalue></link> * <link linkend="e-name-selector-entry-new">e_name_selector_entry_new</link>          (<parameter><type>void</type></parameter>);
25
 
<link linkend="EContactStore"><returnvalue>EContactStore</returnvalue></link> *     <link linkend="e-name-selector-entry-peek-contact-store">e_name_selector_entry_peek_contact_store</link>
26
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>);
27
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-name-selector-entry-set-contact-store">e_name_selector_entry_set_contact_store</link>
28
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
29
 
                                                         <parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>);
30
 
<link linkend="EDestinationStore"><returnvalue>EDestinationStore</returnvalue></link> * <link linkend="e-name-selector-entry-peek-destination-store">e_name_selector_entry_peek_destination_store</link>
31
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>);
32
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-name-selector-entry-set-destination-store">e_name_selector_entry_set_destination_store</link>
33
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</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-entry-set-contact-editor-func">e_name_selector_entry_set_contact_editor_func</link>
36
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
37
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> func</parameter>);
38
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-name-selector-entry-set-contact-list-editor-func">e_name_selector_entry_set_contact_list_editor_func</link>
39
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
40
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> func</parameter>);
41
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="ens-util-populate-user-query-fields">ens_util_populate_user_query_fields</link> (<parameter><link linkend="GSList"><type>GSList</type></link> *user_query_fields</parameter>,
42
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *cue_str</parameter>,
43
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *encoded_cue_str</parameter>);
44
 
</synopsis>
45
 
</refsynopsisdiv>
46
 
<refsect1 id="ENameSelectorEntry.object-hierarchy" role="object_hierarchy">
47
 
<title role="object_hierarchy.title">Object Hierarchy</title>
48
 
<synopsis>
49
 
  <link linkend="GObject">GObject</link>
50
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
51
 
         +----<link linkend="GtkObject">GtkObject</link>
52
 
               +----<link linkend="GtkWidget">GtkWidget</link>
53
 
                     +----<link linkend="GtkEntry">GtkEntry</link>
54
 
                           +----ENameSelectorEntry
55
 
                                 +----<link linkend="ENameSelectorList">ENameSelectorList</link>
56
 
</synopsis>
57
 
</refsect1>
58
 
<refsect1 id="ENameSelectorEntry.implemented-interfaces" role="impl_interfaces">
59
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
60
 
<para>
61
 
ENameSelectorEntry implements
62
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkEditable">GtkEditable</link> and  <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
63
 
</refsect1>
64
 
<refsect1 id="ENameSelectorEntry.signals" role="signal_proto">
65
 
<title role="signal_proto.title">Signals</title>
66
 
<synopsis>
67
 
  &quot;<link linkend="ENameSelectorEntry-updated">updated</link>&quot;                                        : Run First
68
 
</synopsis>
69
 
</refsect1>
70
 
 
71
 
<refsect1 id="ENameSelectorEntry.description" role="desc">
72
 
<title role="desc.title">Description</title>
73
 
<para>
74
 
</para>
75
 
</refsect1>
76
 
<refsect1 id="ENameSelectorEntry.details" role="details">
77
 
<title role="details.title">Details</title>
78
 
<refsect2 id="MINIMUM-QUERY-LENGTH:CAPS" role="macro">
79
 
<title>MINIMUM_QUERY_LENGTH</title>
80
 
<indexterm zone="MINIMUM-QUERY-LENGTH:CAPS"><primary>MINIMUM_QUERY_LENGTH</primary></indexterm>
81
 
<programlisting>#define MINIMUM_QUERY_LENGTH "/apps/evolution/addressbook/completion/minimum_query_length"
82
 
</programlisting>
83
 
<para>
84
 
</para></refsect2>
85
 
<refsect2 id="FORCE-SHOW-ADDRESS:CAPS" role="macro">
86
 
<title>FORCE_SHOW_ADDRESS</title>
87
 
<indexterm zone="FORCE-SHOW-ADDRESS:CAPS"><primary>FORCE_SHOW_ADDRESS</primary></indexterm>
88
 
<programlisting>#define FORCE_SHOW_ADDRESS   "/apps/evolution/addressbook/completion/show_address"
89
 
</programlisting>
90
 
<para>
91
 
</para></refsect2>
92
 
<refsect2 id="USER-QUERY-FIELDS:CAPS" role="macro">
93
 
<title>USER_QUERY_FIELDS</title>
94
 
<indexterm zone="USER-QUERY-FIELDS:CAPS"><primary>USER_QUERY_FIELDS</primary></indexterm>
95
 
<programlisting>#define USER_QUERY_FIELDS "/apps/evolution/addressbook/completion/user_query_fields"
96
 
</programlisting>
97
 
<para>
98
 
</para></refsect2>
99
 
<refsect2 id="ENameSelectorEntry-struct" role="struct">
100
 
<title>ENameSelectorEntry</title>
101
 
<indexterm zone="ENameSelectorEntry-struct"><primary>ENameSelectorEntry</primary></indexterm>
102
 
<programlisting>typedef struct _ENameSelectorEntry ENameSelectorEntry;</programlisting>
103
 
<para>
104
 
</para></refsect2>
105
 
<refsect2 id="e-name-selector-entry-new" role="function">
106
 
<title>e_name_selector_entry_new ()</title>
107
 
<indexterm zone="e-name-selector-entry-new"><primary>e_name_selector_entry_new</primary></indexterm>
108
 
<programlisting><link linkend="ENameSelectorEntry"><returnvalue>ENameSelectorEntry</returnvalue></link> * e_name_selector_entry_new          (<parameter><type>void</type></parameter>);</programlisting>
109
 
<para>
110
 
Creates a new <link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link>.</para>
111
 
<variablelist role="params">
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link>.
113
 
</simpara></listitem></varlistentry>
114
 
</variablelist></refsect2>
115
 
<refsect2 id="e-name-selector-entry-peek-contact-store" role="function">
116
 
<title>e_name_selector_entry_peek_contact_store ()</title>
117
 
<indexterm zone="e-name-selector-entry-peek-contact-store"><primary>e_name_selector_entry_peek_contact_store</primary></indexterm>
118
 
<programlisting><link linkend="EContactStore"><returnvalue>EContactStore</returnvalue></link> *     e_name_selector_entry_peek_contact_store
119
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>);</programlisting>
120
 
<para>
121
 
Gets the <link linkend="EContactStore"><type>EContactStore</type></link> being used by <parameter>name_selector_entry</parameter>.</para>
122
 
<variablelist role="params">
123
 
<varlistentry><term><parameter>name_selector_entry</parameter>&#160;:</term>
124
 
<listitem><simpara>an <link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link>
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EContactStore"><type>EContactStore</type></link>.
127
 
</simpara></listitem></varlistentry>
128
 
</variablelist></refsect2>
129
 
<refsect2 id="e-name-selector-entry-set-contact-store" role="function">
130
 
<title>e_name_selector_entry_set_contact_store ()</title>
131
 
<indexterm zone="e-name-selector-entry-set-contact-store"><primary>e_name_selector_entry_set_contact_store</primary></indexterm>
132
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_name_selector_entry_set_contact_store
133
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
134
 
                                                         <parameter><link linkend="EContactStore"><type>EContactStore</type></link> *contact_store</parameter>);</programlisting>
135
 
<para>
136
 
Sets the <link linkend="EContactStore"><type>EContactStore</type></link> being used by <parameter>name_selector_entry</parameter> to <parameter>contact_store</parameter>.</para>
137
 
<variablelist role="params">
138
 
<varlistentry><term><parameter>name_selector_entry</parameter>&#160;:</term>
139
 
<listitem><simpara>an <link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link>
140
 
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><parameter>contact_store</parameter>&#160;:</term>
142
 
<listitem><simpara>an <link linkend="EContactStore"><type>EContactStore</type></link> to use
143
 
</simpara></listitem></varlistentry>
144
 
</variablelist></refsect2>
145
 
<refsect2 id="e-name-selector-entry-peek-destination-store" role="function">
146
 
<title>e_name_selector_entry_peek_destination_store ()</title>
147
 
<indexterm zone="e-name-selector-entry-peek-destination-store"><primary>e_name_selector_entry_peek_destination_store</primary></indexterm>
148
 
<programlisting><link linkend="EDestinationStore"><returnvalue>EDestinationStore</returnvalue></link> * e_name_selector_entry_peek_destination_store
149
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>);</programlisting>
150
 
<para>
151
 
Gets the <link linkend="EDestinationStore"><type>EDestinationStore</type></link> being used to store <parameter>name_selector_entry</parameter>'s destinations.</para>
152
 
<variablelist role="params">
153
 
<varlistentry><term><parameter>name_selector_entry</parameter>&#160;:</term>
154
 
<listitem><simpara>an <link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link>
155
 
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EDestinationStore"><type>EDestinationStore</type></link>.
157
 
</simpara></listitem></varlistentry>
158
 
</variablelist></refsect2>
159
 
<refsect2 id="e-name-selector-entry-set-destination-store" role="function">
160
 
<title>e_name_selector_entry_set_destination_store ()</title>
161
 
<indexterm zone="e-name-selector-entry-set-destination-store"><primary>e_name_selector_entry_set_destination_store</primary></indexterm>
162
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_name_selector_entry_set_destination_store
163
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
164
 
                                                         <parameter><link linkend="EDestinationStore"><type>EDestinationStore</type></link> *destination_store</parameter>);</programlisting>
165
 
<para>
166
 
Sets <parameter>destination_store</parameter> as the <link linkend="EDestinationStore"><type>EDestinationStore</type></link> to be used to store
167
 
destinations for <parameter>name_selector_entry</parameter>.</para>
168
 
<variablelist role="params">
169
 
<varlistentry><term><parameter>name_selector_entry</parameter>&#160;:</term>
170
 
<listitem><simpara>an <link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link>
171
 
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>destination_store</parameter>&#160;:</term>
173
 
<listitem><simpara>an <link linkend="EDestinationStore"><type>EDestinationStore</type></link> to use
174
 
</simpara></listitem></varlistentry>
175
 
</variablelist></refsect2>
176
 
<refsect2 id="e-name-selector-entry-set-contact-editor-func" role="function">
177
 
<title>e_name_selector_entry_set_contact_editor_func ()</title>
178
 
<indexterm zone="e-name-selector-entry-set-contact-editor-func"><primary>e_name_selector_entry_set_contact_editor_func</primary></indexterm>
179
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_name_selector_entry_set_contact_editor_func
180
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
181
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> func</parameter>);</programlisting>
182
 
<para>
183
 
DO NOT USE.</para>
184
 
<variablelist role="params">
185
 
<varlistentry><term><parameter>name_selector_entry</parameter>&#160;:</term>
186
 
<listitem><simpara>
187
 
</simpara></listitem></varlistentry>
188
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
189
 
<listitem><simpara>
190
 
</simpara></listitem></varlistentry>
191
 
</variablelist></refsect2>
192
 
<refsect2 id="e-name-selector-entry-set-contact-list-editor-func" role="function">
193
 
<title>e_name_selector_entry_set_contact_list_editor_func ()</title>
194
 
<indexterm zone="e-name-selector-entry-set-contact-list-editor-func"><primary>e_name_selector_entry_set_contact_list_editor_func</primary></indexterm>
195
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_name_selector_entry_set_contact_list_editor_func
196
 
                                                        (<parameter><link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *name_selector_entry</parameter>,
197
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> func</parameter>);</programlisting>
198
 
<para>
199
 
DO NOT USE.</para>
200
 
<variablelist role="params">
201
 
<varlistentry><term><parameter>name_selector_entry</parameter>&#160;:</term>
202
 
<listitem><simpara>
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
205
 
<listitem><simpara>
206
 
</simpara></listitem></varlistentry>
207
 
</variablelist></refsect2>
208
 
<refsect2 id="ens-util-populate-user-query-fields" role="function">
209
 
<title>ens_util_populate_user_query_fields ()</title>
210
 
<indexterm zone="ens-util-populate-user-query-fields"><primary>ens_util_populate_user_query_fields</primary></indexterm>
211
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             ens_util_populate_user_query_fields (<parameter><link linkend="GSList"><type>GSList</type></link> *user_query_fields</parameter>,
212
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *cue_str</parameter>,
213
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *encoded_cue_str</parameter>);</programlisting>
214
 
<variablelist role="params">
215
 
<varlistentry><term><parameter>user_query_fields</parameter>&#160;:</term>
216
 
<listitem><simpara>
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>cue_str</parameter>&#160;:</term>
219
 
<listitem><simpara>
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><parameter>encoded_cue_str</parameter>&#160;:</term>
222
 
<listitem><simpara>
223
 
</simpara></listitem></varlistentry>
224
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
225
 
</simpara></listitem></varlistentry>
226
 
</variablelist></refsect2>
227
 
 
228
 
</refsect1>
229
 
<refsect1 id="ENameSelectorEntry.signal-details" role="signals">
230
 
<title role="signals.title">Signal Details</title>
231
 
<refsect2 id="ENameSelectorEntry-updated" role="signal"><title>The <literal>&quot;updated&quot;</literal> signal</title>
232
 
<indexterm zone="ENameSelectorEntry-updated"><primary>ENameSelectorEntry::updated</primary></indexterm>
233
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ENameSelectorEntry"><type>ENameSelectorEntry</type></link> *enameselectorentry,
234
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>            arg1,
235
 
                                                        <link linkend="gpointer"><type>gpointer</type></link>            user_data)               : Run First</programlisting>
236
 
<para>
237
 
</para><variablelist role="params">
238
 
<varlistentry><term><parameter>enameselectorentry</parameter>&#160;:</term>
239
 
<listitem><simpara>the object which received the signal.
240
 
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
242
 
<listitem><simpara>
243
 
</simpara></listitem></varlistentry>
244
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
245
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
246
 
</variablelist></refsect2>
247
 
</refsect1>
248
 
 
249
 
</refentry>