/usr/share/gtk-doc/html/libebook/libebook-EBookClientView.html is in libebook1.2-dev 3.2.3-0ubuntu7.1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBookClientView</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Client (libebook)">
<link rel="prev" href="libebook-EBookClient.html" title="EBookClient">
<link rel="next" href="libebook-e-book-query.html" title="e-book-query">
<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="libebook-EBookClient.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: Address Book Client (libebook)</th>
<td><a accesskey="n" href="libebook-e-book-query.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libebook-EBookClientView.synopsis" class="shortcut">Top</a>
|
<a href="#libebook-EBookClientView.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libebook-EBookClientView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libebook-EBookClientView.top_of_page"></a>EBookClientView</span></h2>
<p>EBookClientView</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libebook-EBookClientView.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView">EBookClientView</a>;
struct <a class="link" href="libebook-EBookClient.html#EBookClient" title="struct EBookClient"><span class="returnvalue">_EBookClient</span></a> * <a class="link" href="libebook-EBookClientView.html#e-book-client-view-get-client" title="e_book_client_view_get_client ()">e_book_client_view_get_client</a> (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libebook-EBookClientView.html#e-book-client-view-is-running" title="e_book_client_view_is_running ()">e_book_client_view_is_running</a> (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebook-EBookClientView.html#e-book-client-view-set-fields-of-interest" title="e_book_client_view_set_fields_of_interest ()">e_book_client_view_set_fields_of_interest</a>
(<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>,
<em class="parameter"><code>const <span class="type">GSList</span> *fields_of_interest</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebook-EBookClientView.html#e-book-client-view-start" title="e_book_client_view_start ()">e_book_client_view_start</a> (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebook-EBookClientView.html#e-book-client-view-stop" title="e_book_client_view_stop ()">e_book_client_view_stop</a> (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libebook-EBookClientView.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libebook-EBookClientView.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EBookClientView"></a><h3>struct EBookClientView</h3>
<pre class="programlisting">struct EBookClientView {
GObject parent;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-get-client"></a><h3>e_book_client_view_get_client ()</h3>
<pre class="programlisting">struct <a class="link" href="libebook-EBookClient.html#EBookClient" title="struct EBookClient"><span class="returnvalue">_EBookClient</span></a> * e_book_client_view_get_client (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>);</pre>
<p>
Returns the <a class="link" href="libebook-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a> that this book view is monitoring.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>an <a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</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="libebook-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-is-running"></a><h3>e_book_client_view_is_running ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_book_client_view_is_running (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-set-fields-of-interest"></a><h3>e_book_client_view_set_fields_of_interest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_book_client_view_set_fields_of_interest
(<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>,
<em class="parameter"><code>const <span class="type">GSList</span> *fields_of_interest</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Client can instruct server to which fields it is interested in only, thus
the server can return less data over the wire. The server can still return
complete objects, this is just a hint to it that the listed fields will
be used only. The UID field is returned always. Initial views has no fields
of interest and using <code class="literal">NULL</code> for <em class="parameter"><code>fields_of_interest</code></em> will unset any previous
changes.
</p>
<p>
Some backends can use summary information of its cache to create artifical
objects, which will omit stored object parsing. If this cannot be done then
it will simply return object as is stored in the cache.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>An <a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fields_of_interest</code></em> :</span></p></td>
<td>List of field names in which the client is interested. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-start"></a><h3>e_book_client_view_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_book_client_view_start (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Tells <em class="parameter"><code>view</code></em> to start processing events.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>an <a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-book-client-view-stop"></a><h3>e_book_client_view_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_book_client_view_stop (<em class="parameter"><code><a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Tells <em class="parameter"><code>view</code></em> to stop processing events.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>an <a class="link" href="libebook-EBookClientView.html#EBookClientView" title="struct EBookClientView"><span class="type">EBookClientView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|