/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-property-bag.html is in libbonobo2-dev 2.32.1-3.
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 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboPropertyBag</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="property-bags.html" title="Property Bags, Events, Listeners">
<link rel="prev" href="libbonobo-bonobo-listener.html" title="bonobo-listener">
<link rel="next" href="libbonobo-bonobo-arg.html" title="bonobo-arg">
<meta name="generator" content="GTK-Doc V1.19 (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="libbonobo-bonobo-listener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="property-bags.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">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-arg.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-property-bag.synopsis" class="shortcut">Top</a>
|
<a href="#libbonobo-bonobo-property-bag.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-property-bag"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-property-bag.top_of_page"></a>BonoboPropertyBag</span></h2>
<p>BonoboPropertyBag — Implements a generic property storage interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-property-bag.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBagClass" title="BonoboPropertyBagClass">BonoboPropertyBagClass</a>;
struct <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag">BonoboPropertyBag</a>;
#define <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-READABLE:CAPS" title="BONOBO_PROPERTY_READABLE">BONOBO_PROPERTY_READABLE</a>
#define <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITEABLE:CAPS" title="BONOBO_PROPERTY_WRITEABLE">BONOBO_PROPERTY_WRITEABLE</a>
#define <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITABLE:CAPS" title="BONOBO_PROPERTY_WRITABLE">BONOBO_PROPERTY_WRITABLE</a>
#define <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-NO-LISTENING:CAPS" title="BONOBO_PROPERTY_NO_LISTENING">BONOBO_PROPERTY_NO_LISTENING</a>
#define <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-NO-AUTONOTIFY:CAPS" title="BONOBO_PROPERTY_NO_AUTONOTIFY">BONOBO_PROPERTY_NO_AUTONOTIFY</a>
struct <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboProperty" title="struct BonoboProperty">BonoboProperty</a>;
<span class="returnvalue">void</span> (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn" title="BonoboPropertyGetFn ()">*BonoboPropertyGetFn</a>) (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *bag</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *arg</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> arg_id</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</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>);
<span class="returnvalue">void</span> (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn" title="BonoboPropertySetFn ()">*BonoboPropertySetFn</a>) (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *bag</code></em>,
<em class="parameter"><code>const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *arg</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> arg_id</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</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>);
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new" title="bonobo_property_bag_new ()">bonobo_property_bag_new</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn" title="BonoboPropertyGetFn ()"><span class="type">BonoboPropertyGetFn</span></a> get_prop_cb</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn" title="BonoboPropertySetFn ()"><span class="type">BonoboPropertySetFn</span></a> set_prop_cb</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>);
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new-closure" title="bonobo_property_bag_new_closure ()">bonobo_property_bag_new_closure</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>);
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new-full" title="bonobo_property_bag_new_full ()">bonobo_property_bag_new_full</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>,
<em class="parameter"><code><span class="type">BonoboEventSource</span> *es</code></em>);
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-construct" title="bonobo_property_bag_construct ()">bonobo_property_bag_construct</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>,
<em class="parameter"><code><span class="type">BonoboEventSource</span> *es</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add" title="bonobo_property_bag_add ()">bonobo_property_bag_add</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><span class="type">int</span> idx</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType"><span class="type">BonoboArgType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *default_value</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *doctitle</code></em>,
<em class="parameter"><code><span class="type">Bonobo_PropertyFlags</span> flags</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add-full" title="bonobo_property_bag_add_full ()">bonobo_property_bag_add_full</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><span class="type">int</span> idx</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType"><span class="type">BonoboArgType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *default_value</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *doctitle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *docstring</code></em>,
<em class="parameter"><code><span class="type">Bonobo_PropertyFlags</span> flags</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-remove" title="bonobo_property_bag_remove ()">bonobo_property_bag_remove</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-map-params" title="bonobo_property_bag_map_params ()">bonobo_property_bag_map_params</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *on_instance</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> **pspecs</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> n_params</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-get-prop-list" title="bonobo_property_bag_get_prop_list ()">bonobo_property_bag_get_prop_list</a> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-property-bag.description"></a><h2>Description</h2>
<p>
The PropertyBag is used for many things, particularly for
the customization of controls. The important thing to
remember about the BonoboPropertyBag implementation is that
no live data is stored in the bag. ie. the Model for the
properties is your code.
</p>
<p>
Consequently when someone requests a properties value,
or sets a property the callbacks you supply at bag
construction time are called, and the code therein must
supply the property. Similarly, when a property changes
value inside your object you need to notify the property
bag's listeners that it has changed with a call to
<code class="function">bonobo_event_source_notify_listeners_full</code>.
</p>
<p>
Here is a simple example use of the property bag:
</p>
<div class="example">
<a name="id-1.4.5.4.4.1"></a><p class="title"><b>Example 11. PropertyBag Callbacks</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">enum</span> <span class="gtkdoc opt">{</span>
PROP_RUNNING<span class="gtkdoc opt">,</span>
PROP_COLOUR
<span class="gtkdoc opt">}</span> MyArgs<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">get_prop</span> <span class="gtkdoc opt">(</span>BonoboPropertyBag <span class="gtkdoc opt">*</span>bag<span class="gtkdoc opt">,</span>
BonoboArg <span class="gtkdoc opt">*</span>arg<span class="gtkdoc opt">,</span>
guint arg_id<span class="gtkdoc opt">,</span>
CORBA_Environment <span class="gtkdoc opt">*</span>ev<span class="gtkdoc opt">,</span>
gpointer user_data<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
GtkObject <span class="gtkdoc opt">*</span>clock <span class="gtkdoc opt">=</span> user_data<span class="gtkdoc opt">;</span>
<span class="keyword">switch</span> <span class="gtkdoc opt">(</span>arg_id<span class="gtkdoc opt">) {</span>
<span class="keyword">case</span> PROP_RUNNING<span class="gtkdoc opt">:</span>
<span class="function"><a href="libbonobo-bonobo-arg.html#BONOBO-ARG-SET-BOOLEAN:CAPS">BONOBO_ARG_SET_BOOLEAN</a></span> <span class="gtkdoc opt">(</span>arg<span class="gtkdoc opt">,</span> clock<span class="gtkdoc opt">-></span>is_running<span class="gtkdoc opt">);</span>
<span class="keyword">break</span><span class="gtkdoc opt">;</span>
<span class="keyword">case</span> PROP_COLOUR<span class="gtkdoc opt">:</span>
<span class="function"><a href="libbonobo-bonobo-arg.html#BONOBO-ARG-SET-STRING:CAPS">BONOBO_ARG_SET_STRING</a></span> <span class="gtkdoc opt">(</span>arg<span class="gtkdoc opt">,</span> clock<span class="gtkdoc opt">-></span>color<span class="gtkdoc opt">);</span>
<span class="keyword">break</span><span class="gtkdoc opt">;</span>
<span class="keyword">default</span><span class="gtkdoc opt">:</span>
<span class="function"><a href="libbonobo-bonobo-exception.html#bonobo-exception-set">bonobo_exception_set</a></span> <span class="gtkdoc opt">(</span>ev<span class="gtkdoc opt">,</span> ex_Bonobo_PropertyBag_NotFound<span class="gtkdoc opt">);</span>
<span class="keyword">break</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static void</span>
<span class="function">set_prop</span> <span class="gtkdoc opt">(</span>BonoboPropertyBag <span class="gtkdoc opt">*</span>bag<span class="gtkdoc opt">,</span>
<span class="gtkdoc kwb">const</span> BonoboArg <span class="gtkdoc opt">*</span>arg<span class="gtkdoc opt">,</span>
guint arg_id<span class="gtkdoc opt">,</span>
CORBA_Environment <span class="gtkdoc opt">*</span>ev<span class="gtkdoc opt">,</span>
gpointer user_data<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
GtkClock <span class="gtkdoc opt">*</span>clock <span class="gtkdoc opt">=</span> user_data<span class="gtkdoc opt">;</span>
<span class="keyword">switch</span> <span class="gtkdoc opt">(</span>arg_id<span class="gtkdoc opt">) {</span>
<span class="keyword">case</span> PROP_RUNNING<span class="gtkdoc opt">: {</span>
guint i <span class="gtkdoc opt">=</span> <span class="function"><a href="libbonobo-bonobo-arg.html#BONOBO-ARG-GET-BOOLEAN:CAPS">BONOBO_ARG_GET_BOOLEAN</a></span> <span class="gtkdoc opt">(</span>arg<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>i<span class="gtkdoc opt">)</span>
<span class="function">gtk_clock_start</span> <span class="gtkdoc opt">(</span>clock<span class="gtkdoc opt">);</span>
<span class="keyword">else</span>
<span class="function">gtk_clock_stop</span> <span class="gtkdoc opt">(</span>clock<span class="gtkdoc opt">);</span>
<span class="keyword">break</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="keyword">case</span> PROP_COLOUR<span class="gtkdoc opt">:</span>
<span class="function">gtk_clock_set_color</span> <span class="gtkdoc opt">(</span>clock<span class="gtkdoc opt">,</span> <span class="function"><a href="libbonobo-bonobo-arg.html#BONOBO-ARG-GET-STRING:CAPS">BONOBO_ARG_GET_STRING</a></span> <span class="gtkdoc opt">(</span>arg<span class="gtkdoc opt">));</span>
<span class="keyword">default</span><span class="gtkdoc opt">:</span>
<span class="function"><a href="libbonobo-bonobo-exception.html#bonobo-exception-set">bonobo_exception_set</a></span> <span class="gtkdoc opt">(</span>ev<span class="gtkdoc opt">,</span> ex_Bonobo_PropertyBag_NotFound<span class="gtkdoc opt">);</span>
<span class="keyword">break</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="example-break">
</p>
<p>
Then to instantiate the property bag interface and associate it with
a control perhaps we do:
</p>
<div class="example">
<a name="id-1.4.5.4.5.1"></a><p class="title"><b>Example 12. Adding a PropertyBag to a control</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12</pre></td>
<td class="listing_code"><pre class="programlisting">BonoboPropertyBag <span class="gtkdoc opt">*</span>pb<span class="gtkdoc opt">;</span>
pb <span class="gtkdoc opt">=</span> <span class="function"><a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new">bonobo_property_bag_new</a></span> <span class="gtkdoc opt">(</span>get_prop<span class="gtkdoc opt">,</span> set_prop<span class="gtkdoc opt">,</span> clock<span class="gtkdoc opt">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/libbonoboui/libbonoboui-bonobo-control.html#bonobo-control-set-properties">bonobo_control_set_properties</a></span> <span class="gtkdoc opt">(</span>control<span class="gtkdoc opt">,</span> pb<span class="gtkdoc opt">);</span>
<span class="function"><a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add">bonobo_property_bag_add</a></span> <span class="gtkdoc opt">(</span>pb<span class="gtkdoc opt">,</span> <span class="string">"running"</span><span class="gtkdoc opt">,</span> PROP_RUNNING<span class="gtkdoc opt">,</span>
BONOBO_ARG_BOOLEAN<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-I18N.html#gettext-macro">_</a></span><span class="gtkdoc opt">(</span><span class="string">"Whether or not the clock is running"</span><span class="gtkdoc opt">),</span>
<span class="number">0</span><span class="gtkdoc opt">);</span>
<span class="function"><a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add">bonobo_property_bag_add</a></span> <span class="gtkdoc opt">(</span>pb<span class="gtkdoc opt">,</span> <span class="string">"colour"</span><span class="gtkdoc opt">,</span> PROP_COLOUR<span class="gtkdoc opt">,</span>
BONOBO_ARG_STRING<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-I18N.html#gettext-macro">_</a></span><span class="gtkdoc opt">(</span><span class="string">"The colour of the clock face"</span><span class="gtkdoc opt">),</span>
<span class="number">0</span><span class="gtkdoc opt">);</span>
<span class="function"><a href="libbonobo-bonobo-object.html#bonobo-object-unref">bonobo_object_unref</a></span> <span class="gtkdoc opt">(</span><span class="function">BONOBO_OBJECT</span> <span class="gtkdoc opt">(</span>pb<span class="gtkdoc opt">));</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="example-break">
And finally we need to notify listeners of changes in various properties
so we could perhaps do:
</p>
<div class="example">
<a name="id-1.4.5.4.5.2"></a><p class="title"><b>Example 13. Notifying proterty bag listeners</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static void</span>
<span class="function">signal_handler</span> <span class="gtkdoc opt">(</span>GtkClock <span class="gtkdoc opt">*</span>clock<span class="gtkdoc opt">,</span> BonoboPropertyBag <span class="gtkdoc opt">*</span>pb<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
BonoboArg <span class="gtkdoc opt">*</span>arg <span class="gtkdoc opt">=</span> <span class="function"><a href="libbonobo-bonobo-arg.html#bonobo-arg-new">bonobo_arg_new</a></span> <span class="gtkdoc opt">(</span>TC_string<span class="gtkdoc opt">);</span>
<span class="function"><a href="libbonobo-bonobo-arg.html#BONOBO-ARG-SET-STRING:CAPS">BONOBO_ARG_SET_STRING</a></span> <span class="gtkdoc opt">(</span>arg<span class="gtkdoc opt">,</span> <span class="function">gtk_clock_get_color</span> <span class="gtkdoc opt">(</span>clock<span class="gtkdoc opt">));</span>
<span class="function"><a href="libbonobo-bonobo-event-source.html#bonobo-event-source-notify-listeners-full">bonobo_event_source_notify_listeners_full</a></span> <span class="gtkdoc opt">(</span>pb<span class="gtkdoc opt">-></span>es<span class="gtkdoc opt">,</span>
<span class="string">"Bonobo/Property"</span><span class="gtkdoc opt">,</span>
<span class="string">"change"</span><span class="gtkdoc opt">,</span>
<span class="string">"colour"</span><span class="gtkdoc opt">,</span>
arg<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
<span class="function"><a href="libbonobo-bonobo-arg.html#bonobo-arg-release">bonobo_arg_release</a></span> <span class="gtkdoc opt">(</span>arg<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc opt">...</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gtk2/gtk2-Signals.html#gtk-signal-connect">gtk_signal_connect</a></span> <span class="gtkdoc opt">(</span><span class="function">GTK_OBJECT</span> <span class="gtkdoc opt">(</span>clock<span class="gtkdoc opt">),</span> <span class="string">"color_changed"</span><span class="gtkdoc opt">,</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gtk2/gtk2-Types.html#GTK-SIGNAL-FUNC:CAPS">GTK_SIGNAL_FUNC</a></span> <span class="gtkdoc opt">(</span>signal_handler<span class="gtkdoc opt">),</span> pb<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="example-break">
See also <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a>.
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-property-bag.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboPropertyBagClass"></a><h3>BonoboPropertyBagClass</h3>
<pre class="programlisting">typedef struct {
BonoboObjectClass parent;
POA_Bonobo_PropertyBag__epv epv;
} BonoboPropertyBagClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPropertyBag"></a><h3>struct BonoboPropertyBag</h3>
<pre class="programlisting">struct BonoboPropertyBag {
BonoboObject parent;
BonoboPropertyBagPrivate *priv;
BonoboEventSource *es;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-PROPERTY-READABLE:CAPS"></a><h3>BONOBO_PROPERTY_READABLE</h3>
<pre class="programlisting">#define BONOBO_PROPERTY_READABLE Bonobo_PROPERTY_READABLE
</pre>
<p>
If this flag is set, the property allows consulting its value.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-PROPERTY-WRITEABLE:CAPS"></a><h3>BONOBO_PROPERTY_WRITEABLE</h3>
<pre class="programlisting">#define BONOBO_PROPERTY_WRITEABLE Bonobo_PROPERTY_WRITEABLE
</pre>
<p>
If this flag is set, the property supports modification of its value.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-PROPERTY-WRITABLE:CAPS"></a><h3>BONOBO_PROPERTY_WRITABLE</h3>
<pre class="programlisting">#define BONOBO_PROPERTY_WRITABLE Bonobo_PROPERTY_WRITEABLE
</pre>
<p>
Misspelling of <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITEABLE:CAPS" title="BONOBO_PROPERTY_WRITEABLE"><span class="type">BONOBO_PROPERTY_WRITEABLE</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-PROPERTY-NO-LISTENING:CAPS"></a><h3>BONOBO_PROPERTY_NO_LISTENING</h3>
<pre class="programlisting">#define BONOBO_PROPERTY_NO_LISTENING Bonobo_PROPERTY_NO_LISTENING
</pre>
<p>
If this flag set, when the property changes its value its
listeners will *not* be notified.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-PROPERTY-NO-AUTONOTIFY:CAPS"></a><h3>BONOBO_PROPERTY_NO_AUTONOTIFY</h3>
<pre class="programlisting">#define BONOBO_PROPERTY_NO_AUTONOTIFY Bonobo_PROPERTY_NO_AUTONOTIFY
</pre>
<p>
If this flag set, when the property changes its value its
listeners will *not* be notified.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboProperty"></a><h3>struct BonoboProperty</h3>
<pre class="programlisting">struct BonoboProperty {
char *name;
int idx;
BonoboArgType type;
BonoboArg *default_value;
char *doctitle;
char *docstring;
Bonobo_PropertyFlags flags;
BonoboPropertyPrivate *priv;
};
</pre>
<p>
Structure that holds information about a property in a <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="BonoboProperty.name"></a>name</code></em>;</span></p></td>
<td>the canonic name of the property</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="BonoboProperty.idx"></a>idx</code></em>;</span></p></td>
<td>unique numeric identifier of the property within the property bag</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType"><span class="type">BonoboArgType</span></a> <em class="structfield"><code><a name="BonoboProperty.type"></a>type</code></em>;</span></p></td>
<td>type of value contained by this property</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *<em class="structfield"><code><a name="BonoboProperty.default-value"></a>default_value</code></em>;</span></p></td>
<td>the default value</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="BonoboProperty.doctitle"></a>doctitle</code></em>;</span></p></td>
<td>documentation string title</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="BonoboProperty.docstring"></a>docstring</code></em>;</span></p></td>
<td>documentation string</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">Bonobo_PropertyFlags</span> <em class="structfield"><code><a name="BonoboProperty.flags"></a>flags</code></em>;</span></p></td>
<td>property flags (read/write, etc.)</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">BonoboPropertyPrivate</span> *<em class="structfield"><code><a name="BonoboProperty.priv"></a>priv</code></em>;</span></p></td>
<td>implementation private data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPropertyGetFn"></a><h3>BonoboPropertyGetFn ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*BonoboPropertyGetFn) (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *bag</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *arg</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> arg_id</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</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>
Property getter function.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>the property bag</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg</code></em> :</span></p></td>
<td>output parameter; the caller must place here the property value</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg_id</code></em> :</span></p></td>
<td>unique numeric identifier of the property within the property bag</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>the relevant CORBA environment</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPropertySetFn"></a><h3>BonoboPropertySetFn ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*BonoboPropertySetFn) (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *bag</code></em>,
<em class="parameter"><code>const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *arg</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> arg_id</code></em>,
<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</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>
Property setter function.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>the property bag</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg</code></em> :</span></p></td>
<td>the new property value to be set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg_id</code></em> :</span></p></td>
<td>unique numeric identifier of the property within the property bag</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>the relevant CORBA environment</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-new"></a><h3>bonobo_property_bag_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * bonobo_property_bag_new (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn" title="BonoboPropertyGetFn ()"><span class="type">BonoboPropertyGetFn</span></a> get_prop_cb</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn" title="BonoboPropertySetFn ()"><span class="type">BonoboPropertySetFn</span></a> set_prop_cb</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>
Creates a new property bag with the specified callbacks.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>get_prop_cb</code></em> :</span></p></td>
<td>the property get callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_prop_cb</code></em> :</span></p></td>
<td>the property set callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data for the callbacks</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-new-closure"></a><h3>bonobo_property_bag_new_closure ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * bonobo_property_bag_new_closure (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>);</pre>
<p>
Creates a new property bag with the specified callbacks.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em> :</span></p></td>
<td>the property get closure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em> :</span></p></td>
<td>the property set closure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-new-full"></a><h3>bonobo_property_bag_new_full ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * bonobo_property_bag_new_full (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>,
<em class="parameter"><code><span class="type">BonoboEventSource</span> *es</code></em>);</pre>
<p>
Creates a new property bag with the specified callbacks.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em> :</span></p></td>
<td>the property get closure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em> :</span></p></td>
<td>the property set closure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>es</code></em> :</span></p></td>
<td>an event source to aggregate</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-construct"></a><h3>bonobo_property_bag_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="returnvalue">BonoboPropertyBag</span></a> * bonobo_property_bag_construct (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>,
<em class="parameter"><code><span class="type">BonoboEventSource</span> *es</code></em>);</pre>
<p>
Constructor, only for use in wrappers and object derivation, please
refer to the <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new" title="bonobo_property_bag_new ()"><span class="type">bonobo_property_bag_new</span></a> for normal use.
</p>
<p>
This function returns <em class="parameter"><code>pb</code></em>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of error. If it returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
the passed in <em class="parameter"><code>pb</code></em> is unrefed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pb</code></em> :</span></p></td>
<td>
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> to construct</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em> :</span></p></td>
<td>the property get closure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em> :</span></p></td>
<td>the property set closure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>es</code></em> :</span></p></td>
<td>an event source to aggregate</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> pointer or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-add"></a><h3>bonobo_property_bag_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_property_bag_add (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><span class="type">int</span> idx</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType"><span class="type">BonoboArgType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *default_value</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *doctitle</code></em>,
<em class="parameter"><code><span class="type">Bonobo_PropertyFlags</span> flags</code></em>);</pre>
<p>
Adds a property to the property bag.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pb</code></em> :</span></p></td>
<td>property bag to add to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of new property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>idx</code></em> :</span></p></td>
<td>integer index for fast callback switch statement</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the CORBA type eg. TC_long</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_value</code></em> :</span></p></td>
<td>the default value or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doctitle</code></em> :</span></p></td>
<td>the translated documentation string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>various flags</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-add-full"></a><h3>bonobo_property_bag_add_full ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_property_bag_add_full (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><span class="type">int</span> idx</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType"><span class="type">BonoboArgType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a> *default_value</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *doctitle</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *docstring</code></em>,
<em class="parameter"><code><span class="type">Bonobo_PropertyFlags</span> flags</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *get_prop</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *set_prop</code></em>);</pre>
<p>
This adds a property to <em class="parameter"><code>pb</code></em> at the full tilt of complexity.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pb</code></em> :</span></p></td>
<td>property bag to add to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of new property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>idx</code></em> :</span></p></td>
<td>integer index for fast callback switch statement</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the CORBA type eg. TC_long</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_value</code></em> :</span></p></td>
<td>the default value or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doctitle</code></em> :</span></p></td>
<td>the translated documentation title</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>docstring</code></em> :</span></p></td>
<td>the translated documentation string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>various flags</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em> :</span></p></td>
<td>a per property get callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em> :</span></p></td>
<td>a per property set callback</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-remove"></a><h3>bonobo_property_bag_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_property_bag_remove (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
removes the property with <em class="parameter"><code>name</code></em> from <em class="parameter"><code>b</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pb</code></em> :</span></p></td>
<td>the property bag</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of property to remove.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-map-params"></a><h3>bonobo_property_bag_map_params ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_property_bag_map_params (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *on_instance</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> **pspecs</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> n_params</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-property-bag-get-prop-list"></a><h3>bonobo_property_bag_get_prop_list ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * bonobo_property_bag_get_prop_list (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> *pb</code></em>);</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pb</code></em> :</span></p></td>
<td>A <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag" title="struct BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboProperty" title="struct BonoboProperty"><span class="type">BonoboProperty</span></a> structures. This function is
private and should only be used internally, or in a PropertyBag
persistence implementation. You should not touch the
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboProperty" title="struct BonoboProperty"><span class="type">BonoboProperty</span></a> structure unless you know what you're doing.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|