/usr/share/gtk-doc/html/libedataserver/ESourceRefresh.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.
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 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Utilities (libedataserver): ESourceRefresh</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="up" href="ch02.html" title="Data Source Extensions">
<link rel="prev" href="ESourceOpenPGP.html" title="ESourceOpenPGP">
<link rel="next" href="ESourceResource.html" title="ESourceResource">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#ESourceRefresh.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ESourceRefresh.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ESourceRefresh.properties" class="shortcut">Properties</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="ESourceOpenPGP.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ESourceResource.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ESourceRefresh"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ESourceRefresh.top_of_page"></a>ESourceRefresh</span></h2>
<p>ESourceRefresh — <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> extension for refresh settings</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ESourceRefresh.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="ESourceRefresh.html#e-source-refresh-get-enabled" title="e_source_refresh_get_enabled ()">e_source_refresh_get_enabled</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="ESourceRefresh.html#e-source-refresh-set-enabled" title="e_source_refresh_set_enabled ()">e_source_refresh_set_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="ESourceRefresh.html#e-source-refresh-get-interval-minutes" title="e_source_refresh_get_interval_minutes ()">e_source_refresh_get_interval_minutes</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="ESourceRefresh.html#e-source-refresh-set-interval-minutes" title="e_source_refresh_set_interval_minutes ()">e_source_refresh_set_interval_minutes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="ESourceRefresh.html#ESourceRefreshFunc" title="ESourceRefreshFunc ()">*ESourceRefreshFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="ESourceRefresh.html#e-source-refresh-add-timeout" title="e_source_refresh_add_timeout ()">e_source_refresh_add_timeout</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="ESourceRefresh.html#e-source-refresh-force-timeout" title="e_source_refresh_force_timeout ()">e_source_refresh_force_timeout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="ESourceRefresh.html#e-source-refresh-remove-timeout" title="e_source_refresh_remove_timeout ()">e_source_refresh_remove_timeout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="ESourceRefresh.html#e-source-refresh-remove-timeouts-by-data" title="e_source_refresh_remove_timeouts_by_data ()">e_source_refresh_remove_timeouts_by_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ESourceRefresh.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="ESourceRefresh.html#ESourceRefresh--enabled" title="The “enabled” property">enabled</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="ESourceRefresh.html#ESourceRefresh--interval-minutes" title="The “interval-minutes” property">interval-minutes</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ESourceRefresh.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ESourceRefresh.html#ESourceRefresh-struct" title="struct ESourceRefresh">ESourceRefresh</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ESourceRefresh.html#E-SOURCE-EXTENSION-REFRESH:CAPS" title="E_SOURCE_EXTENSION_REFRESH">E_SOURCE_EXTENSION_REFRESH</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ESourceRefresh.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="ESourceExtension.html" title="ESourceExtension">ESourceExtension</a>
<span class="lineart">╰──</span> ESourceRefresh
</pre>
</div>
<div class="refsect1">
<a name="ESourceRefresh.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedataserver/libedataserver.h>
</pre>
</div>
<div class="refsect1">
<a name="ESourceRefresh.description"></a><h2>Description</h2>
<p>The <a class="link" href="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a> extension tracks the interval for fetching
updates from a remote server.</p>
<p>Access the extension as follows:</p>
<div class="informalexample"><pre class="programlisting">
#include <libedataserver/libedataserver.h>
ESourceRefresh *extension;
extension = e_source_get_extension (source, E_SOURCE_EXTENSION_REFRESH);
</pre></div>
<p></p>
</div>
<div class="refsect1">
<a name="ESourceRefresh.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-refresh-get-enabled"></a><h3>e_source_refresh_get_enabled ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_refresh_get_enabled (<em class="parameter"><code><a class="link" href="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a> *extension</code></em>);</pre>
<p>Returns whether to periodically fetch updates from a remote server.</p>
<p>The refresh interval is determined by the <a class="link" href="ESourceRefresh.html#ESourceRefresh--interval-minutes" title="The “interval-minutes” property"><span class="type">“interval-minutes”</span></a>
property.</p>
<div class="refsect3">
<a name="id-1.3.23.9.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.23.9.2.7"></a><h4>Returns</h4>
<p> whether periodic refresh is enabled</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-set-enabled"></a><h3>e_source_refresh_set_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_refresh_set_enabled (<em class="parameter"><code><a class="link" href="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a> *extension</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre>
<p>Sets whether to periodically fetch updates from a remote server.</p>
<p>The refresh interval is determined by the <a class="link" href="ESourceRefresh.html#ESourceRefresh--interval-minutes" title="The “interval-minutes” property"><span class="type">“interval-minutes”</span></a>
property.</p>
<div class="refsect3">
<a name="id-1.3.23.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enabled</p></td>
<td class="parameter_description"><p>whether to enable periodic refresh</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-get-interval-minutes"></a><h3>e_source_refresh_get_interval_minutes ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
e_source_refresh_get_interval_minutes (<em class="parameter"><code><a class="link" href="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a> *extension</code></em>);</pre>
<p>Returns the interval for fetching updates from a remote server.</p>
<p>Note this value is only effective when the <a class="link" href="ESourceRefresh.html#ESourceRefresh--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a>
property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.23.9.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.23.9.4.7"></a><h4>Returns</h4>
<p> the interval in minutes</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-set-interval-minutes"></a><h3>e_source_refresh_set_interval_minutes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_refresh_set_interval_minutes (<em class="parameter"><code><a class="link" href="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a> *extension</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> interval_minutes</code></em>);</pre>
<p>Sets the interval for fetching updates from a remote server.</p>
<p>Note this value is only effective when the <a class="link" href="ESourceRefresh.html#ESourceRefresh--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a>
property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.23.9.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interval_minutes</p></td>
<td class="parameter_description"><p>the interval in minutes</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceRefreshFunc"></a><h3>ESourceRefreshFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*ESourceRefreshFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<div class="refsect3">
<a name="id-1.3.23.9.6.4"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data provided to the callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-add-timeout"></a><h3>e_source_refresh_add_timeout ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
e_source_refresh_add_timeout (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *context</code></em>,
<em class="parameter"><code><a class="link" href="ESourceRefresh.html#ESourceRefreshFunc" title="ESourceRefreshFunc ()"><span class="type">ESourceRefreshFunc</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
<p>This is a simple way to schedule a periodic data source refresh.</p>
<p>Adds a timeout <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a> to <em class="parameter"><code>context</code></em>
and handles all the bookkeeping
if <em class="parameter"><code>source</code></em>
's refresh <a class="link" href="ESourceRefresh.html#ESourceRefresh--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a> state or its refresh
<a class="link" href="ESourceRefresh.html#ESourceRefresh--interval-minutes" title="The “interval-minutes” property"><span class="type">“interval-minutes”</span></a> value changes. The <em class="parameter"><code>callback</code></em>
is
expected to dispatch an asynchronous job to connect to and fetch
updates from a remote server.</p>
<p>The returned ID can be passed to <a class="link" href="ESourceRefresh.html#e-source-refresh-remove-timeout" title="e_source_refresh_remove_timeout ()"><code class="function">e_source_refresh_remove_timeout()</code></a> to
remove the timeout from <em class="parameter"><code>context</code></em>
. Note the ID is a private handle and
cannot be passed to <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#g-source-remove"><code class="function">g_source_remove()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.23.9.7.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default
context will be used). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>function to call on each timeout</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p> function to call when the timeout is removed,
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.23.9.7.8"></a><h4>Returns</h4>
<p> a refresh timeout ID</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-force-timeout"></a><h3>e_source_refresh_force_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_refresh_force_timeout (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>For all timeouts added with <a class="link" href="ESourceRefresh.html#e-source-refresh-add-timeout" title="e_source_refresh_add_timeout ()"><code class="function">e_source_refresh_add_timeout()</code></a>, invokes
the <a class="link" href="ESourceRefresh.html#ESourceRefreshFunc" title="ESourceRefreshFunc ()"><span class="type">ESourceRefreshFunc</span></a> callback immediately and then, if the refresh
<a class="link" href="ESourceRefresh.html#ESourceRefresh--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a> state is TRUE, reschedules the timeout.</p>
<p>This function is called automatically when the <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> switches from
disabled to enabled, but can also be useful when a network connection
becomes available or when waking up from hibernation or suspend.</p>
<div class="refsect3">
<a name="id-1.3.23.9.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-remove-timeout"></a><h3>e_source_refresh_remove_timeout ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_refresh_remove_timeout (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> refresh_timeout_id</code></em>);</pre>
<p>Removes a timeout <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a> added by <a class="link" href="ESourceRefresh.html#e-source-refresh-add-timeout" title="e_source_refresh_add_timeout ()"><code class="function">e_source_refresh_add_timeout()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.23.9.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>refresh_timeout_id</p></td>
<td class="parameter_description"><p>a refresh timeout ID</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.23.9.9.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the timeout was found and removed</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-refresh-remove-timeouts-by-data"></a><h3>e_source_refresh_remove_timeouts_by_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
e_source_refresh_remove_timeouts_by_data
(<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Removes all timeout <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a>'s added by <a class="link" href="ESourceRefresh.html#e-source-refresh-add-timeout" title="e_source_refresh_add_timeout ()"><code class="function">e_source_refresh_add_timeout()</code></a>
whose callback data pointer matches <em class="parameter"><code>user_data</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.23.9.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to match against timeout callbacks</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.23.9.10.6"></a><h4>Returns</h4>
<p> the number of timeouts found and removed</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
</div>
<div class="refsect1">
<a name="ESourceRefresh.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ESourceRefresh-struct"></a><h3>struct ESourceRefresh</h3>
<pre class="programlisting">struct ESourceRefresh;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="E-SOURCE-EXTENSION-REFRESH:CAPS"></a><h3>E_SOURCE_EXTENSION_REFRESH</h3>
<pre class="programlisting">#define E_SOURCE_EXTENSION_REFRESH "Refresh"
</pre>
<p>Pass this extension name to <a class="link" href="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="ESourceRefresh.html" title="ESourceRefresh"><span class="type">ESourceRefresh</span></a>. This is also used as a group name in key files.</p>
<p class="since">Since 3.6</p>
</div>
</div>
<div class="refsect1">
<a name="ESourceRefresh.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ESourceRefresh--enabled"></a><h3>The <code class="literal">“enabled”</code> property</h3>
<pre class="programlisting"> “enabled” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether to periodically refresh.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceRefresh--interval-minutes"></a><h3>The <code class="literal">“interval-minutes”</code> property</h3>
<pre class="programlisting"> “interval-minutes” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Refresh interval in minutes.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 60</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|