git.maemo.org Git - modest/blob - experimental/modest/docs/reference/html/modest-ModestConf.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>ModestConf</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
   7 <link rel="start" href="index.html" title="modest reference manual">
   8 <link rel="up" href="modest-core.html" title="modest general">
   9 <link rel="prev" href="modest-core.html" title="modest general">
  10 <link rel="next" href="ix01.html" title="Index">
  11 <meta name="generator" content="GTK-Doc V1.6 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 <link rel="preface" href="pr01.html" title="Introduction">
  14 <link rel="reference" href="rn01.html" title="Object Index">
  15 <link rel="reference" href="rn02.html" title="API Reference">
  16 <link rel="chapter" href="modest-core.html" title="modest general">
  17 <link rel="index" href="ix01.html" title="Index">
  18 </head>
  19 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  20 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  21 <tr valign="middle">
  22 <td><a accesskey="p" href="modest-core.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="u" href="modest-core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  24 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  25 <th width="100%" align="center">modest reference manual</th>
  26 <td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  27 </tr>
  28 <tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
  29                   &#160;|&#160;
  30                   <a href="#desc" class="shortcut">Description</a></nobr></td></tr>
  31 </table>
  32 <div class="refentry" lang="en">
  33 <a name="modest-ModestConf"></a><div class="titlepage"></div>
  34 <div class="refnamediv"><table width="100%"><tr>
  35 <td valign="top">
  36 <h2><span class="refentrytitle"><a name="top_of_page"></a>ModestConf</span></h2>
  37 <p>ModestConf &#8212; </p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv">
  42 <a name="synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">
  44
  45
  46
  47             <a href="modest-ModestConf.html#ModestConf">ModestConf</a>;
  48 GObject*    <a href="modest-ModestConf.html#modest-conf-new">modest_conf_new</a>                 (void);
  49 gchar*      <a href="modest-ModestConf.html#modest-conf-get-string">modest_conf_get_string</a>          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  50                                              const gchar *key,
  51                                              GError **err);
  52 int         <a href="modest-ModestConf.html#modest-conf-get-int">modest_conf_get_int</a>             (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  53                                              const gchar *key,
  54                                              GError **err);
  55 gboolean    <a href="modest-ModestConf.html#modest-conf-get-bool">modest_conf_get_bool</a>            (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  56                                              const gchar *key,
  57                                              GError **err);
  58 gboolean    <a href="modest-ModestConf.html#modest-conf-set-string">modest_conf_set_string</a>          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  59                                              const gchar *key,
  60                                              const gchar *val,
  61                                              GError **err);
  62 gboolean    <a href="modest-ModestConf.html#modest-conf-set-int">modest_conf_set_int</a>             (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  63                                              const gchar *key,
  64                                              int val,
  65                                              GError **err);
  66 gboolean    <a href="modest-ModestConf.html#modest-conf-set-bool">modest_conf_set_bool</a>            (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  67                                              const gchar *key,
  68                                              gboolean val,
  69                                              GError **err);
  70 GSList*     <a href="modest-ModestConf.html#modest-conf-list-subkeys">modest_conf_list_subkeys</a>        (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  71                                              const gchar *key,
  72                                              GError **err);
  73 gboolean    <a href="modest-ModestConf.html#modest-conf-remove-key">modest_conf_remove_key</a>          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  74                                              const gchar *key,
  75                                              GError **err);
  76 gboolean    <a href="modest-ModestConf.html#modest-conf-key-exists">modest_conf_key_exists</a>          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
  77                                              const gchar *key,
  78                                              GError **err);
  79
  80 </pre>
  81 </div>
  82 <div class="refsect1" lang="en">
  83 <a name="desc"></a><h2>Description</h2>
  84 <p>
  85
  86 </p>
  87 </div>
  88 <div class="refsect1" lang="en">
  89 <a name="details"></a><h2>Details</h2>
  90 <div class="refsect2" lang="en">
  91 <a name="id2517677"></a><h3>
  92 <a name="ModestConf"></a>ModestConf</h3>
  93 <a class="indexterm" name="id2517689"></a><pre class="programlisting">typedef struct {
  94          GObject parent;
  95 } ModestConf;
  96 </pre>
  97 <p>
  98
  99 </p>
 100 </div>
 101 <hr>
 102 <div class="refsect2" lang="en">
 103 <a name="id2517704"></a><h3>
 104 <a name="modest-conf-new"></a>modest_conf_new ()</h3>
 105 <a class="indexterm" name="id2517717"></a><pre class="programlisting">GObject*    modest_conf_new                 (void);</pre>
 106 <p>
 107 create a new modest ModestConf object.</p>
 108 <p>
 109
 110 </p>
 111 <div class="variablelist"><table border="0">
 112 <col align="left" valign="top">
 113 <tbody><tr>
 114 <td>
 115 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 116 <td> a new ModestConf instance, or NULL in case
 117 of any error
 118 </td>
 119 </tr></tbody>
 120 </table></div>
 121 </div>
 122 <hr>
 123 <div class="refsect2" lang="en">
 124 <a name="id2517755"></a><h3>
 125 <a name="modest-conf-get-string"></a>modest_conf_get_string ()</h3>
 126 <a class="indexterm" name="id2517771"></a><pre class="programlisting">gchar*      modest_conf_get_string          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 127                                              const gchar *key,
 128                                              GError **err);</pre>
 129 <p>
 130 get a string from the configuration system</p>
 131 <p>
 132
 133 </p>
 134 <div class="variablelist"><table border="0">
 135 <col align="left" valign="top">
 136 <tbody>
 137 <tr>
 138 <td>
 139 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 140 <td> self a ModestConf instance
 141 </td>
 142 </tr>
 143 <tr>
 144 <td>
 145 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 146 <td> the key of the value to retrieve
 147 </td>
 148 </tr>
 149 <tr>
 150 <td>
 151 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 152 <td> a GError ptr, or NULL to ignore.
 153 </td>
 154 </tr>
 155 <tr>
 156 <td>
 157 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 158 <td> a newly allocated string with the value for the key,
 159 or NULL in case of error. <em class="parameter"><code>err</code></em> gives details in case of error
 160 </td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 <hr>
 166 <div class="refsect2" lang="en">
 167 <a name="id2517884"></a><h3>
 168 <a name="modest-conf-get-int"></a>modest_conf_get_int ()</h3>
 169 <a class="indexterm" name="id2517897"></a><pre class="programlisting">int         modest_conf_get_int             (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 170                                              const gchar *key,
 171                                              GError **err);</pre>
 172 <p>
 173 get an integer from the configuration system</p>
 174 <p>
 175
 176 </p>
 177 <div class="variablelist"><table border="0">
 178 <col align="left" valign="top">
 179 <tbody>
 180 <tr>
 181 <td>
 182 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 183 <td> self a ModestConf instance
 184 </td>
 185 </tr>
 186 <tr>
 187 <td>
 188 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 189 <td> the key of the value to retrieve
 190 </td>
 191 </tr>
 192 <tr>
 193 <td>
 194 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 195 <td> a GError ptr, or NULL to ignore.
 196 </td>
 197 </tr>
 198 <tr>
 199 <td>
 200 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 201 <td> an integer with the value for the key, or -1 in case of error
 202 (of course, -1 can also be returned in non-error cases).
 203 <em class="parameter"><code>err</code></em> gives details in case of error
 204 </td>
 205 </tr>
 206 </tbody>
 207 </table></div>
 208 </div>
 209 <hr>
 210 <div class="refsect2" lang="en">
 211 <a name="id2518008"></a><h3>
 212 <a name="modest-conf-get-bool"></a>modest_conf_get_bool ()</h3>
 213 <a class="indexterm" name="id2518021"></a><pre class="programlisting">gboolean    modest_conf_get_bool            (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 214                                              const gchar *key,
 215                                              GError **err);</pre>
 216 <p>
 217 get a boolean value from the configuration system</p>
 218 <p>
 219
 220 </p>
 221 <div class="variablelist"><table border="0">
 222 <col align="left" valign="top">
 223 <tbody>
 224 <tr>
 225 <td>
 226 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 227 <td> self a ModestConf instance
 228 </td>
 229 </tr>
 230 <tr>
 231 <td>
 232 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 233 <td> the key of the value to retrieve
 234 </td>
 235 </tr>
 236 <tr>
 237 <td>
 238 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 239 <td> a GError ptr, or NULL to ignore.
 240 </td>
 241 </tr>
 242 <tr>
 243 <td>
 244 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 245 <td> a boolean value with the value for the key, or -1 in case of error
 246 (of course, -1 can also be returned in non-error cases).
 247 <em class="parameter"><code>err</code></em> gives details in case of error
 248 </td>
 249 </tr>
 250 </tbody>
 251 </table></div>
 252 </div>
 253 <hr>
 254 <div class="refsect2" lang="en">
 255 <a name="id2518133"></a><h3>
 256 <a name="modest-conf-set-string"></a>modest_conf_set_string ()</h3>
 257 <a class="indexterm" name="id2518146"></a><pre class="programlisting">gboolean    modest_conf_set_string          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 258                                              const gchar *key,
 259                                              const gchar *val,
 260                                              GError **err);</pre>
 261 <p>
 262 store a string value in the configuration system</p>
 263 <p>
 264
 265 </p>
 266 <div class="variablelist"><table border="0">
 267 <col align="left" valign="top">
 268 <tbody>
 269 <tr>
 270 <td>
 271 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 272 <td> a ModestConf instance
 273 </td>
 274 </tr>
 275 <tr>
 276 <td>
 277 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 278 <td> the key of the value to set
 279 </td>
 280 </tr>
 281 <tr>
 282 <td>
 283 <span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
 284 <td> the value to set
 285 </td>
 286 </tr>
 287 <tr>
 288 <td>
 289 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 290 <td> a GError ptr, or NULL if not interested.
 291 </td>
 292 </tr>
 293 <tr>
 294 <td>
 295 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 296 <td> TRUE if succeeded or FALSE in case of error.
 297 <em class="parameter"><code>err</code></em> gives details in case of error
 298 </td>
 299 </tr>
 300 </tbody>
 301 </table></div>
 302 </div>
 303 <hr>
 304 <div class="refsect2" lang="en">
 305 <a name="id2518279"></a><h3>
 306 <a name="modest-conf-set-int"></a>modest_conf_set_int ()</h3>
 307 <a class="indexterm" name="id2518292"></a><pre class="programlisting">gboolean    modest_conf_set_int             (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 308                                              const gchar *key,
 309                                              int val,
 310                                              GError **err);</pre>
 311 <p>
 312 store an integer value in the configuration system</p>
 313 <p>
 314
 315 </p>
 316 <div class="variablelist"><table border="0">
 317 <col align="left" valign="top">
 318 <tbody>
 319 <tr>
 320 <td>
 321 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 322 <td> a ModestConf instance
 323 </td>
 324 </tr>
 325 <tr>
 326 <td>
 327 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 328 <td> the key of the value to set
 329 </td>
 330 </tr>
 331 <tr>
 332 <td>
 333 <span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
 334 <td> the value to set
 335 </td>
 336 </tr>
 337 <tr>
 338 <td>
 339 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 340 <td> a GError ptr, or NULL if not interested.
 341 </td>
 342 </tr>
 343 <tr>
 344 <td>
 345 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 346 <td> TRUE if succeeded or FALSE in case of error.
 347 <em class="parameter"><code>err</code></em> gives details in case of error
 348 </td>
 349 </tr>
 350 </tbody>
 351 </table></div>
 352 </div>
 353 <hr>
 354 <div class="refsect2" lang="en">
 355 <a name="id2518423"></a><h3>
 356 <a name="modest-conf-set-bool"></a>modest_conf_set_bool ()</h3>
 357 <a class="indexterm" name="id2518436"></a><pre class="programlisting">gboolean    modest_conf_set_bool            (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 358                                              const gchar *key,
 359                                              gboolean val,
 360                                              GError **err);</pre>
 361 <p>
 362 store a boolean value in the configuration system</p>
 363 <p>
 364
 365 </p>
 366 <div class="variablelist"><table border="0">
 367 <col align="left" valign="top">
 368 <tbody>
 369 <tr>
 370 <td>
 371 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 372 <td> a ModestConf instance
 373 </td>
 374 </tr>
 375 <tr>
 376 <td>
 377 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 378 <td> the key of the value to set
 379 </td>
 380 </tr>
 381 <tr>
 382 <td>
 383 <span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
 384 <td> the value to set
 385 </td>
 386 </tr>
 387 <tr>
 388 <td>
 389 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 390 <td> a GError ptr, or NULL if not interested.
 391 </td>
 392 </tr>
 393 <tr>
 394 <td>
 395 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 396 <td> TRUE if succeeded or FALSE in case of error.
 397 <em class="parameter"><code>err</code></em> gives details in case of error
 398 </td>
 399 </tr>
 400 </tbody>
 401 </table></div>
 402 </div>
 403 <hr>
 404 <div class="refsect2" lang="en">
 405 <a name="id2518568"></a><h3>
 406 <a name="modest-conf-list-subkeys"></a>modest_conf_list_subkeys ()</h3>
 407 <a class="indexterm" name="id2518581"></a><pre class="programlisting">GSList*     modest_conf_list_subkeys        (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 408                                              const gchar *key,
 409                                              GError **err);</pre>
 410 <p>
 411 list all the subkeys for a given key</p>
 412 <p>
 413
 414 </p>
 415 <div class="variablelist"><table border="0">
 416 <col align="left" valign="top">
 417 <tbody>
 418 <tr>
 419 <td>
 420 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 421 <td> a ModestConf instance
 422 </td>
 423 </tr>
 424 <tr>
 425 <td>
 426 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 427 <td> the key whose subkeys will be listed
 428 </td>
 429 </tr>
 430 <tr>
 431 <td>
 432 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 433 <td> a GError ptr, or NULL if not interested.
 434 </td>
 435 </tr>
 436 <tr>
 437 <td>
 438 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 439 <td> a newly allocated list or NULL in case of error
 440 the returned GSList must be freed by the caller
 441 <em class="parameter"><code>err</code></em> gives details in case of error
 442 </td>
 443 </tr>
 444 </tbody>
 445 </table></div>
 446 </div>
 447 <hr>
 448 <div class="refsect2" lang="en">
 449 <a name="id2518693"></a><h3>
 450 <a name="modest-conf-remove-key"></a>modest_conf_remove_key ()</h3>
 451 <a class="indexterm" name="id2518706"></a><pre class="programlisting">gboolean    modest_conf_remove_key          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 452                                              const gchar *key,
 453                                              GError **err);</pre>
 454 <p>
 455 attempts to remove <em class="parameter"><code>key</code></em> and all its subkeys</p>
 456 <p>
 457
 458 </p>
 459 <div class="variablelist"><table border="0">
 460 <col align="left" valign="top">
 461 <tbody>
 462 <tr>
 463 <td>
 464 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 465 <td> a ModestConf instance
 466 </td>
 467 </tr>
 468 <tr>
 469 <td>
 470 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 471 <td> the key to remove
 472 </td>
 473 </tr>
 474 <tr>
 475 <td>
 476 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 477 <td> a GError ptr, or NULL if not interested.
 478 </td>
 479 </tr>
 480 <tr>
 481 <td>
 482 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 483 <td> TRUE if succeeded or FALSE in case of error.
 484 <em class="parameter"><code>err</code></em> gives details in case of error
 485 </td>
 486 </tr>
 487 </tbody>
 488 </table></div>
 489 </div>
 490 <hr>
 491 <div class="refsect2" lang="en">
 492 <a name="id2518823"></a><h3>
 493 <a name="modest-conf-key-exists"></a>modest_conf_key_exists ()</h3>
 494 <a class="indexterm" name="id2518835"></a><pre class="programlisting">gboolean    modest_conf_key_exists          (<a href="modest-ModestConf.html#ModestConf">ModestConf</a> *self,
 495                                              const gchar *key,
 496                                              GError **err);</pre>
 497 <p>
 498 checks if the given key exists in the configuration system</p>
 499 <p>
 500
 501 </p>
 502 <div class="variablelist"><table border="0">
 503 <col align="left" valign="top">
 504 <tbody>
 505 <tr>
 506 <td>
 507 <span class="term"><em class="parameter"><code>self</code></em>&#160;:</span></td>
 508 <td> a ModestConf instance
 509 </td>
 510 </tr>
 511 <tr>
 512 <td>
 513 <span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
 514 <td> the key to remove
 515 </td>
 516 </tr>
 517 <tr>
 518 <td>
 519 <span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
 520 <td> a GError ptr, or NULL if not interested.
 521 </td>
 522 </tr>
 523 <tr>
 524 <td>
 525 <span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 526 <td> TRUE if exists, FALSE otherwise.
 527 <em class="parameter"><code>err</code></em> gives details in case of error
 528 </td>
 529 </tr>
 530 </tbody>
 531 </table></div>
 532 </div>
 533 </div>
 534 </div>
 535 </body>
 536 </html>