/usr/share/gtk-doc/html/libedataserverui/libedataserverui-ENameSelectorModel.html is in libedataserverui-3.0-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ENameSelectorModel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)">
<link rel="prev" href="libedataserverui-ENameSelectorList.html" title="ENameSelectorList">
<link rel="next" href="libedataserverui-e-passwords.html" title="e-passwords">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libedataserverui-ENameSelectorList.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)</th>
<td><a accesskey="n" href="libedataserverui-e-passwords.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserverui-ENameSelectorModel.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserverui-ENameSelectorModel.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserverui-ENameSelectorModel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserverui-ENameSelectorModel.top_of_page"></a>ENameSelectorModel</span></h2>
<p>ENameSelectorModel</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserverui-ENameSelectorModel.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel">ENameSelectorModel</a>;
<a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="returnvalue">ENameSelectorModel</span></a> * <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-new" title="e_name_selector_model_new ()">e_name_selector_model_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libedataserverui-EContactStore.html#EContactStore" title="struct EContactStore"><span class="returnvalue">EContactStore</span></a> * <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-peek-contact-store" title="e_name_selector_model_peek_contact_store ()">e_name_selector_model_peek_contact_store</a>
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>);
<a class="link" href="libedataserverui-ETreeModelGenerator.html#ETreeModelGenerator" title="struct ETreeModelGenerator"><span class="returnvalue">ETreeModelGenerator</span></a> * <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-peek-contact-filter" title="e_name_selector_model_peek_contact_filter ()">e_name_selector_model_peek_contact_filter</a>
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-list-sections" title="e_name_selector_model_list_sections ()">e_name_selector_model_list_sections</a> (<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-peek-section" title="e_name_selector_model_peek_section ()">e_name_selector_model_peek_section</a> (<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **pretty_name</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EDestinationStore.html#EDestinationStore" title="struct EDestinationStore"><span class="type">EDestinationStore</span></a> **destination_store</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-add-section" title="e_name_selector_model_add_section ()">e_name_selector_model_add_section</a> (<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pretty_name</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EDestinationStore.html#EDestinationStore" title="struct EDestinationStore"><span class="type">EDestinationStore</span></a> *destination_store</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-remove-section" title="e_name_selector_model_remove_section ()">e_name_selector_model_remove_section</a>
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-get-contact-emails-without-used" title="e_name_selector_model_get_contact_emails_without_used ()">e_name_selector_model_get_contact_emails_without_used</a>
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code><span class="type">EContact</span> *contact</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> remove_used</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserverui-ENameSelectorModel.html#e-name-selector-model-free-emails-list" title="e_name_selector_model_free_emails_list ()">e_name_selector_model_free_emails_list</a>
(<em class="parameter"><code><span class="type">GList</span> *email_list</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserverui-ENameSelectorModel.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserverui-ENameSelectorModel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ENameSelectorModel"></a><h3>struct ENameSelectorModel</h3>
<pre class="programlisting">struct ENameSelectorModel {
GObject parent;
ENameSelectorModelPrivate *priv;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-new"></a><h3>e_name_selector_model_new ()</h3>
<pre class="programlisting"><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="returnvalue">ENameSelectorModel</span></a> * e_name_selector_model_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-peek-contact-store"></a><h3>e_name_selector_model_peek_contact_store ()</h3>
<pre class="programlisting"><a class="link" href="libedataserverui-EContactStore.html#EContactStore" title="struct EContactStore"><span class="returnvalue">EContactStore</span></a> * e_name_selector_model_peek_contact_store
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>);</pre>
<p>
Gets the <a class="link" href="libedataserverui-EContactStore.html#EContactStore" title="struct EContactStore"><span class="type">EContactStore</span></a> associated with <em class="parameter"><code>name_selector_model</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libedataserverui-EContactStore.html#EContactStore" title="struct EContactStore"><span class="type">EContactStore</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-peek-contact-filter"></a><h3>e_name_selector_model_peek_contact_filter ()</h3>
<pre class="programlisting"><a class="link" href="libedataserverui-ETreeModelGenerator.html#ETreeModelGenerator" title="struct ETreeModelGenerator"><span class="returnvalue">ETreeModelGenerator</span></a> * e_name_selector_model_peek_contact_filter
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>);</pre>
<p>
Gets the <a class="link" href="libedataserverui-ETreeModelGenerator.html#ETreeModelGenerator" title="struct ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a> being used to filter and/or extend the
list of contacts in <em class="parameter"><code>name_selector_model</code></em>'s <a class="link" href="libedataserverui-EContactStore.html#EContactStore" title="struct EContactStore"><span class="type">EContactStore</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libedataserverui-ETreeModelGenerator.html#ETreeModelGenerator" title="struct ETreeModelGenerator"><span class="type">ETreeModelGenerator</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-list-sections"></a><h3>e_name_selector_model_list_sections ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * e_name_selector_model_list_sections (<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>);</pre>
<p>
Gets a list of the destination sections in <em class="parameter"><code>name_selector_model</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">GList</span> of pointers to strings. The <span class="type">GList</span> and the
strings belong to the caller, and must be freed when no longer needed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-peek-section"></a><h3>e_name_selector_model_peek_section ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_name_selector_model_peek_section (<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **pretty_name</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EDestinationStore.html#EDestinationStore" title="struct EDestinationStore"><span class="type">EDestinationStore</span></a> **destination_store</code></em>);</pre>
<p>
Gets the parameters for a destination section.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>internal name of the section to peek</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pretty_name</code></em> :</span></p></td>
<td>location in which to store a pointer to the user-visible name of the section,
or <code class="literal">NULL</code> if undesired.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destination_store</code></em> :</span></p></td>
<td>location in which to store a pointer to the <a class="link" href="libedataserverui-EDestinationStore.html#EDestinationStore" title="struct EDestinationStore"><span class="type">EDestinationStore</span></a> being used
by the section, or <code class="literal">NULL</code> if undesired</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-add-section"></a><h3>e_name_selector_model_add_section ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_name_selector_model_add_section (<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pretty_name</code></em>,
<em class="parameter"><code><a class="link" href="libedataserverui-EDestinationStore.html#EDestinationStore" title="struct EDestinationStore"><span class="type">EDestinationStore</span></a> *destination_store</code></em>);</pre>
<p>
Adds a destination section to <em class="parameter"><code>name_selector_model</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>internal name of this section</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pretty_name</code></em> :</span></p></td>
<td>user-visible name of this section</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destination_store</code></em> :</span></p></td>
<td>the <a class="link" href="libedataserverui-EDestinationStore.html#EDestinationStore" title="struct EDestinationStore"><span class="type">EDestinationStore</span></a> to use to store the destinations for this
section, or <code class="literal">NULL</code> if <em class="parameter"><code>name_selector_model</code></em> should create its own.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-remove-section"></a><h3>e_name_selector_model_remove_section ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_name_selector_model_remove_section
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Removes a destination section from <em class="parameter"><code>name_selector_model</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>internal name of the section to remove</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-get-contact-emails-without-used"></a><h3>e_name_selector_model_get_contact_emails_without_used ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * e_name_selector_model_get_contact_emails_without_used
(<em class="parameter"><code><a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a> *name_selector_model</code></em>,
<em class="parameter"><code><span class="type">EContact</span> *contact</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> remove_used</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name_selector_model</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserverui-ENameSelectorModel.html#ENameSelectorModel" title="struct ENameSelectorModel"><span class="type">ENameSelectorModel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
<td>to get emails from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remove_used</code></em> :</span></p></td>
<td>set to <code class="literal">TRUE</code> to remove used from a list; or set to <code class="literal">FALSE</code> to
set used indexes to <code class="literal">NULL</code> and keep them in the returned list</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>list of all email from <em class="parameter"><code>contact</code></em>, without all used
in any section. Each item is a string, an email address.
Returned list should be freed with <em class="parameter"><code>e_name_selector_model_free_emails_list</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="e-name-selector-model-free-emails-list"></a><h3>e_name_selector_model_free_emails_list ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_name_selector_model_free_emails_list
(<em class="parameter"><code><span class="type">GList</span> *email_list</code></em>);</pre>
<p>
Frees a list of emails returned from <em class="parameter"><code>e_name_selector_model_get_contact_emails_without_used</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>email_list</code></em> :</span></p></td>
<td>list of emails returned from <em class="parameter"><code>e_name_selector_model_get_contact_emails_without_used</code></em>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|