/usr/share/gtk-doc/html/eds/eds-ESourceBackendSummarySetup.html is in evolution-data-server-doc 3.18.5-1ubuntu1.
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 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceBackendSummarySetup: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch02.html" title="Data Source Extensions">
<link rel="prev" href="eds-ESourceWebdav.html" title="ESourceWebdav">
<link rel="next" href="client.html" title="Part II. Client Programming Interfaces">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#eds-ESourceBackendSummarySetup.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-ESourceWebdav.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="client.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-ESourceBackendSummarySetup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-ESourceBackendSummarySetup.top_of_page"></a>ESourceBackendSummarySetup</span></h2>
<p>ESourceBackendSummarySetup — <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension to configure summary fields</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-ESourceBackendSummarySetup.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="returnvalue">EContactField</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-get-summary-fields" title="e_source_backend_summary_setup_get_summary_fields ()">e_source_backend_summary_setup_get_summary_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-set-summary-fieldsv" title="e_source_backend_summary_setup_set_summary_fieldsv ()">e_source_backend_summary_setup_set_summary_fieldsv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-set-summary-fields" title="e_source_backend_summary_setup_set_summary_fields ()">e_source_backend_summary_setup_set_summary_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="returnvalue">EContactField</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-get-indexed-fields" title="e_source_backend_summary_setup_get_indexed_fields ()">e_source_backend_summary_setup_get_indexed_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-set-indexed-fieldsv" title="e_source_backend_summary_setup_set_indexed_fieldsv ()">e_source_backend_summary_setup_set_indexed_fieldsv</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-set-indexed-fields" title="e_source_backend_summary_setup_set_indexed_fields ()">e_source_backend_summary_setup_set_indexed_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceBackendSummarySetup.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-ESourceBackendSummarySetup.html#E-SOURCE-EXTENSION-BACKEND-SUMMARY-SETUP:CAPS" title="E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP">E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup">ESourceBackendSummarySetup</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetupClass" title="struct ESourceBackendSummarySetupClass">ESourceBackendSummarySetupClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceBackendSummarySetup.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libebook-contacts/libebook-contacts.h>
</pre>
</div>
<div class="refsect1">
<a name="eds-ESourceBackendSummarySetup.description"></a><h2>Description</h2>
<p>The <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> extension configures which <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a>
should be in the summary and which of those fields should be optimized for
quicker search results.</p>
<p>Access the extension as follows:</p>
<div class="informalexample"><pre class="programlisting">
#include <libebook-contacts/libebook-contacts.h>
ESourceBackendSummarySetup *extension;
extension = e_source_get_extension (source, E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP);
</pre></div>
<p></p>
<div class="note"><p>The summary configuration is expected to be setup in only one way for
a given <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> at creation time. Any configurations made after creation of the
book in question will be ignored.</p></div>
</div>
<div class="refsect1">
<a name="eds-ESourceBackendSummarySetup.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-backend-summary-setup-get-summary-fields"></a><h3>e_source_backend_summary_setup_get_summary_fields ()</h3>
<pre class="programlisting"><a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="returnvalue">EContactField</span></a> *
e_source_backend_summary_setup_get_summary_fields
(<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *extension</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *n_fields</code></em>);</pre>
<p>Fetches the <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> which are configured to be a part of the summary.</p>
<div class="note"><p>If there are no configured summary fields, the default configuration is assumed</p></div>
<div class="refsect3">
<a name="id-1.2.3.32.7.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_fields</p></td>
<td class="parameter_description"><p> A return location for the number of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> in the returned array. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.32.7.2.7"></a><h4>Returns</h4>
<p> An array of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> <em class="parameter"><code>n_fields</code></em>
long, should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when done. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-backend-summary-setup-set-summary-fieldsv"></a><h3>e_source_backend_summary_setup_set_summary_fieldsv ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_backend_summary_setup_set_summary_fieldsv
(<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *extension</code></em>,
<em class="parameter"><code><a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> *fields</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_fields</code></em>);</pre>
<p>Sets the summary fields configured for the given addressbook.</p>
<p>The fields <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> are not optional,
they will be stored in the summary regardless of the configured summary.</p>
<p>An empty summary configuration is assumed to be the default summary
configuration.</p>
<div class="note"><p>Only <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> with the type <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><span class="type">G_TYPE_STRING</span></a> or <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-BOOLEAN:CAPS"><span class="type">G_TYPE_BOOLEAN</span></a>
are currently supported as summary fields.</p></div>
<div class="refsect3">
<a name="id-1.2.3.32.7.3.8"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fields</p></td>
<td class="parameter_description"><p>The array of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> to set as summary fields</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_fields</p></td>
<td class="parameter_description"><p>The number of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> in <em class="parameter"><code>fields</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-backend-summary-setup-set-summary-fields"></a><h3>e_source_backend_summary_setup_set_summary_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_backend_summary_setup_set_summary_fields
(<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *extension</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Like <a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-set-summary-fieldsv" title="e_source_backend_summary_setup_set_summary_fieldsv ()"><code class="function">e_source_backend_summary_setup_set_summary_fieldsv()</code></a>, but takes a literal
list of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> for convenience.</p>
<p>To configure the address book summary fields with main phone nubmer fields:</p>
<div class="informalexample"><pre class="programlisting">
#include <libebook/libebook.h>
ESourceBackendSummarySetup *extension;
extension = e_source_get_extension (source, E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP);
e_source_backend_summary_setup_set_summary_fields (extension, E_CONTACT_FULL_NAME, E_CONTACT_EMAIL, 0);
</pre></div>
<p></p>
<div class="refsect3">
<a name="id-1.2.3.32.7.4.8"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>A 0 terminated list of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> to set as summary fields</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-backend-summary-setup-get-indexed-fields"></a><h3>e_source_backend_summary_setup_get_indexed_fields ()</h3>
<pre class="programlisting"><a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="returnvalue">EContactField</span></a> *
e_source_backend_summary_setup_get_indexed_fields
(<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *extension</code></em>,
<em class="parameter"><code><a class="link" href="eds-Addressbook-related-types.html#EBookIndexType" title="enum EBookIndexType"><span class="type">EBookIndexType</span></a> **types</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *n_fields</code></em>);</pre>
<p>Fetches the <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> configured to be indexed, with thier respective <a href="eds-Addressbook-related-types.html#EBookIndexType"><span class="type">EBookIndexTypes</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.3.32.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>types</p></td>
<td class="parameter_description"><p> A return location for the set of <a href="eds-Addressbook-related-types.html#EBookIndexType"><span class="type">EBookIndexTypes</span></a> corresponding
to each returned field, should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_fields</p></td>
<td class="parameter_description"><p> The number of elements in the returned arrays. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.32.7.5.6"></a><h4>Returns</h4>
<p> The array of indexed <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-backend-summary-setup-set-indexed-fieldsv"></a><h3>e_source_backend_summary_setup_set_indexed_fieldsv ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_backend_summary_setup_set_indexed_fieldsv
(<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *extension</code></em>,
<em class="parameter"><code><a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> *fields</code></em>,
<em class="parameter"><code><a class="link" href="eds-Addressbook-related-types.html#EBookIndexType" title="enum EBookIndexType"><span class="type">EBookIndexType</span></a> *types</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_fields</code></em>);</pre>
<p>Defines indexes for quick reference for the given given <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> in the addressbook.</p>
<p>The same <a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> may be specified multiple times to create multiple indexes
with different characteristics. If an <a class="link" href="eds-Addressbook-related-types.html#E-BOOK-INDEX-PREFIX:CAPS"><span class="type">E_BOOK_INDEX_PREFIX</span></a> index is created it will
be used for <a class="link" href="eds-EBookQuery.html#E-BOOK-QUERY-BEGINS-WITH:CAPS"><span class="type">E_BOOK_QUERY_BEGINS_WITH</span></a> queries. A <a class="link" href="eds-Addressbook-related-types.html#E-BOOK-INDEX-SUFFIX:CAPS"><span class="type">E_BOOK_INDEX_SUFFIX</span></a> index
will be constructed efficiently for suffix matching and will be used for
<a class="link" href="eds-EBookQuery.html#E-BOOK-QUERY-ENDS-WITH:CAPS"><span class="type">E_BOOK_QUERY_ENDS_WITH</span></a> queries. Similar a <a class="link" href="eds-Addressbook-related-types.html#E-BOOK-INDEX-PHONE:CAPS"><span class="type">E_BOOK_INDEX_PHONE</span></a> index will optimize
<a class="link" href="eds-EBookQuery.html#E-BOOK-QUERY-EQUALS-PHONE-NUMBER:CAPS"><span class="type">E_BOOK_QUERY_EQUALS_PHONE_NUMBER</span></a> searches.</p>
<div class="note"><p>The specified indexed fields must also be a part of the summary, any indexed fields
specified that are not already a part of the summary will be ignored.</p></div>
<div class="refsect3">
<a name="id-1.2.3.32.7.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fields</p></td>
<td class="parameter_description"><p>The array of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> to set indexes for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>types</p></td>
<td class="parameter_description"><p>The array of <a href="eds-Addressbook-related-types.html#EBookIndexType"><span class="type">EBookIndexTypes</span></a> defining what types of indexes to create</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_fields</p></td>
<td class="parameter_description"><p>The number elements in the passed <em class="parameter"><code>fields</code></em>
, <em class="parameter"><code>rule_types</code></em>
and <em class="parameter"><code>rules</code></em>
arrays.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-backend-summary-setup-set-indexed-fields"></a><h3>e_source_backend_summary_setup_set_indexed_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_backend_summary_setup_set_indexed_fields
(<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *extension</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Like <a class="link" href="eds-ESourceBackendSummarySetup.html#e-source-backend-summary-setup-set-indexed-fieldsv" title="e_source_backend_summary_setup_set_indexed_fieldsv ()"><code class="function">e_source_backend_summary_setup_set_indexed_fieldsv()</code></a>, but takes a literal list of
of indexes.</p>
<p>To give the 'fullname' field an index for prefix and suffix searches:</p>
<div class="informalexample"><pre class="programlisting">
#include <libebook/libebook.h>
ESourceBackendSummarySetup *extension;
extension = e_source_get_extension (source, E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP);
e_source_backend_summary_setup_set_indexed_fields (extension,
E_CONTACT_FULL_NAME, E_BOOK_INDEX_PREFIX,
E_CONTACT_FULL_NAME, E_BOOK_INDEX_SUFFIX,
0);
</pre></div>
<p></p>
<div class="refsect3">
<a name="id-1.2.3.32.7.7.8"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>A list of <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a>, <a class="link" href="eds-Addressbook-related-types.html#EBookIndexType" title="enum EBookIndexType"><span class="type">EBookIndexType</span></a> pairs terminated by 0.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-ESourceBackendSummarySetup.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SOURCE-EXTENSION-BACKEND-SUMMARY-SETUP:CAPS"></a><h3>E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP</h3>
<pre class="programlisting">#define E_SOURCE_EXTENSION_BACKEND_SUMMARY_SETUP "Backend Summary Setup"
</pre>
<p>Pass this extension name to <a class="link" href="eds-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to access
<a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a>. This is also used as a group name in key files.</p>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceBackendSummarySetup"></a><h3>struct ESourceBackendSummarySetup</h3>
<pre class="programlisting">struct ESourceBackendSummarySetup {
ESourceBackend parent;
ESourceBackendSummarySetupPrivate *priv;
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceBackendSummarySetupClass"></a><h3>struct ESourceBackendSummarySetupClass</h3>
<pre class="programlisting">struct ESourceBackendSummarySetupClass {
ESourceBackendClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|