~ubuntu-branches/ubuntu/gutsy/libbonobo/gutsy

« back to all changes in this revision

Viewing changes to doc/api/html/libbonobo-bonobo-property-bag.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-09-17 16:38:13 UTC
  • mfrom: (1.1.16 upstream)
  • Revision ID: james.westby@ubuntu.com-20070917163813-sg2l3nt1q6s3lybq
Tags: 2.20.0-0ubuntu1
* New upstream version:
  - Add unit test for bug 427992.
  - Align configure switches
  - Updated translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>BonoboPropertyBag</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="Libbonobo Reference Manual">
8
8
<link rel="up" href="property-bags.html" title="Property Bags, Events, Listeners">
9
9
<link rel="prev" href="libbonobo-bonobo-listener.html" title="bonobo-listener">
28
28
<th width="100%" align="center">Libbonobo Reference Manual</th>
29
29
<td><a accesskey="n" href="libbonobo-bonobo-arg.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2600506" class="shortcut">Top</a>
 
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3083226" class="shortcut">Top</a>
32
32
                  &#160;|&#160;
33
 
                  <a href="#id2601132" class="shortcut">Description</a></nobr></td></tr>
 
33
                  <a href="#id3083851" class="shortcut">Description</a></nobr></td></tr>
34
34
</table>
35
35
<div class="refentry" lang="en">
36
36
<a name="libbonobo-bonobo-property-bag"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
38
38
<td valign="top">
39
39
<h2>
40
 
<a name="id2600506"></a><span class="refentrytitle">BonoboPropertyBag</span>
 
40
<a name="id3083226"></a><span class="refentrytitle">BonoboPropertyBag</span>
41
41
</h2>
42
42
<p>BonoboPropertyBag &#8212; Implements a generic property storage interface</p>
43
43
</td>
49
49
 
50
50
 
51
51
 
52
 
                    <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBagClass">BonoboPropertyBagClass</a>;
53
 
                    <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>;
54
 
#define             <a href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-READABLE:CAPS">BONOBO_PROPERTY_READABLE</a>
55
 
#define             <a href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITEABLE:CAPS">BONOBO_PROPERTY_WRITEABLE</a>
56
 
#define             <a href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITABLE:CAPS">BONOBO_PROPERTY_WRITABLE</a>
57
 
#define             <a href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-NO-LISTENING:CAPS">BONOBO_PROPERTY_NO_LISTENING</a>
58
 
#define             <a href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-NO-AUTONOTIFY:CAPS">BONOBO_PROPERTY_NO_AUTONOTIFY</a>
59
 
                    <a href="libbonobo-bonobo-property-bag.html#BonoboProperty">BonoboProperty</a>;
60
 
void                (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn">*BonoboPropertyGetFn</a>)              (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
61
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
62
 
                                                         guint arg_id,
63
 
                                                         CORBA_Environment *ev,
64
 
                                                         gpointer user_data);
65
 
void                (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn">*BonoboPropertySetFn</a>)              (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
66
 
                                                         const <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
67
 
                                                         guint arg_id,
68
 
                                                         CORBA_Environment *ev,
69
 
                                                         gpointer user_data);
70
 
<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new">bonobo_property_bag_new</a>             (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn">BonoboPropertyGetFn</a> get_prop_cb,
71
 
                                                         <a href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn">BonoboPropertySetFn</a> set_prop_cb,
72
 
                                                         gpointer user_data);
73
 
<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new-closure">bonobo_property_bag_new_closure</a>     (GClosure *get_prop,
74
 
                                                         GClosure *set_prop);
75
 
<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new-full">bonobo_property_bag_new_full</a>        (GClosure *get_prop,
76
 
                                                         GClosure *set_prop,
77
 
                                                         BonoboEventSource *es);
78
 
<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-construct">bonobo_property_bag_construct</a>       (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
79
 
                                                         GClosure *get_prop,
80
 
                                                         GClosure *set_prop,
81
 
                                                         BonoboEventSource *es);
82
 
void                <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add">bonobo_property_bag_add</a>             (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
52
                    <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBagClass">BonoboPropertyBagClass</a>;
 
53
                    <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>;
 
54
#define             <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-READABLE:CAPS">BONOBO_PROPERTY_READABLE</a>
 
55
#define             <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITEABLE:CAPS">BONOBO_PROPERTY_WRITEABLE</a>
 
56
#define             <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITABLE:CAPS">BONOBO_PROPERTY_WRITABLE</a>
 
57
#define             <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-NO-LISTENING:CAPS">BONOBO_PROPERTY_NO_LISTENING</a>
 
58
#define             <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-NO-AUTONOTIFY:CAPS">BONOBO_PROPERTY_NO_AUTONOTIFY</a>
 
59
                    <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboProperty">BonoboProperty</a>;
 
60
void                (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn">*BonoboPropertyGetFn</a>)              (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
 
61
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
 
62
                                                         <a
 
63
href="../glib/glib-Basic-Types.html#guint"
 
64
>guint</a> arg_id,
 
65
                                                         CORBA_Environment *ev,
 
66
                                                         <a
 
67
href="../glib/glib-Basic-Types.html#gpointer"
 
68
>gpointer</a> user_data);
 
69
void                (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn">*BonoboPropertySetFn</a>)              (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
 
70
                                                         const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
 
71
                                                         <a
 
72
href="../glib/glib-Basic-Types.html#guint"
 
73
>guint</a> arg_id,
 
74
                                                         CORBA_Environment *ev,
 
75
                                                         <a
 
76
href="../glib/glib-Basic-Types.html#gpointer"
 
77
>gpointer</a> user_data);
 
78
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new">bonobo_property_bag_new</a>             (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn">BonoboPropertyGetFn</a> get_prop_cb,
 
79
                                                         <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn">BonoboPropertySetFn</a> set_prop_cb,
 
80
                                                         <a
 
81
href="../glib/glib-Basic-Types.html#gpointer"
 
82
>gpointer</a> user_data);
 
83
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new-closure">bonobo_property_bag_new_closure</a>     (<a
 
84
href="../gobject/gobject-Closures.html#GClosure"
 
85
>GClosure</a> *get_prop,
 
86
                                                         <a
 
87
href="../gobject/gobject-Closures.html#GClosure"
 
88
>GClosure</a> *set_prop);
 
89
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new-full">bonobo_property_bag_new_full</a>        (<a
 
90
href="../gobject/gobject-Closures.html#GClosure"
 
91
>GClosure</a> *get_prop,
 
92
                                                         <a
 
93
href="../gobject/gobject-Closures.html#GClosure"
 
94
>GClosure</a> *set_prop,
 
95
                                                         BonoboEventSource *es);
 
96
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-construct">bonobo_property_bag_construct</a>       (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
97
                                                         <a
 
98
href="../gobject/gobject-Closures.html#GClosure"
 
99
>GClosure</a> *get_prop,
 
100
                                                         <a
 
101
href="../gobject/gobject-Closures.html#GClosure"
 
102
>GClosure</a> *set_prop,
 
103
                                                         BonoboEventSource *es);
 
104
void                <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add">bonobo_property_bag_add</a>             (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
83
105
                                                         const char *name,
84
106
                                                         int idx,
85
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
86
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
 
107
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
 
108
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
87
109
                                                         const char *doctitle,
88
110
                                                         Bonobo_PropertyFlags flags);
89
 
void                <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add-full">bonobo_property_bag_add_full</a>        (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
111
void                <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-add-full">bonobo_property_bag_add_full</a>        (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
90
112
                                                         const char *name,
91
113
                                                         int idx,
92
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
93
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
 
114
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
 
115
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
94
116
                                                         const char *doctitle,
95
117
                                                         const char *docstring,
96
118
                                                         Bonobo_PropertyFlags flags,
97
 
                                                         GClosure *get_prop,
98
 
                                                         GClosure *set_prop);
99
 
void                <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-remove">bonobo_property_bag_remove</a>          (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
119
                                                         <a
 
120
href="../gobject/gobject-Closures.html#GClosure"
 
121
>GClosure</a> *get_prop,
 
122
                                                         <a
 
123
href="../gobject/gobject-Closures.html#GClosure"
 
124
>GClosure</a> *set_prop);
 
125
void                <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-remove">bonobo_property_bag_remove</a>          (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
100
126
                                                         const char *name);
101
 
void                <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-map-params">bonobo_property_bag_map_params</a>      (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
102
 
                                                         GObject *on_instance,
103
 
                                                         const GParamSpec **pspecs,
104
 
                                                         guint n_params);
105
 
GList*              <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-get-prop-list">bonobo_property_bag_get_prop_list</a>   (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb);
 
127
void                <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-map-params">bonobo_property_bag_map_params</a>      (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
128
                                                         <a
 
129
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
130
>GObject</a> *on_instance,
 
131
                                                         const <a
 
132
href="../gobject/gobject-GParamSpec.html#GParamSpec"
 
133
>GParamSpec</a> **pspecs,
 
134
                                                         <a
 
135
href="../glib/glib-Basic-Types.html#guint"
 
136
>guint</a> n_params);
 
137
<a
 
138
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
139
>GList</a>*              <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-get-prop-list">bonobo_property_bag_get_prop_list</a>   (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb);
106
140
 
107
141
 
108
142
</pre>
109
143
</div>
110
144
<div class="refsect1" lang="en">
111
 
<a name="id2601132"></a><h2>Description</h2>
 
145
<a name="id3083851"></a><h2>Description</h2>
112
146
<p>
113
147
The PropertyBag is used for many things, particularly for
114
148
the customization of controls. The important thing to
129
163
Here is a simple example use of the property bag:
130
164
  </p>
131
165
<div class="example">
132
 
<a name="id2601168"></a><p class="title"><b>Example&#160;11.&#160;PropertyBag Callbacks</b></p>
 
166
<a name="id3083887"></a><p class="title"><b>Example&#160;11.&#160;PropertyBag Callbacks</b></p>
133
167
<div class="example-contents"><pre class="programlisting">
134
168
enum {
135
169
        PROP_RUNNING,
199
233
a control perhaps we do:
200
234
  </p>
201
235
<div class="example">
202
 
<a name="id2601203"></a><p class="title"><b>Example&#160;12.&#160;Adding a PropertyBag to a control</b></p>
 
236
<a name="id3083922"></a><p class="title"><b>Example&#160;12.&#160;Adding a PropertyBag to a control</b></p>
203
237
<div class="example-contents"><pre class="programlisting">
204
238
        BonoboPropertyBag *pb;
205
239
 
224
258
so we could perhaps do:
225
259
  </p>
226
260
<div class="example">
227
 
<a name="id2601225"></a><p class="title"><b>Example&#160;13.&#160;Notifying proterty bag listeners</b></p>
 
261
<a name="id3083945"></a><p class="title"><b>Example&#160;13.&#160;Notifying proterty bag listeners</b></p>
228
262
<div class="example-contents"><pre class="programlisting">
229
263
static void
230
264
signal_handler (GtkClock *clock, BonoboPropertyBag *pb)
246
280
     </pre></div>
247
281
</div>
248
282
<p><br class="example-break">
249
 
  See also <a href="libbonobo-bonobo-arg.html#BonoboArg"><span class="type">BonoboArg</span></a>.
 
283
  See also <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg"><span class="type">BonoboArg</span></a>.
250
284
</p>
251
285
</div>
252
286
<div class="refsect1" lang="en">
253
 
<a name="id2601256"></a><h2>Details</h2>
 
287
<a name="id3083976"></a><h2>Details</h2>
254
288
<div class="refsect2" lang="en">
255
 
<a name="id2601267"></a><h3>
 
289
<a name="id3083986"></a><h3>
256
290
<a name="BonoboPropertyBagClass"></a>BonoboPropertyBagClass</h3>
257
 
<a class="indexterm" name="id2601280"></a><pre class="programlisting">typedef struct {
 
291
<a class="indexterm" name="id3083999"></a><pre class="programlisting">typedef struct {
258
292
        BonoboObjectClass        parent;
259
293
 
260
294
        POA_Bonobo_PropertyBag__epv epv;
266
300
</div>
267
301
<hr>
268
302
<div class="refsect2" lang="en">
269
 
<a name="id2601297"></a><h3>
 
303
<a name="id3084016"></a><h3>
270
304
<a name="BonoboPropertyBag"></a>BonoboPropertyBag</h3>
271
 
<a class="indexterm" name="id2601309"></a><pre class="programlisting">typedef struct {
 
305
<a class="indexterm" name="id3084028"></a><pre class="programlisting">typedef struct {
272
306
        BonoboObject             parent;
273
307
        BonoboPropertyBagPrivate *priv;
274
308
        BonoboEventSource        *es;
280
314
</div>
281
315
<hr>
282
316
<div class="refsect2" lang="en">
283
 
<a name="id2601326"></a><h3>
 
317
<a name="id3084046"></a><h3>
284
318
<a name="BONOBO-PROPERTY-READABLE:CAPS"></a>BONOBO_PROPERTY_READABLE</h3>
285
 
<a class="indexterm" name="id2601341"></a><pre class="programlisting">#define BONOBO_PROPERTY_READABLE      Bonobo_PROPERTY_READABLE
 
319
<a class="indexterm" name="id3084060"></a><pre class="programlisting">#define BONOBO_PROPERTY_READABLE      Bonobo_PROPERTY_READABLE
286
320
</pre>
287
321
<p>
288
322
    If this flag is set, the property allows consulting its value.
290
324
</div>
291
325
<hr>
292
326
<div class="refsect2" lang="en">
293
 
<a name="id2601358"></a><h3>
 
327
<a name="id3084077"></a><h3>
294
328
<a name="BONOBO-PROPERTY-WRITEABLE:CAPS"></a>BONOBO_PROPERTY_WRITEABLE</h3>
295
 
<a class="indexterm" name="id2601370"></a><pre class="programlisting">#define BONOBO_PROPERTY_WRITEABLE     Bonobo_PROPERTY_WRITEABLE
 
329
<a class="indexterm" name="id3084090"></a><pre class="programlisting">#define BONOBO_PROPERTY_WRITEABLE     Bonobo_PROPERTY_WRITEABLE
296
330
</pre>
297
331
<p>
298
332
    If this flag is set, the property supports modification of its value.
300
334
</div>
301
335
<hr>
302
336
<div class="refsect2" lang="en">
303
 
<a name="id2601388"></a><h3>
 
337
<a name="id3084108"></a><h3>
304
338
<a name="BONOBO-PROPERTY-WRITABLE:CAPS"></a>BONOBO_PROPERTY_WRITABLE</h3>
305
 
<a class="indexterm" name="id2601402"></a><pre class="programlisting">#define BONOBO_PROPERTY_WRITABLE      Bonobo_PROPERTY_WRITEABLE
 
339
<a class="indexterm" name="id3084121"></a><pre class="programlisting">#define BONOBO_PROPERTY_WRITABLE      Bonobo_PROPERTY_WRITEABLE
306
340
</pre>
307
341
<p>
308
 
    Misspelling of <a href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITEABLE:CAPS"><span class="type">BONOBO_PROPERTY_WRITEABLE</span></a>.
 
342
    Misspelling of <a class="link" href="libbonobo-bonobo-property-bag.html#BONOBO-PROPERTY-WRITEABLE:CAPS"><span class="type">BONOBO_PROPERTY_WRITEABLE</span></a>.
309
343
</p>
310
344
</div>
311
345
<hr>
312
346
<div class="refsect2" lang="en">
313
 
<a name="id2601427"></a><h3>
 
347
<a name="id3084146"></a><h3>
314
348
<a name="BONOBO-PROPERTY-NO-LISTENING:CAPS"></a>BONOBO_PROPERTY_NO_LISTENING</h3>
315
 
<a class="indexterm" name="id2601440"></a><pre class="programlisting">#define BONOBO_PROPERTY_NO_LISTENING  Bonobo_PROPERTY_NO_LISTENING 
 
349
<a class="indexterm" name="id3084159"></a><pre class="programlisting">#define BONOBO_PROPERTY_NO_LISTENING  Bonobo_PROPERTY_NO_LISTENING 
316
350
</pre>
317
351
<p>
318
352
    If this flag set, when the property changes its value its
321
355
</div>
322
356
<hr>
323
357
<div class="refsect2" lang="en">
324
 
<a name="id2601458"></a><h3>
 
358
<a name="id3084177"></a><h3>
325
359
<a name="BONOBO-PROPERTY-NO-AUTONOTIFY:CAPS"></a>BONOBO_PROPERTY_NO_AUTONOTIFY</h3>
326
 
<a class="indexterm" name="id2601471"></a><pre class="programlisting">#define BONOBO_PROPERTY_NO_AUTONOTIFY Bonobo_PROPERTY_NO_AUTONOTIFY 
 
360
<a class="indexterm" name="id3084190"></a><pre class="programlisting">#define BONOBO_PROPERTY_NO_AUTONOTIFY Bonobo_PROPERTY_NO_AUTONOTIFY 
327
361
</pre>
328
362
<p>
329
363
    If this flag set, when the property changes its value its
332
366
</div>
333
367
<hr>
334
368
<div class="refsect2" lang="en">
335
 
<a name="id2601489"></a><h3>
 
369
<a name="id3084208"></a><h3>
336
370
<a name="BonoboProperty"></a>BonoboProperty</h3>
337
 
<a class="indexterm" name="id2601502"></a><pre class="programlisting">typedef struct {
 
371
<a class="indexterm" name="id3084221"></a><pre class="programlisting">typedef struct {
338
372
        char                  *name;
339
373
        int                    idx;
340
374
        BonoboArgType          type;
347
381
} BonoboProperty;
348
382
</pre>
349
383
<p>
350
 
Structure that holds information about a property in a <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a>.
 
384
Structure that holds information about a property in a <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a>.
351
385
</p>
352
386
<div class="variablelist"><table border="0">
353
387
<col align="left" valign="top">
354
388
<tbody>
355
389
<tr>
356
 
<td><span class="term">char&#160;*<em class="structfield"><code>name</code></em>;</span></td>
 
390
<td><p><span class="term">char&#160;*<em class="structfield"><code>name</code></em>;</span></p></td>
357
391
<td>the canonic name of the property
358
392
</td>
359
393
</tr>
360
394
<tr>
361
 
<td><span class="term">int&#160;<em class="structfield"><code>idx</code></em>;</span></td>
 
395
<td><p><span class="term">int&#160;<em class="structfield"><code>idx</code></em>;</span></p></td>
362
396
<td>unique numeric identifier of the property within the property bag
363
397
</td>
364
398
</tr>
365
399
<tr>
366
 
<td><span class="term"><a href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a>&#160;<em class="structfield"><code>type</code></em>;</span></td>
 
400
<td><p><span class="term"><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a>&#160;<em class="structfield"><code>type</code></em>;</span></p></td>
367
401
<td>type of value contained by this property
368
402
</td>
369
403
</tr>
370
404
<tr>
371
 
<td><span class="term"><a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a>&#160;*<em class="structfield"><code>default_value</code></em>;</span></td>
 
405
<td><p><span class="term"><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a>&#160;*<em class="structfield"><code>default_value</code></em>;</span></p></td>
372
406
<td>the default value
373
407
</td>
374
408
</tr>
375
409
<tr>
376
 
<td><span class="term">char&#160;*<em class="structfield"><code>doctitle</code></em>;</span></td>
 
410
<td><p><span class="term">char&#160;*<em class="structfield"><code>doctitle</code></em>;</span></p></td>
377
411
<td>documentation string title
378
412
</td>
379
413
</tr>
380
414
<tr>
381
 
<td><span class="term">char&#160;*<em class="structfield"><code>docstring</code></em>;</span></td>
 
415
<td><p><span class="term">char&#160;*<em class="structfield"><code>docstring</code></em>;</span></p></td>
382
416
<td>documentation string
383
417
</td>
384
418
</tr>
385
419
<tr>
386
 
<td><span class="term">Bonobo_PropertyFlags&#160;<em class="structfield"><code>flags</code></em>;</span></td>
 
420
<td><p><span class="term">Bonobo_PropertyFlags&#160;<em class="structfield"><code>flags</code></em>;</span></p></td>
387
421
<td>property flags (read/write, etc.)
388
422
</td>
389
423
</tr>
390
424
<tr>
391
 
<td><span class="term">BonoboPropertyPrivate&#160;*<em class="structfield"><code>priv</code></em>;</span></td>
 
425
<td><p><span class="term">BonoboPropertyPrivate&#160;*<em class="structfield"><code>priv</code></em>;</span></p></td>
392
426
<td>implementation private data
393
427
 
394
428
</td>
398
432
</div>
399
433
<hr>
400
434
<div class="refsect2" lang="en">
401
 
<a name="id2601702"></a><h3>
 
435
<a name="id3084421"></a><h3>
402
436
<a name="BonoboPropertyGetFn"></a>BonoboPropertyGetFn ()</h3>
403
 
<a class="indexterm" name="id2601716"></a><pre class="programlisting">void                (*BonoboPropertyGetFn)              (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
404
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
405
 
                                                         guint arg_id,
 
437
<a class="indexterm" name="id3084435"></a><pre class="programlisting">void                (*BonoboPropertyGetFn)              (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
 
438
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
 
439
                                                         <a
 
440
href="../glib/glib-Basic-Types.html#guint"
 
441
>guint</a> arg_id,
406
442
                                                         CORBA_Environment *ev,
407
 
                                                         gpointer user_data);</pre>
 
443
                                                         <a
 
444
href="../glib/glib-Basic-Types.html#gpointer"
 
445
>gpointer</a> user_data);</pre>
408
446
<p>
409
447
Property getter function.
410
448
</p>
412
450
<col align="left" valign="top">
413
451
<tbody>
414
452
<tr>
415
 
<td><span class="term"><em class="parameter"><code>bag</code></em>&#160;:</span></td>
 
453
<td><p><span class="term"><em class="parameter"><code>bag</code></em>&#160;:</span></p></td>
416
454
<td>the property bag
417
455
</td>
418
456
</tr>
419
457
<tr>
420
 
<td><span class="term"><em class="parameter"><code>arg</code></em>&#160;:</span></td>
 
458
<td><p><span class="term"><em class="parameter"><code>arg</code></em>&#160;:</span></p></td>
421
459
<td>output parameter; the caller must place here the property value
422
460
</td>
423
461
</tr>
424
462
<tr>
425
 
<td><span class="term"><em class="parameter"><code>arg_id</code></em>&#160;:</span></td>
 
463
<td><p><span class="term"><em class="parameter"><code>arg_id</code></em>&#160;:</span></p></td>
426
464
<td>unique numeric identifier of the property within the property bag
427
465
</td>
428
466
</tr>
429
467
<tr>
430
 
<td><span class="term"><em class="parameter"><code>ev</code></em>&#160;:</span></td>
 
468
<td><p><span class="term"><em class="parameter"><code>ev</code></em>&#160;:</span></p></td>
431
469
<td>the relevant CORBA environment
432
470
</td>
433
471
</tr>
434
472
<tr>
435
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
473
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
436
474
<td>user data
437
475
 
438
476
 
443
481
</div>
444
482
<hr>
445
483
<div class="refsect2" lang="en">
446
 
<a name="id2601851"></a><h3>
 
484
<a name="id3084570"></a><h3>
447
485
<a name="BonoboPropertySetFn"></a>BonoboPropertySetFn ()</h3>
448
 
<a class="indexterm" name="id2601865"></a><pre class="programlisting">void                (*BonoboPropertySetFn)              (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
449
 
                                                         const <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
450
 
                                                         guint arg_id,
 
486
<a class="indexterm" name="id3084584"></a><pre class="programlisting">void                (*BonoboPropertySetFn)              (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *bag,
 
487
                                                         const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *arg,
 
488
                                                         <a
 
489
href="../glib/glib-Basic-Types.html#guint"
 
490
>guint</a> arg_id,
451
491
                                                         CORBA_Environment *ev,
452
 
                                                         gpointer user_data);</pre>
 
492
                                                         <a
 
493
href="../glib/glib-Basic-Types.html#gpointer"
 
494
>gpointer</a> user_data);</pre>
453
495
<p>
454
496
Property setter function.
455
497
</p>
457
499
<col align="left" valign="top">
458
500
<tbody>
459
501
<tr>
460
 
<td><span class="term"><em class="parameter"><code>bag</code></em>&#160;:</span></td>
 
502
<td><p><span class="term"><em class="parameter"><code>bag</code></em>&#160;:</span></p></td>
461
503
<td>the property bag
462
504
</td>
463
505
</tr>
464
506
<tr>
465
 
<td><span class="term"><em class="parameter"><code>arg</code></em>&#160;:</span></td>
 
507
<td><p><span class="term"><em class="parameter"><code>arg</code></em>&#160;:</span></p></td>
466
508
<td>the new property value to be set
467
509
</td>
468
510
</tr>
469
511
<tr>
470
 
<td><span class="term"><em class="parameter"><code>arg_id</code></em>&#160;:</span></td>
 
512
<td><p><span class="term"><em class="parameter"><code>arg_id</code></em>&#160;:</span></p></td>
471
513
<td>unique numeric identifier of the property within the property bag
472
514
</td>
473
515
</tr>
474
516
<tr>
475
 
<td><span class="term"><em class="parameter"><code>ev</code></em>&#160;:</span></td>
 
517
<td><p><span class="term"><em class="parameter"><code>ev</code></em>&#160;:</span></p></td>
476
518
<td>the relevant CORBA environment
477
519
</td>
478
520
</tr>
479
521
<tr>
480
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
522
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
481
523
<td>user data
482
524
 
483
525
 
488
530
</div>
489
531
<hr>
490
532
<div class="refsect2" lang="en">
491
 
<a name="id2602000"></a><h3>
 
533
<a name="id3084719"></a><h3>
492
534
<a name="bonobo-property-bag-new"></a>bonobo_property_bag_new ()</h3>
493
 
<a class="indexterm" name="id2602013"></a><pre class="programlisting"><a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_new             (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn">BonoboPropertyGetFn</a> get_prop_cb,
494
 
                                                         <a href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn">BonoboPropertySetFn</a> set_prop_cb,
495
 
                                                         gpointer user_data);</pre>
 
535
<a class="indexterm" name="id3084732"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_new             (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyGetFn">BonoboPropertyGetFn</a> get_prop_cb,
 
536
                                                         <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertySetFn">BonoboPropertySetFn</a> set_prop_cb,
 
537
                                                         <a
 
538
href="../glib/glib-Basic-Types.html#gpointer"
 
539
>gpointer</a> user_data);</pre>
496
540
<p>
497
541
Creates a new property bag with the specified callbacks.</p>
498
542
<p>
502
546
<col align="left" valign="top">
503
547
<tbody>
504
548
<tr>
505
 
<td><span class="term"><em class="parameter"><code>get_prop_cb</code></em>&#160;:</span></td>
 
549
<td><p><span class="term"><em class="parameter"><code>get_prop_cb</code></em>&#160;:</span></p></td>
506
550
<td> the property get callback
507
551
</td>
508
552
</tr>
509
553
<tr>
510
 
<td><span class="term"><em class="parameter"><code>set_prop_cb</code></em>&#160;:</span></td>
 
554
<td><p><span class="term"><em class="parameter"><code>set_prop_cb</code></em>&#160;:</span></p></td>
511
555
<td> the property set callback
512
556
</td>
513
557
</tr>
514
558
<tr>
515
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
559
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
516
560
<td> user data for the callbacks
517
561
</td>
518
562
</tr>
519
563
<tr>
520
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
521
 
<td> A new <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.
 
564
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
565
<td> A new <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.
522
566
</td>
523
567
</tr>
524
568
</tbody>
526
570
</div>
527
571
<hr>
528
572
<div class="refsect2" lang="en">
529
 
<a name="id2602128"></a><h3>
 
573
<a name="id3084848"></a><h3>
530
574
<a name="bonobo-property-bag-new-closure"></a>bonobo_property_bag_new_closure ()</h3>
531
 
<a class="indexterm" name="id2602142"></a><pre class="programlisting"><a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_new_closure     (GClosure *get_prop,
532
 
                                                         GClosure *set_prop);</pre>
 
575
<a class="indexterm" name="id3084861"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_new_closure     (<a
 
576
href="../gobject/gobject-Closures.html#GClosure"
 
577
>GClosure</a> *get_prop,
 
578
                                                         <a
 
579
href="../gobject/gobject-Closures.html#GClosure"
 
580
>GClosure</a> *set_prop);</pre>
533
581
<p>
534
582
Creates a new property bag with the specified callbacks.</p>
535
583
<p>
539
587
<col align="left" valign="top">
540
588
<tbody>
541
589
<tr>
542
 
<td><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></td>
 
590
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></p></td>
543
591
<td> the property get closure
544
592
</td>
545
593
</tr>
546
594
<tr>
547
 
<td><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></td>
 
595
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></p></td>
548
596
<td> the property set closure
549
597
</td>
550
598
</tr>
551
599
<tr>
552
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
553
 
<td> A new <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.
 
600
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
601
<td> A new <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.
554
602
</td>
555
603
</tr>
556
604
</tbody>
558
606
</div>
559
607
<hr>
560
608
<div class="refsect2" lang="en">
561
 
<a name="id2602234"></a><h3>
 
609
<a name="id3084954"></a><h3>
562
610
<a name="bonobo-property-bag-new-full"></a>bonobo_property_bag_new_full ()</h3>
563
 
<a class="indexterm" name="id2602248"></a><pre class="programlisting"><a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_new_full        (GClosure *get_prop,
564
 
                                                         GClosure *set_prop,
 
611
<a class="indexterm" name="id3084967"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_new_full        (<a
 
612
href="../gobject/gobject-Closures.html#GClosure"
 
613
>GClosure</a> *get_prop,
 
614
                                                         <a
 
615
href="../gobject/gobject-Closures.html#GClosure"
 
616
>GClosure</a> *set_prop,
565
617
                                                         BonoboEventSource *es);</pre>
566
618
<p>
567
619
Creates a new property bag with the specified callbacks.</p>
572
624
<col align="left" valign="top">
573
625
<tbody>
574
626
<tr>
575
 
<td><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></td>
 
627
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></p></td>
576
628
<td> the property get closure
577
629
</td>
578
630
</tr>
579
631
<tr>
580
 
<td><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></td>
 
632
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></p></td>
581
633
<td> the property set closure
582
634
</td>
583
635
</tr>
584
636
<tr>
585
 
<td><span class="term"><em class="parameter"><code>es</code></em>&#160;:</span></td>
 
637
<td><p><span class="term"><em class="parameter"><code>es</code></em>&#160;:</span></p></td>
586
638
<td> an event source to aggregate
587
639
</td>
588
640
</tr>
589
641
<tr>
590
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
591
 
<td> A new <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.
 
642
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
643
<td> A new <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> object.
592
644
</td>
593
645
</tr>
594
646
</tbody>
596
648
</div>
597
649
<hr>
598
650
<div class="refsect2" lang="en">
599
 
<a name="id2602363"></a><h3>
 
651
<a name="id3085082"></a><h3>
600
652
<a name="bonobo-property-bag-construct"></a>bonobo_property_bag_construct ()</h3>
601
 
<a class="indexterm" name="id2602376"></a><pre class="programlisting"><a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_construct       (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
602
 
                                                         GClosure *get_prop,
603
 
                                                         GClosure *set_prop,
 
653
<a class="indexterm" name="id3085095"></a><pre class="programlisting"><a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a>*  bonobo_property_bag_construct       (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
654
                                                         <a
 
655
href="../gobject/gobject-Closures.html#GClosure"
 
656
>GClosure</a> *get_prop,
 
657
                                                         <a
 
658
href="../gobject/gobject-Closures.html#GClosure"
 
659
>GClosure</a> *set_prop,
604
660
                                                         BonoboEventSource *es);</pre>
605
661
<p>
606
662
Constructor, only for use in wrappers and object derivation, please
607
 
refer to the <a href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new"><span class="type">bonobo_property_bag_new</span></a> for normal use.
 
663
refer to the <a class="link" href="libbonobo-bonobo-property-bag.html#bonobo-property-bag-new"><span class="type">bonobo_property_bag_new</span></a> for normal use.
608
664
</p>
609
665
<p>
610
 
This function returns <em class="parameter"><code>pb</code></em>, or <code class="literal">NULL</code> in case of error.  If it returns <code class="literal">NULL</code>,
 
666
This function returns <em class="parameter"><code>pb</code></em>, or <a
 
667
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
 
668
><code class="literal">NULL</code></a> in case of error.  If it returns <a
 
669
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
 
670
><code class="literal">NULL</code></a>,
611
671
the passed in <em class="parameter"><code>pb</code></em> is unrefed.</p>
612
672
<p>
613
673
 
616
676
<col align="left" valign="top">
617
677
<tbody>
618
678
<tr>
619
 
<td><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></td>
620
 
<td> <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> to construct
 
679
<td><p><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></p></td>
 
680
<td> <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> to construct
621
681
</td>
622
682
</tr>
623
683
<tr>
624
 
<td><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></td>
 
684
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></p></td>
625
685
<td> the property get closure
626
686
</td>
627
687
</tr>
628
688
<tr>
629
 
<td><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></td>
 
689
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></p></td>
630
690
<td> the property set closure
631
691
</td>
632
692
</tr>
633
693
<tr>
634
 
<td><span class="term"><em class="parameter"><code>es</code></em>&#160;:</span></td>
 
694
<td><p><span class="term"><em class="parameter"><code>es</code></em>&#160;:</span></p></td>
635
695
<td> an event source to aggregate
636
696
</td>
637
697
</tr>
638
698
<tr>
639
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
640
 
<td>  <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> pointer or <code class="literal">NULL</code>.
 
699
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
700
<td>  <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a> pointer or <a
 
701
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
 
702
><code class="literal">NULL</code></a>.
641
703
</td>
642
704
</tr>
643
705
</tbody>
645
707
</div>
646
708
<hr>
647
709
<div class="refsect2" lang="en">
648
 
<a name="id2602576"></a><h3>
 
710
<a name="id3085295"></a><h3>
649
711
<a name="bonobo-property-bag-add"></a>bonobo_property_bag_add ()</h3>
650
 
<a class="indexterm" name="id2602590"></a><pre class="programlisting">void                bonobo_property_bag_add             (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
712
<a class="indexterm" name="id3085309"></a><pre class="programlisting">void                bonobo_property_bag_add             (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
651
713
                                                         const char *name,
652
714
                                                         int idx,
653
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
654
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
 
715
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
 
716
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
655
717
                                                         const char *doctitle,
656
718
                                                         Bonobo_PropertyFlags flags);</pre>
657
719
<p>
663
725
<col align="left" valign="top">
664
726
<tbody>
665
727
<tr>
666
 
<td><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></td>
 
728
<td><p><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></p></td>
667
729
<td> property bag to add to
668
730
</td>
669
731
</tr>
670
732
<tr>
671
 
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
733
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
672
734
<td> name of new property
673
735
</td>
674
736
</tr>
675
737
<tr>
676
 
<td><span class="term"><em class="parameter"><code>idx</code></em>&#160;:</span></td>
 
738
<td><p><span class="term"><em class="parameter"><code>idx</code></em>&#160;:</span></p></td>
677
739
<td> integer index for fast callback switch statement
678
740
</td>
679
741
</tr>
680
742
<tr>
681
 
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
 
743
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
682
744
<td> the CORBA type eg. TC_long
683
745
</td>
684
746
</tr>
685
747
<tr>
686
 
<td><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
 
748
<td><p><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></p></td>
687
749
<td> the default value or NULL
688
750
</td>
689
751
</tr>
690
752
<tr>
691
 
<td><span class="term"><em class="parameter"><code>doctitle</code></em>&#160;:</span></td>
 
753
<td><p><span class="term"><em class="parameter"><code>doctitle</code></em>&#160;:</span></p></td>
692
754
<td> the translated documentation string
693
755
</td>
694
756
</tr>
695
757
<tr>
696
 
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
 
758
<td><p><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></p></td>
697
759
<td> various flags
698
760
</td>
699
761
</tr>
702
764
</div>
703
765
<hr>
704
766
<div class="refsect2" lang="en">
705
 
<a name="id2602773"></a><h3>
 
767
<a name="id3085492"></a><h3>
706
768
<a name="bonobo-property-bag-add-full"></a>bonobo_property_bag_add_full ()</h3>
707
 
<a class="indexterm" name="id2602787"></a><pre class="programlisting">void                bonobo_property_bag_add_full        (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
769
<a class="indexterm" name="id3085506"></a><pre class="programlisting">void                bonobo_property_bag_add_full        (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
708
770
                                                         const char *name,
709
771
                                                         int idx,
710
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
711
 
                                                         <a href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
 
772
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType">BonoboArgType</a> type,
 
773
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg">BonoboArg</a> *default_value,
712
774
                                                         const char *doctitle,
713
775
                                                         const char *docstring,
714
776
                                                         Bonobo_PropertyFlags flags,
715
 
                                                         GClosure *get_prop,
716
 
                                                         GClosure *set_prop);</pre>
 
777
                                                         <a
 
778
href="../gobject/gobject-Closures.html#GClosure"
 
779
>GClosure</a> *get_prop,
 
780
                                                         <a
 
781
href="../gobject/gobject-Closures.html#GClosure"
 
782
>GClosure</a> *set_prop);</pre>
717
783
<p>
718
784
This adds a property to <em class="parameter"><code>pb</code></em> at the full tilt of complexity.</p>
719
785
<p>
723
789
<col align="left" valign="top">
724
790
<tbody>
725
791
<tr>
726
 
<td><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></td>
 
792
<td><p><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></p></td>
727
793
<td> property bag to add to
728
794
</td>
729
795
</tr>
730
796
<tr>
731
 
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
797
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
732
798
<td> name of new property
733
799
</td>
734
800
</tr>
735
801
<tr>
736
 
<td><span class="term"><em class="parameter"><code>idx</code></em>&#160;:</span></td>
 
802
<td><p><span class="term"><em class="parameter"><code>idx</code></em>&#160;:</span></p></td>
737
803
<td> integer index for fast callback switch statement
738
804
</td>
739
805
</tr>
740
806
<tr>
741
 
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
 
807
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
742
808
<td> the CORBA type eg. TC_long
743
809
</td>
744
810
</tr>
745
811
<tr>
746
 
<td><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
 
812
<td><p><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></p></td>
747
813
<td> the default value or NULL
748
814
</td>
749
815
</tr>
750
816
<tr>
751
 
<td><span class="term"><em class="parameter"><code>doctitle</code></em>&#160;:</span></td>
 
817
<td><p><span class="term"><em class="parameter"><code>doctitle</code></em>&#160;:</span></p></td>
752
818
<td> the translated documentation title
753
819
</td>
754
820
</tr>
755
821
<tr>
756
 
<td><span class="term"><em class="parameter"><code>docstring</code></em>&#160;:</span></td>
 
822
<td><p><span class="term"><em class="parameter"><code>docstring</code></em>&#160;:</span></p></td>
757
823
<td> the translated documentation string
758
824
</td>
759
825
</tr>
760
826
<tr>
761
 
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
 
827
<td><p><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></p></td>
762
828
<td> various flags
763
829
</td>
764
830
</tr>
765
831
<tr>
766
 
<td><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></td>
 
832
<td><p><span class="term"><em class="parameter"><code>get_prop</code></em>&#160;:</span></p></td>
767
833
<td> a per property get callback
768
834
</td>
769
835
</tr>
770
836
<tr>
771
 
<td><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></td>
 
837
<td><p><span class="term"><em class="parameter"><code>set_prop</code></em>&#160;:</span></p></td>
772
838
<td> a per property set callback
773
839
</td>
774
840
</tr>
777
843
</div>
778
844
<hr>
779
845
<div class="refsect2" lang="en">
780
 
<a name="id2603043"></a><h3>
 
846
<a name="id3085762"></a><h3>
781
847
<a name="bonobo-property-bag-remove"></a>bonobo_property_bag_remove ()</h3>
782
 
<a class="indexterm" name="id2603056"></a><pre class="programlisting">void                bonobo_property_bag_remove          (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
848
<a class="indexterm" name="id3085776"></a><pre class="programlisting">void                bonobo_property_bag_remove          (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
783
849
                                                         const char *name);</pre>
784
850
<p>
785
851
removes the property with <em class="parameter"><code>name</code></em> from <em class="parameter"><code>b</code></em>.</p>
790
856
<col align="left" valign="top">
791
857
<tbody>
792
858
<tr>
793
 
<td><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></td>
 
859
<td><p><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></p></td>
794
860
<td> the property bag
795
861
</td>
796
862
</tr>
797
863
<tr>
798
 
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
864
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
799
865
<td> name of property to remove.
800
866
</td>
801
867
</tr>
804
870
</div>
805
871
<hr>
806
872
<div class="refsect2" lang="en">
807
 
<a name="id2603140"></a><h3>
 
873
<a name="id3085860"></a><h3>
808
874
<a name="bonobo-property-bag-map-params"></a>bonobo_property_bag_map_params ()</h3>
809
 
<a class="indexterm" name="id2603154"></a><pre class="programlisting">void                bonobo_property_bag_map_params      (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
810
 
                                                         GObject *on_instance,
811
 
                                                         const GParamSpec **pspecs,
812
 
                                                         guint n_params);</pre>
 
875
<a class="indexterm" name="id3085873"></a><pre class="programlisting">void                bonobo_property_bag_map_params      (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb,
 
876
                                                         <a
 
877
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
878
>GObject</a> *on_instance,
 
879
                                                         const <a
 
880
href="../gobject/gobject-GParamSpec.html#GParamSpec"
 
881
>GParamSpec</a> **pspecs,
 
882
                                                         <a
 
883
href="../glib/glib-Basic-Types.html#guint"
 
884
>guint</a> n_params);</pre>
813
885
<p>
814
886
 
815
887
</p>
817
889
<col align="left" valign="top">
818
890
<tbody>
819
891
<tr>
820
 
<td><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></td>
821
 
<td>
822
 
</td>
823
 
</tr>
824
 
<tr>
825
 
<td><span class="term"><em class="parameter"><code>on_instance</code></em>&#160;:</span></td>
826
 
<td>
827
 
</td>
828
 
</tr>
829
 
<tr>
830
 
<td><span class="term"><em class="parameter"><code>pspecs</code></em>&#160;:</span></td>
831
 
<td>
832
 
</td>
833
 
</tr>
834
 
<tr>
835
 
<td><span class="term"><em class="parameter"><code>n_params</code></em>&#160;:</span></td>
 
892
<td><p><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></p></td>
 
893
<td>
 
894
</td>
 
895
</tr>
 
896
<tr>
 
897
<td><p><span class="term"><em class="parameter"><code>on_instance</code></em>&#160;:</span></p></td>
 
898
<td>
 
899
</td>
 
900
</tr>
 
901
<tr>
 
902
<td><p><span class="term"><em class="parameter"><code>pspecs</code></em>&#160;:</span></p></td>
 
903
<td>
 
904
</td>
 
905
</tr>
 
906
<tr>
 
907
<td><p><span class="term"><em class="parameter"><code>n_params</code></em>&#160;:</span></p></td>
836
908
<td>
837
909
 
838
910
 
843
915
</div>
844
916
<hr>
845
917
<div class="refsect2" lang="en">
846
 
<a name="id2603265"></a><h3>
 
918
<a name="id3085984"></a><h3>
847
919
<a name="bonobo-property-bag-get-prop-list"></a>bonobo_property_bag_get_prop_list ()</h3>
848
 
<a class="indexterm" name="id2603279"></a><pre class="programlisting">GList*              bonobo_property_bag_get_prop_list   (<a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb);</pre>
 
920
<a class="indexterm" name="id3085998"></a><pre class="programlisting"><a
 
921
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
922
>GList</a>*              bonobo_property_bag_get_prop_list   (<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag">BonoboPropertyBag</a> *pb);</pre>
849
923
<p>
850
924
</p>
851
925
<p>
855
929
<col align="left" valign="top">
856
930
<tbody>
857
931
<tr>
858
 
<td><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></td>
859
 
<td> A <a href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a>.
 
932
<td><p><span class="term"><em class="parameter"><code>pb</code></em>&#160;:</span></p></td>
 
933
<td> A <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboPropertyBag"><span class="type">BonoboPropertyBag</span></a>.
860
934
</td>
861
935
</tr>
862
936
<tr>
863
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
864
 
<td>a <span class="type">GList</span> of <a href="libbonobo-bonobo-property-bag.html#BonoboProperty"><span class="type">BonoboProperty</span></a> structures.  This function is
 
937
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
938
<td>a <a
 
939
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
940
><span class="type">GList</span></a> of <a class="link" href="libbonobo-bonobo-property-bag.html#BonoboProperty"><span class="type">BonoboProperty</span></a> structures.  This function is
865
941
private and should only be used internally, or in a PropertyBag
866
942
persistence implementation.  You should not touch the
867
 
<a href="libbonobo-bonobo-property-bag.html#BonoboProperty"><span class="type">BonoboProperty</span></a> structure unless you know what you're doing.
 
943
<a class="link" href="libbonobo-bonobo-property-bag.html#BonoboProperty"><span class="type">BonoboProperty</span></a> structure unless you know what you're doing.
868
944
</td>
869
945
</tr>
870
946
</tbody>