← Back to branch summary

~ubuntu-branches/ubuntu/saucy/libbonobo/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/api/html/libbonobo-bonobo-item-handler.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-30 13:59:10 UTC
  • mfrom: (1.1.27 upstream)
  • Revision ID: james.westby@ubuntu.com-20100330135910-bq8awt4jhdd71oq1
Tags: 2.24.3-0ubuntu1
* New upstream version:
  - Set up dbus environment in test-activation/test.sh 
  - Fix memory corruption 
  - Updated translations 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/html/libbonobo-bonobo-item-handler.html
8
8
<link rel="up" href="monikers.html" title="Monikers">
9
9
<link rel="prev" href="libbonobo-bonobo-moniker-extender.html" title="BonoboMonikerExtender">
10
10
<link rel="next" href="libbonobo-bonobo-item-container.html" title="BonoboItemContainer">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="general.html" title="General">
14
14
<link rel="chapter" href="factories.html" title="Objects, Factories, Reference Counting">
30
30
</tr>
31
31
<tr><td colspan="5" class="shortcuts">
32
32
<a href="#libbonobo-bonobo-item-handler.synopsis" class="shortcut">Top</a>
33
 
                 | 
34
 
                <a href="#libbonobo-bonobo-item-handler.description" class="shortcut">Description</a>
35
 
                 | 
36
 
                <a href="#libbonobo-bonobo-item-handler.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
33
                   | 
 
34
                  <a href="#libbonobo-bonobo-item-handler.description" class="shortcut">Description</a>
 
35
                   | 
 
36
                  <a href="#libbonobo-bonobo-item-handler.object-hierarchy" class="shortcut">Object Hierarchy</a>
37
37
</td></tr>
38
38
</table>
39
39
<div class="refentry" title="BonoboItemHandler">
47
47
</tr></table></div>
48
48
<div class="refsynopsisdiv" title="Synopsis">
49
49
<a name="libbonobo-bonobo-item-handler.synopsis"></a><h2>Synopsis</h2>
50
 
<a name="BonoboItemHandler"></a><pre class="synopsis">
51
 
                    <a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler-struct" title="BonoboItemHandler">BonoboItemHandler</a>;
 
50
<a name="BonoboItemHandler"></a><pre class="synopsis">                    <a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler-struct" title="BonoboItemHandler">BonoboItemHandler</a>;
52
51
                    <a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandlerClass" title="BonoboItemHandlerClass">BonoboItemHandlerClass</a>;
53
 
<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> * <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-handler-new" title="bonobo_item_handler_new ()">bonobo_item_handler_new</a>             (BonoboItemHandlerEnumObjectsFn enum_objects,
54
 
                                                         BonoboItemHandlerGetObjectFn get_object,
55
 
                                                         <a
56
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
57
 
>gpointer</a> user_data);
58
 
<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> * <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-handler-new-closure" title="bonobo_item_handler_new_closure ()">bonobo_item_handler_new_closure</a>     (<a
59
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
60
 
>GClosure</a> *enum_objects,
61
 
                                                         <a
62
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
63
 
>GClosure</a> *get_object);
64
 
<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> * <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-handler-construct" title="bonobo_item_handler_construct ()">bonobo_item_handler_construct</a>       (<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> *handler,
65
 
                                                         <a
66
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
67
 
>GClosure</a> *enum_objects,
68
 
                                                         <a
69
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
70
 
>GClosure</a> *get_object);
 
52
<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> * <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-handler-new" title="bonobo_item_handler_new ()">bonobo_item_handler_new</a>             (<span class="returnvalue">BonoboItemHandlerEnumObjectsFn</span> enum_objects,
 
53
                                                         <span class="returnvalue">BonoboItemHandlerGetObjectFn</span> get_object,
 
54
                                                         <span class="returnvalue">gpointer</span> user_data);
 
55
<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> * <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-handler-new-closure" title="bonobo_item_handler_new_closure ()">bonobo_item_handler_new_closure</a>     (<span class="returnvalue">GClosure</span> *enum_objects,
 
56
                                                         <span class="returnvalue">GClosure</span> *get_object);
 
57
<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> * <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-handler-construct" title="bonobo_item_handler_construct ()">bonobo_item_handler_construct</a>       (<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> *handler,
 
58
                                                         <span class="returnvalue">GClosure</span> *enum_objects,
 
59
                                                         <span class="returnvalue">GClosure</span> *get_object);
71
60
                    <a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemOption" title="BonoboItemOption">BonoboItemOption</a>;
72
 
<a
73
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
74
 
>GSList</a> *            <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-option-parse" title="bonobo_item_option_parse ()">bonobo_item_option_parse</a>            (const char *option_string);
75
 
void                <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-options-free" title="bonobo_item_options_free ()">bonobo_item_options_free</a>            (<a
76
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
77
 
>GSList</a> *options);
 
61
<span class="returnvalue">GSList</span> *            <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-option-parse" title="bonobo_item_option_parse ()">bonobo_item_option_parse</a>            (const <span class="returnvalue">char</span> *option_string);
 
62
<span class="returnvalue">void</span>                <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-options-free" title="bonobo_item_options_free ()">bonobo_item_options_free</a>            (<span class="returnvalue">GSList</span> *options);
78
63
</pre>
79
64
</div>
80
65
<div class="refsect1" title="Object Hierarchy">
81
66
<a name="libbonobo-bonobo-item-handler.object-hierarchy"></a><h2>Object Hierarchy</h2>
82
67
<pre class="synopsis">
83
 
  <a
84
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
85
 
>GObject</a>
 
68
  GObject
86
69
   +----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
87
70
         +----BonoboItemHandler
88
71
</pre>
101
84
<p><code class="literal">
102
85
    OAFIID:GNOME_FileSelector!AcceptMimeTypes=image/*</code></p>
103
86
<div class="refsect2" title="Implementing it">
104
 
<a name="id3038706"></a><h3>Implementing it</h3>
 
87
<a name="id2685861"></a><h3>Implementing it</h3>
105
88
<p>
106
89
        Create a BonoboItemHandler.  This component will
107
90
        let you do argument parsing of any kind.</p>
112
95
        mechanism is trying to resolve a set of arguments to your
113
96
        function.</p>
114
97
<p>Like this:</p>
115
 
<div class="informalexample"><pre class="programlisting">
116
 
Bonobo_Unknown
117
 
getObject (BonoboItemHandler *h, const char *item_name,
 
98
<div class="informalexample">
 
99
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
100
    <tbody>
 
101
      <tr>
 
102
        <td class="listing_lines" align="right"><pre>1
 
103
2
 
104
3
 
105
4
 
106
5
 
107
6
 
108
7
 
109
8
 
110
9
 
111
10
 
112
11
 
113
12</pre></td>
 
114
        <td class="listing_code"><pre class="programlisting">Bonobo_Unknown
 
115
getObject (BonoboItemHandler *h, <span class="type">const</span> <span class="type">char</span> *item_name,
118
116
           gboolean only_if_exists, gpointer data,
119
117
           CORBA_Environment *ev)
120
118
{
121
119
        MyData *m = data;
122
 
        if (strcmp (item_name, "friendly") == 0){
123
 
                m-&gt;friendly = true;
 
120
        <span class="keyword">if</span> (strcmp (item_name, <span class="number">&quot;friendly&quot;</span>) == <span class="number">0</span>){
 
121
                m-&gt;friendly = <span class="number">true</span>;
124
122
        }
125
 
        /* we just return ourselves */
126
 
        return bonobo_object_dup_ref (bonobo_object_corba_objref (h), NULL);
127
 
}
128
 
        </pre></div>
 
123
        <span class="comment">/*</span><span class="comment"> we just return ourselves </span><span class="comment">*/</span>
 
124
        <span class="keyword">return</span> bonobo_object_dup_ref (bonobo_object_corba_objref (h), <span class="number">NULL</span>);
 
125
}</pre></td>
 
126
      </tr>
 
127
    </tbody>
 
128
  </table>
 
129
</div>
 
130
 
129
131
<p>
130
132
        So basically during the `getObject' operation you will be
131
133
        given a chance to process the `item_name' string which is
136
138
</div>
137
139
<hr>
138
140
<div class="refsect2" title="Sample functions">
139
 
<a name="id3038767"></a><h3>Sample functions</h3>
 
141
<a name="id2685927"></a><h3>Sample functions</h3>
140
142
<p>
141
143
        Sometimes you will want to specify a bunch of options to
142
144
        configure your component, like this:
148
150
        functions that given the following string:</p>
149
151
<p><code class="literal">visible=true;image=blah.png</code></p>
150
152
<p>Will return a GList split with BonoboItemOptions:</p>
151
 
<div class="informalexample"><pre class="programlisting">
152
 
GSList *l, *x;
153
 
x = bonobo_item_option_parse ("visible=true;image=blah.png");
154
 
for (l = x; l != NULL; l++){
155
 
        BonoboItemOption *io = l-&gt;data;
156
 
        printf ("Key=%s, Value=%s\n", io-&gt;key, io-&gt;value);
 
153
<div class="informalexample">
 
154
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
155
    <tbody>
 
156
      <tr>
 
157
        <td class="listing_lines" align="right"><pre>1
 
158
2
 
159
3
 
160
4
 
161
5
 
162
6
 
163
7</pre></td>
 
164
        <td class="listing_code"><pre class="programlisting">GSList *l, *x;
 
165
x = bonobo_item_option_parse (<span class="number">&quot;visible=true;image=blah.png&quot;</span>);
 
166
<span class="keyword">for</span> (l = x; l != <span class="number">NULL</span>; l++){
 
167
        BonoboItemOption *io = l-&gt;data;
 
168
        printf (<span class="number">&quot;Key=</span><span class="symbol">%s</span><span class="number">, Value=</span><span class="symbol">%s</span><span class="symbol">\n</span><span class="number">&quot;</span>, io-&gt;key, io-&gt;value);
157
169
}
158
 
bonobo_item_option_free (x);
159
 
        </pre></div>
 
170
bonobo_item_option_free (x);</pre></td>
 
171
      </tr>
 
172
    </tbody>
 
173
  </table>
 
174
</div>
 
175
 
160
176
</div>
161
177
</div>
162
178
<div class="refsect1" title="Details">
184
200
<hr>
185
201
<div class="refsect2" title="bonobo_item_handler_new ()">
186
202
<a name="bonobo-item-handler-new"></a><h3>bonobo_item_handler_new ()</h3>
187
 
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> * bonobo_item_handler_new             (BonoboItemHandlerEnumObjectsFn enum_objects,
188
 
                                                         BonoboItemHandlerGetObjectFn get_object,
189
 
                                                         <a
190
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
191
 
>gpointer</a> user_data);</pre>
 
203
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> * bonobo_item_handler_new             (<span class="returnvalue">BonoboItemHandlerEnumObjectsFn</span> enum_objects,
 
204
                                                         <span class="returnvalue">BonoboItemHandlerGetObjectFn</span> get_object,
 
205
                                                         <span class="returnvalue">gpointer</span> user_data);</pre>
192
206
<p>
193
207
Creates a new BonoboItemHandler object.  These are used to hold
194
208
client sites.</p>
195
 
<p>
196
 
</p>
197
209
<div class="variablelist"><table border="0">
198
210
<col align="left" valign="top">
199
211
<tbody>
223
235
<hr>
224
236
<div class="refsect2" title="bonobo_item_handler_new_closure ()">
225
237
<a name="bonobo-item-handler-new-closure"></a><h3>bonobo_item_handler_new_closure ()</h3>
226
 
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> * bonobo_item_handler_new_closure     (<a
227
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
228
 
>GClosure</a> *enum_objects,
229
 
                                                         <a
230
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
231
 
>GClosure</a> *get_object);</pre>
 
238
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> * bonobo_item_handler_new_closure     (<span class="returnvalue">GClosure</span> *enum_objects,
 
239
                                                         <span class="returnvalue">GClosure</span> *get_object);</pre>
232
240
<p>
233
241
Creates a new BonoboItemHandler object.  These are used to hold
234
242
client sites.</p>
235
 
<p>
236
 
</p>
237
243
<div class="variablelist"><table border="0">
238
244
<col align="left" valign="top">
239
245
<tbody>
258
264
<hr>
259
265
<div class="refsect2" title="bonobo_item_handler_construct ()">
260
266
<a name="bonobo-item-handler-construct"></a><h3>bonobo_item_handler_construct ()</h3>
261
 
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> * bonobo_item_handler_construct       (<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler">BonoboItemHandler</a> *handler,
262
 
                                                         <a
263
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
264
 
>GClosure</a> *enum_objects,
265
 
                                                         <a
266
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"
267
 
>GClosure</a> *get_object);</pre>
 
267
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> * bonobo_item_handler_construct       (<a class="link" href="libbonobo-bonobo-item-handler.html#BonoboItemHandler"><span class="returnvalue">BonoboItemHandler</span></a> *handler,
 
268
                                                         <span class="returnvalue">GClosure</span> *enum_objects,
 
269
                                                         <span class="returnvalue">GClosure</span> *get_object);</pre>
268
270
<p>
269
271
Constructs the <em class="parameter"><code>container</code></em> BonoboObject using the provided closures
270
272
for the actual implementation.</p>
271
 
<p>
272
 
</p>
273
273
<div class="variablelist"><table border="0">
274
274
<col align="left" valign="top">
275
275
<tbody>
311
311
<hr>
312
312
<div class="refsect2" title="bonobo_item_option_parse ()">
313
313
<a name="bonobo-item-option-parse"></a><h3>bonobo_item_option_parse ()</h3>
314
 
<pre class="programlisting"><a
315
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
316
 
>GSList</a> *            bonobo_item_option_parse            (const char *option_string);</pre>
 
314
<pre class="programlisting"><span class="returnvalue">GSList</span> *            bonobo_item_option_parse            (const <span class="returnvalue">char</span> *option_string);</pre>
317
315
<p>
318
316
</p>
319
317
<div class="variablelist"><table border="0">
335
333
<hr>
336
334
<div class="refsect2" title="bonobo_item_options_free ()">
337
335
<a name="bonobo-item-options-free"></a><h3>bonobo_item_options_free ()</h3>
338
 
<pre class="programlisting">void                bonobo_item_options_free            (<a
339
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
340
 
>GSList</a> *options);</pre>
 
336
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_item_options_free            (<span class="returnvalue">GSList</span> *options);</pre>
341
337
<p>
342
338
Use this to release a list returned by <a class="link" href="libbonobo-bonobo-item-handler.html#bonobo-item-option-parse" title="bonobo_item_option_parse ()"><code class="function">bonobo_item_option_parse()</code></a></p>
343
 
<p>
344
 
</p>
345
339
<div class="variablelist"><table border="0">
346
340
<col align="left" valign="top">
347
341
<tbody><tr>
361
355
</div>
362
356
<div class="footer">
363
357
<hr>
364
 
          Generated by GTK-Doc V1.11</div>
 
358
          Generated by GTK-Doc V1.14</div>
365
359
</body>
366
 
</html>
 
360
</html>
 
 
b'\\ No newline at end of file'