/usr/share/gtk-doc/html/camel/camel-CamelVeeSummary.html is in evolution-data-server-doc 3.28.1-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelVeeSummary: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Virtual-Folders.html" title='Virtual ("Search") Folders'>
<link rel="prev" href="camel-CamelVeeStore.html" title="CamelVeeStore">
<link rel="next" href="camel-CamelVTrashFolder.html" title="CamelVTrashFolder">
<meta name="generator" content="GTK-Doc V1.27 (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="#camel-CamelVeeSummary.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="Virtual-Folders.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-CamelVeeStore.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="camel-CamelVTrashFolder.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-CamelVeeSummary"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelVeeSummary.top_of_page"></a>CamelVeeSummary</span></h2>
<p>CamelVeeSummary</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-CamelVeeSummary.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">
<span class="returnvalue">CamelFolderSummary</span> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelVeeSummary.html#camel-vee-summary-new" title="camel_vee_summary_new ()">camel_vee_summary_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CamelVeeMessageInfo</span> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelVeeSummary.html#camel-vee-summary-add" title="camel_vee_summary_add ()">camel_vee_summary_add</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="camel-CamelVeeSummary.html#camel-vee-summary-remove" title="camel_vee_summary_remove ()">camel_vee_summary_remove</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="camel-CamelVeeSummary.html#camel-vee-summary-replace-flags" title="camel_vee_summary_replace_flags ()">camel_vee_summary_replace_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelVeeSummary.html#camel-vee-summary-get-uids-for-subfolder" title="camel_vee_summary_get_uids_for_subfolder ()">camel_vee_summary_get_uids_for_subfolder</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-CamelVeeSummary.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-CamelVeeSummary.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-vee-summary-new"></a><h3>camel_vee_summary_new ()</h3>
<pre class="programlisting"><span class="returnvalue">CamelFolderSummary</span> *
camel_vee_summary_new (<em class="parameter"><code><span class="type">CamelFolder</span> *parent</code></em>);</pre>
<p>This will create a new CamelVeeSummary object and read in the
summary data from disk, if it exists.</p>
<div class="refsect3">
<a name="camel-vee-summary-new.parameters"></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>parent</p></td>
<td class="parameter_description"><p>Folder its attached to.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-vee-summary-new.returns"></a><h4>Returns</h4>
<p> A new CamelVeeSummary object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-vee-summary-add"></a><h3>camel_vee_summary_add ()</h3>
<pre class="programlisting"><span class="returnvalue">CamelVeeMessageInfo</span> *
camel_vee_summary_add (<em class="parameter"><code><span class="type">CamelVeeSummary</span> *summary</code></em>,
<em class="parameter"><code><span class="type">struct _CamelVeeMessageInfoData</span> *mi_data</code></em>);</pre>
<p>Unref returned pointer with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
<div class="refsect3">
<a name="camel-vee-summary-add.parameters"></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>summary</p></td>
<td class="parameter_description"><p>the CamelVeeSummary</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mi_data</p></td>
<td class="parameter_description"><p>the <a class="link" href="camel-CamelVeeDataCache.html#CamelVeeMessageInfoData" title="struct CamelVeeMessageInfoData"><span class="type">CamelVeeMessageInfoData</span></a> to add. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> CamelVeeMessageInfoData]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-vee-summary-add.returns"></a><h4>Returns</h4>
<p>A new <span class="type">CamelVeeMessageInfo</span> object. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-vee-summary-remove"></a><h3>camel_vee_summary_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_vee_summary_remove (<em class="parameter"><code><span class="type">CamelVeeSummary</span> *summary</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *vuid</code></em>,
<em class="parameter"><code><span class="type">CamelFolder</span> *subfolder</code></em>);</pre>
<p>Removes the given <em class="parameter"><code>vuid</code></em>
of the <em class="parameter"><code>subfolder</code></em>
from the <em class="parameter"><code>summary</code></em>
.</p>
<div class="refsect3">
<a name="camel-vee-summary-remove.parameters"></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>summary</p></td>
<td class="parameter_description"><p>a <span class="type">CamelVeeSummary</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vuid</p></td>
<td class="parameter_description"><p>a virtual message info UID to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>subfolder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelFolder</span> to which <em class="parameter"><code>vuid</code></em>
belongs</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-vee-summary-replace-flags"></a><h3>camel_vee_summary_replace_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_vee_summary_replace_flags (<em class="parameter"><code><span class="type">CamelVeeSummary</span> *summary</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>Makes sure <em class="parameter"><code>summary</code></em>
flags on <em class="parameter"><code>uid</code></em>
corresponds to those
in the subfolder of vee-folder, and updates internal counts
on <em class="parameter"><code>summary</code></em>
as well.</p>
<div class="refsect3">
<a name="camel-vee-summary-replace-flags.parameters"></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>summary</p></td>
<td class="parameter_description"><p>a <span class="type">CamelVeeSummary</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>a message UID to update flags for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-vee-summary-get-uids-for-subfolder"></a><h3>camel_vee_summary_get_uids_for_subfolder ()</h3>
<pre class="programlisting"><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
camel_vee_summary_get_uids_for_subfolder
(<em class="parameter"><code><span class="type">CamelVeeSummary</span> *summary</code></em>,
<em class="parameter"><code><span class="type">CamelFolder</span> *subfolder</code></em>);</pre>
<p>Returns a hash table of all virtual message info UID-s known to the <em class="parameter"><code>summary</code></em>
.
The key of the hash table is the virtual message info UID, the value is
only the number 1.</p>
<div class="refsect3">
<a name="camel-vee-summary-get-uids-for-subfolder.parameters"></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>summary</p></td>
<td class="parameter_description"><p>a <span class="type">CamelVeeSummary</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>subfolder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-vee-summary-get-uids-for-subfolder.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> with
all the virtual mesasge info UID-s knwn to the <em class="parameter"><code>summary</code></em>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 gint][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-6.html#api-index-3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="camel-CamelVeeSummary.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|