/usr/share/gtk-doc/html/xfconf/xfconf-xfconf-backend.html is in libxfconf-0-dev 4.12.1-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 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 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfconfBackend: Xfconf Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Xfconf Reference Manual">
<link rel="up" href="ch02.html" title="Xfconf Daemon">
<link rel="prev" href="ch02.html" title="Xfconf Daemon">
<link rel="next" href="ch03.html" title="Xfconf Client Library">
<meta name="generator" content="GTK-Doc V1.25.1 (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="#xfconf-xfconf-backend.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#xfconf-xfconf-backend.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#xfconf-xfconf-backend.prerequisites" class="shortcut">Prerequisites</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="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="xfconf-xfconf-backend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="xfconf-xfconf-backend.top_of_page"></a>XfconfBackend</span></h2>
<p>XfconfBackend — Interface for configuration store backends</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="xfconf-xfconf-backend.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">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-initialize" title="xfconf_backend_initialize ()">xfconf_backend_initialize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-set" title="xfconf_backend_set ()">xfconf_backend_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-get" title="xfconf_backend_get ()">xfconf_backend_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-get-all" title="xfconf_backend_get_all ()">xfconf_backend_get_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-exists" title="xfconf_backend_exists ()">xfconf_backend_exists</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-reset" title="xfconf_backend_reset ()">xfconf_backend_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-flush" title="xfconf_backend_flush ()">xfconf_backend_flush</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="xfconf-xfconf-backend.html#xfconf-backend-register-property-changed-func" title="xfconf_backend_register_property_changed_func ()">xfconf_backend_register_property_changed_func</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="XfconfBackend"></a><div class="refsect1">
<a name="xfconf-xfconf-backend.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="xfconf-xfconf-backend.html#XfconfBackendInterface" title="struct XfconfBackendInterface">XfconfBackendInterface</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend-struct" title="XfconfBackend">XfconfBackend</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-backend.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> XfconfBackend
</pre>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-backend.prerequisites"></a><h2>Prerequisites</h2>
<p>
XfconfBackend requires
GObject.</p>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-backend.description"></a><h2>Description</h2>
<p>
XfconfBackend is an abstract interface that allows the Xfconf Daemon
to use different backends for storing configuration data. These backends
can be flat text or binary files, a database, or just about anything
one could think of to store data.
</p>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-backend.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfconf-backend-initialize"></a><h3>xfconf_backend_initialize ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_initialize (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Does any pre-initialization that the backend needs to function.</p>
<div class="refsect3">
<a name="xfconf-backend-initialize.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-initialize.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if initialization
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-set"></a><h3>xfconf_backend_set ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_set (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Sets the variant <em class="parameter"><code>value</code></em>
for <em class="parameter"><code>property</code></em>
on <em class="parameter"><code>channel</code></em>
.</p>
<div class="refsect3">
<a name="xfconf-backend-set.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>channel</p></td>
<td class="parameter_description"><p>A channel name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>A property name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>A value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-set.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if the operation
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-get"></a><h3>xfconf_backend_get ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_get (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>,
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the value of <em class="parameter"><code>property</code></em>
on <em class="parameter"><code>channel</code></em>
and stores it in <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="xfconf-backend-get.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>channel</p></td>
<td class="parameter_description"><p>A channel name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>A property name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>A <span class="type">GValue</span> return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-get.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if the operation
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-get-all"></a><h3>xfconf_backend_get_all ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_get_all (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property_base</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *properties</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets multiple properties and values on <em class="parameter"><code>channel</code></em>
and stores them in
<em class="parameter"><code>properties</code></em>
, which is already initialized to hold <span class="type">gchar</span>* keys and
<span class="type">GValue</span>* values. The <em class="parameter"><code>property_base</code></em>
parameter can be
used to limit the retrieval to a sub-tree of the property tree.</p>
<p>A value of the empty string ("") or forward slash ("/") for
<em class="parameter"><code>property_base</code></em>
indicates the entire channel.</p>
<div class="refsect3">
<a name="xfconf-backend-get-all.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>channel</p></td>
<td class="parameter_description"><p>A channel name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_base</p></td>
<td class="parameter_description"><p>The base of properties to return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>properties</p></td>
<td class="parameter_description"><p>A <span class="type">GHashTable</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-get-all.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if the operation
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-exists"></a><h3>xfconf_backend_exists ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_exists (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *exists</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Checks to see if <em class="parameter"><code>property</code></em>
exists on <em class="parameter"><code>channel</code></em>
, and stores <code class="literal">TRUE</code> or
<code class="literal">FALSE</code> in <em class="parameter"><code>exists</code></em>
.</p>
<div class="refsect3">
<a name="xfconf-backend-exists.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>channel</p></td>
<td class="parameter_description"><p>A channel name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>A property name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>exists</p></td>
<td class="parameter_description"><p>A boolean return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-exists.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if the operation
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-reset"></a><h3>xfconf_backend_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_reset (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> recursive</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Resets the property identified by <em class="parameter"><code>property</code></em>
from <em class="parameter"><code>channel</code></em>
.
If <em class="parameter"><code>recursive</code></em>
is <code class="literal">TRUE</code>, all sub-properties of <em class="parameter"><code>property</code></em>
will be
reset as well. If the empty string ("") or a forward slash ("/")
is specified for <em class="parameter"><code>property</code></em>
, the entire channel will be reset.</p>
<p>If none of the properties specified are locked or have root-owned
system-wide defaults set, this effectively removes the properties
from the configuration store entirely.</p>
<div class="refsect3">
<a name="xfconf-backend-reset.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>channel</p></td>
<td class="parameter_description"><p>A channel name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>A property name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>recursive</p></td>
<td class="parameter_description"><p>Whether or not the reset is recursive.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-reset.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if the operation
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-flush"></a><h3>xfconf_backend_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_backend_flush (<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>For backends that support persistent storage, ensures that all
configuration data stored in memory is saved to persistent storage.</p>
<div class="refsect3">
<a name="xfconf-backend-flush.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-backend-flush.returns"></a><h4>Returns</h4>
<p> The backend should return <code class="literal">TRUE</code> if the operation
was successful, or <code class="literal">FALSE</code> otherwise. On <code class="literal">FALSE</code>,
<em class="parameter"><code>error</code></em>
should be set to a description of the failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-backend-register-property-changed-func"></a><h3>xfconf_backend_register_property_changed_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfconf_backend_register_property_changed_func
(<em class="parameter"><code><a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> *backend</code></em>,
<em class="parameter"><code><span class="type">XfconfPropertyChangedFunc</span> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Registers a function to be called when a property changes. The
backend implementation should keep a pointer to <em class="parameter"><code>func</code></em>
and <em class="parameter"><code>user_data</code></em>
and call <em class="parameter"><code>func</code></em>
when a property in the configuration store changes.</p>
<div class="refsect3">
<a name="xfconf-backend-register-property-changed-func.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>backend</p></td>
<td class="parameter_description"><p>The <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>A function of type <span class="type">XfconfPropertyChangeFunc</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Arbitrary caller-supplied data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-backend.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XfconfBackendInterface"></a><h3>struct XfconfBackendInterface</h3>
<pre class="programlisting">struct XfconfBackendInterface {
GTypeInterface parent;
gboolean (*initialize)(XfconfBackend *backend,
GError **error);
gboolean (*set)(XfconfBackend *backend,
const gchar *channel,
const gchar *property,
const GValue *value,
GError **error);
gboolean (*get)(XfconfBackend *backend,
const gchar *channel,
const gchar *property,
GValue *value,
GError **error);
gboolean (*get_all)(XfconfBackend *backend,
const gchar *channel,
const gchar *property_base,
GHashTable *properties,
GError **error);
gboolean (*exists)(XfconfBackend *backend,
const gchar *channel,
const gchar *property,
gboolean *exists,
GError **error);
gboolean (*reset)(XfconfBackend *backend,
const gchar *channel,
const gchar *property,
gboolean recursive,
GError **error);
gboolean (*list_channels)(XfconfBackend *backend,
GSList **channels,
GError **error);
gboolean (*is_property_locked)(XfconfBackend *backend,
const gchar *channel,
const gchar *property,
gboolean *locked,
GError **error);
gboolean (*flush)(XfconfBackend *backend,
GError **error);
void (*register_property_changed_func)(XfconfBackend *backend,
XfconfPropertyChangedFunc func,
gpointer user_data);
/*< reserved for future expansion >*/
void (*_xb_reserved0)();
void (*_xb_reserved1)();
void (*_xb_reserved2)();
void (*_xb_reserved3)();
};
</pre>
<p>An interface for implementing pluggable configuration store backends
into the Xfconf Daemon.</p>
<p>See the <a class="link" href="xfconf-xfconf-backend.html#XfconfBackend"><span class="type">XfconfBackend</span></a> function documentation for a description of what
each virtual function in <a class="link" href="xfconf-xfconf-backend.html#XfconfBackendInterface" title="struct XfconfBackendInterface"><span class="type">XfconfBackendInterface</span></a> should do.</p>
<div class="refsect3">
<a name="XfconfBackendInterface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="XfconfBackendInterface.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>GObject interface parent.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.initialize"></a>initialize</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-initialize" title="xfconf_backend_initialize ()"><code class="function">xfconf_backend_initialize()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.set"></a>set</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-set" title="xfconf_backend_set ()"><code class="function">xfconf_backend_set()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.get"></a>get</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-get" title="xfconf_backend_get ()"><code class="function">xfconf_backend_get()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.get-all"></a>get_all</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-get-all" title="xfconf_backend_get_all ()"><code class="function">xfconf_backend_get_all()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.exists"></a>exists</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-exists" title="xfconf_backend_exists ()"><code class="function">xfconf_backend_exists()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.reset"></a>reset</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-reset" title="xfconf_backend_reset ()"><code class="function">xfconf_backend_reset()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.list-channels"></a>list_channels</code></em> ()</p></td>
<td class="struct_member_description"><p>See <code class="function">xfconf_backend_list_channels()</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.is-property-locked"></a>is_property_locked</code></em> ()</p></td>
<td class="struct_member_description"><p>See <code class="function">xfconf_backend_is_property_locked()</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.flush"></a>flush</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-flush" title="xfconf_backend_flush ()"><code class="function">xfconf_backend_flush()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.register-property-changed-func"></a>register_property_changed_func</code></em> ()</p></td>
<td class="struct_member_description"><p>See <a class="link" href="xfconf-xfconf-backend.html#xfconf-backend-register-property-changed-func" title="xfconf_backend_register_property_changed_func ()"><code class="function">xfconf_backend_register_property_changed_func()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.-xb-reserved0"></a>_xb_reserved0</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.-xb-reserved1"></a>_xb_reserved1</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.-xb-reserved2"></a>_xb_reserved2</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="XfconfBackendInterface.-xb-reserved3"></a>_xb_reserved3</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future expansion.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="XfconfBackend-struct"></a><h3>XfconfBackend</h3>
<pre class="programlisting">typedef struct _XfconfBackend XfconfBackend;</pre>
<p>An instance of a class implementing a <a class="link" href="xfconf-xfconf-backend.html#XfconfBackendInterface" title="struct XfconfBackendInterface"><span class="type">XfconfBackendInterface</span></a>.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>
|