~ubuntu-branches/ubuntu/gutsy/libbonoboui/gutsy

« back to all changes in this revision

Viewing changes to doc/api/html/libbonoboui-bonobo-widget.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-07-30 22:18:20 UTC
  • mfrom: (1.1.15 upstream)
  • Revision ID: james.westby@ubuntu.com-20070730221820-l8yw5gd2n2oy31f6
Tags: 2.19.6-0ubuntu1
* New upstream version:
  - Fix build with gtk+ >= 2.11.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
25
25
<th width="100%" align="center">LibBonoboUI API Reference Manual</th>
26
26
<td><a accesskey="n" href="libbonoboui-bonobo-window.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
27
</tr>
28
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2575712" class="shortcut">Top</a>
29
 
                  &#160;|&#160;
30
 
                  <a href="#id2576243" class="shortcut">Description</a>
31
 
                  &#160;|&#160;
32
 
                  <a href="#id2576150" class="shortcut">Object Hierarchy</a>
33
 
                  &#160;|&#160;
34
 
                  <a href="#id2576211" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2575631" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id2576162" class="shortcut">Description</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id2576068" class="shortcut">Object Hierarchy</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id2576130" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
35
35
</table>
36
36
<div class="refentry" lang="en">
37
37
<a name="libbonoboui-bonobo-widget"></a><div class="titlepage"></div>
38
38
<div class="refnamediv"><table width="100%"><tr>
39
39
<td valign="top">
40
40
<h2>
41
 
<a name="id2575712"></a><span class="refentrytitle">BonoboWidget</span>
 
41
<a name="id2575631"></a><span class="refentrytitle">BonoboWidget</span>
42
42
</h2>
43
43
<p>BonoboWidget &#8212; Simplified embedding of widgets in Bonobo.</p>
44
44
</td>
54
54
                    <a href="libbonoboui-bonobo-widget.html#BonoboWidgetPrivate">BonoboWidgetPrivate</a>;
55
55
                    <a href="libbonoboui-bonobo-widget.html#BonoboWidgetClass">BonoboWidgetClass</a>;
56
56
Bonobo_Unknown      <a href="libbonoboui-bonobo-widget.html#bonobo-widget-get-objref">bonobo_widget_get_objref</a>            (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);
57
 
<a
58
 
href="../gtk/GtkWidget.html"
59
 
>GtkWidget</a>*          <a href="libbonoboui-bonobo-widget.html#bonobo-widget-new-control">bonobo_widget_new_control</a>           (const char *moniker,
 
57
GtkWidget*          <a href="libbonoboui-bonobo-widget.html#bonobo-widget-new-control">bonobo_widget_new_control</a>           (const char *moniker,
60
58
                                                         Bonobo_UIContainer uic);
61
 
<a
62
 
href="../gtk/GtkWidget.html"
63
 
>GtkWidget</a>*          <a href="libbonoboui-bonobo-widget.html#bonobo-widget-new-control-from-objref">bonobo_widget_new_control_from_objref</a>
 
59
GtkWidget*          <a href="libbonoboui-bonobo-widget.html#bonobo-widget-new-control-from-objref">bonobo_widget_new_control_from_objref</a>
64
60
                                                        (Bonobo_Control control,
65
61
                                                         Bonobo_UIContainer uic);
66
62
<a href="libbonoboui-bonobo-control-frame.html#BonoboControlFrame">BonoboControlFrame</a>* <a href="libbonoboui-bonobo-widget.html#bonobo-widget-get-control-frame">bonobo_widget_get_control_frame</a>     (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);
67
63
Bonobo_UIContainer  <a href="libbonoboui-bonobo-widget.html#bonobo-widget-get-ui-container">bonobo_widget_get_ui_container</a>      (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);
68
64
void                (<a href="libbonoboui-bonobo-widget.html#BonoboWidgetAsyncFn">*BonoboWidgetAsyncFn</a>)              (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *widget,
69
65
                                                         CORBA_Environment *ev,
70
 
                                                         <a
71
 
href="../glib/glib-Basic-Types.html#gpointer"
72
 
>gpointer</a> user_data);
73
 
<a
74
 
href="../gtk/GtkWidget.html"
75
 
>GtkWidget</a>*          <a href="libbonoboui-bonobo-widget.html#bonobo-widget-new-control-async">bonobo_widget_new_control_async</a>     (const char *moniker,
 
66
                                                         gpointer user_data);
 
67
GtkWidget*          <a href="libbonoboui-bonobo-widget.html#bonobo-widget-new-control-async">bonobo_widget_new_control_async</a>     (const char *moniker,
76
68
                                                         Bonobo_UIContainer uic,
77
69
                                                         <a href="libbonoboui-bonobo-widget.html#BonoboWidgetAsyncFn">BonoboWidgetAsyncFn</a> fn,
78
 
                                                         <a
79
 
href="../glib/glib-Basic-Types.html#gpointer"
80
 
>gpointer</a> user_data);
 
70
                                                         gpointer user_data);
81
71
<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a>*       <a href="libbonoboui-bonobo-widget.html#bonobo-widget-construct-control-from-objref">bonobo_widget_construct_control_from_objref</a>
82
72
                                                        (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw,
83
73
                                                         Bonobo_Control control,
98
88
</pre>
99
89
</div>
100
90
<div class="refsect1" lang="en">
101
 
<a name="id2576150"></a><h2>Object Hierarchy</h2>
 
91
<a name="id2576068"></a><h2>Object Hierarchy</h2>
102
92
<pre class="synopsis">
103
93
 
104
 
  <a
105
 
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
106
 
>GObject</a>
107
 
   +----<a
108
 
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
109
 
>GInitiallyUnowned</a>
110
 
         +----<a
111
 
href="../gtk/GtkObject.html"
112
 
>GtkObject</a>
113
 
               +----<a
114
 
href="../gtk/GtkWidget.html"
115
 
>GtkWidget</a>
116
 
                     +----<a
117
 
href="../gtk/GtkContainer.html"
118
 
>GtkContainer</a>
119
 
                           +----<a
120
 
href="../gtk/GtkBin.html"
121
 
>GtkBin</a>
 
94
  GObject
 
95
   +----GInitiallyUnowned
 
96
         +----GtkObject
 
97
               +----GtkWidget
 
98
                     +----GtkContainer
 
99
                           +----GtkBin
122
100
                                 +----BonoboWidget
123
101
</pre>
124
102
</div>
125
103
<div class="refsect1" lang="en">
126
 
<a name="id2576211"></a><h2>Implemented Interfaces</h2>
 
104
<a name="id2576130"></a><h2>Implemented Interfaces</h2>
127
105
<p>
128
106
BonoboWidget implements
129
107
 AtkImplementorIface and  GtkBuildable.</p>
130
108
</div>
131
109
<div class="refsect1" lang="en">
132
 
<a name="id2576243"></a><h2>Description</h2>
 
110
<a name="id2576162"></a><h2>Description</h2>
133
111
<p>
134
112
  Bonobo component embedding for hydrocephalic imbeciles.
135
113
</p>
184
162
</p>
185
163
</div>
186
164
<div class="refsect1" lang="en">
187
 
<a name="id2576352"></a><h2>Details</h2>
 
165
<a name="id2576270"></a><h2>Details</h2>
188
166
<div class="refsect2" lang="en">
189
 
<a name="id2576362"></a><h3>
 
167
<a name="id2576281"></a><h3>
190
168
<a name="BonoboWidget-struct"></a>BonoboWidget</h3>
191
 
<a class="indexterm" name="id2576374"></a><pre class="programlisting">typedef struct _BonoboWidget BonoboWidget;</pre>
 
169
<a class="indexterm" name="id2576293"></a><pre class="programlisting">typedef struct _BonoboWidget BonoboWidget;</pre>
192
170
<p>
193
171
 
194
172
</p>
195
173
</div>
196
174
<hr>
197
175
<div class="refsect2" lang="en">
198
 
<a name="id2576390"></a><h3>
 
176
<a name="id2576308"></a><h3>
199
177
<a name="BonoboWidgetPrivate"></a>BonoboWidgetPrivate</h3>
200
 
<a class="indexterm" name="id2576402"></a><pre class="programlisting">typedef struct _BonoboWidgetPrivate BonoboWidgetPrivate;</pre>
 
178
<a class="indexterm" name="id2576321"></a><pre class="programlisting">typedef struct _BonoboWidgetPrivate BonoboWidgetPrivate;</pre>
201
179
<p>
202
180
 
203
181
</p>
204
182
</div>
205
183
<hr>
206
184
<div class="refsect2" lang="en">
207
 
<a name="id2576418"></a><h3>
 
185
<a name="id2576337"></a><h3>
208
186
<a name="BonoboWidgetClass"></a>BonoboWidgetClass</h3>
209
 
<a class="indexterm" name="id2576430"></a><pre class="programlisting">typedef struct {
 
187
<a class="indexterm" name="id2576349"></a><pre class="programlisting">typedef struct {
210
188
        GtkBinClass      bin_class;
211
189
 
212
190
        gpointer dummy[4];
218
196
</div>
219
197
<hr>
220
198
<div class="refsect2" lang="en">
221
 
<a name="id2576446"></a><h3>
 
199
<a name="id2576365"></a><h3>
222
200
<a name="bonobo-widget-get-objref"></a>bonobo_widget_get_objref ()</h3>
223
 
<a class="indexterm" name="id2576460"></a><pre class="programlisting">Bonobo_Unknown      bonobo_widget_get_objref            (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);</pre>
 
201
<a class="indexterm" name="id2576379"></a><pre class="programlisting">Bonobo_Unknown      bonobo_widget_get_objref            (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);</pre>
224
202
<p>
225
203
 
226
204
</p>
244
222
</div>
245
223
<hr>
246
224
<div class="refsect2" lang="en">
247
 
<a name="id2576516"></a><h3>
 
225
<a name="id2576435"></a><h3>
248
226
<a name="bonobo-widget-new-control"></a>bonobo_widget_new_control ()</h3>
249
 
<a class="indexterm" name="id2576530"></a><pre class="programlisting"><a
250
 
href="../gtk/GtkWidget.html"
251
 
>GtkWidget</a>*          bonobo_widget_new_control           (const char *moniker,
 
227
<a class="indexterm" name="id2576449"></a><pre class="programlisting">GtkWidget*          bonobo_widget_new_control           (const char *moniker,
252
228
                                                         Bonobo_UIContainer uic);</pre>
253
229
<p>
254
230
This function is a simple wrapper for easily embedding controls
273
249
</tr>
274
250
<tr>
275
251
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
276
 
<td> A <a
277
 
href="../gtk/GtkWidget.html"
278
 
><span class="type">GtkWidget</span></a> that is bound to the Bonobo Control. 
 
252
<td> A <span class="type">GtkWidget</span> that is bound to the Bonobo Control. 
279
253
</td>
280
254
</tr>
281
255
</tbody>
283
257
</div>
284
258
<hr>
285
259
<div class="refsect2" lang="en">
286
 
<a name="id2576630"></a><h3>
 
260
<a name="id2576549"></a><h3>
287
261
<a name="bonobo-widget-new-control-from-objref"></a>bonobo_widget_new_control_from_objref ()</h3>
288
 
<a class="indexterm" name="id2576645"></a><pre class="programlisting"><a
289
 
href="../gtk/GtkWidget.html"
290
 
>GtkWidget</a>*          bonobo_widget_new_control_from_objref
 
262
<a class="indexterm" name="id2576563"></a><pre class="programlisting">GtkWidget*          bonobo_widget_new_control_from_objref
291
263
                                                        (Bonobo_Control control,
292
264
                                                         Bonobo_UIContainer uic);</pre>
293
265
<p>
314
286
</tr>
315
287
<tr>
316
288
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
317
 
<td> the <em class="parameter"><code>control</code></em> wrapped as a <a
318
 
href="../gtk/GtkWidget.html"
319
 
><span class="type">GtkWidget</span></a>.
 
289
<td> the <em class="parameter"><code>control</code></em> wrapped as a <span class="type">GtkWidget</span>.
320
290
</td>
321
291
</tr>
322
292
</tbody>
324
294
</div>
325
295
<hr>
326
296
<div class="refsect2" lang="en">
327
 
<a name="id2576754"></a><h3>
 
297
<a name="id2576672"></a><h3>
328
298
<a name="bonobo-widget-get-control-frame"></a>bonobo_widget_get_control_frame ()</h3>
329
 
<a class="indexterm" name="id2576767"></a><pre class="programlisting"><a href="libbonoboui-bonobo-control-frame.html#BonoboControlFrame">BonoboControlFrame</a>* bonobo_widget_get_control_frame     (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);</pre>
 
299
<a class="indexterm" name="id2576686"></a><pre class="programlisting"><a href="libbonoboui-bonobo-control-frame.html#BonoboControlFrame">BonoboControlFrame</a>* bonobo_widget_get_control_frame     (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);</pre>
330
300
<p>
331
301
Every IDL:Bonobo/Control:1.0 needs to be placed inside an
332
302
IDL:Bonobo/ControlFrame:1.0.  This returns the BonoboControlFrame
352
322
</div>
353
323
<hr>
354
324
<div class="refsect2" lang="en">
355
 
<a name="id2576842"></a><h3>
 
325
<a name="id2576761"></a><h3>
356
326
<a name="bonobo-widget-get-ui-container"></a>bonobo_widget_get_ui_container ()</h3>
357
 
<a class="indexterm" name="id2576856"></a><pre class="programlisting">Bonobo_UIContainer  bonobo_widget_get_ui_container      (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);</pre>
 
327
<a class="indexterm" name="id2576774"></a><pre class="programlisting">Bonobo_UIContainer  bonobo_widget_get_ui_container      (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw);</pre>
358
328
<p>
359
329
</p>
360
330
<p>
379
349
</div>
380
350
<hr>
381
351
<div class="refsect2" lang="en">
382
 
<a name="id2576923"></a><h3>
 
352
<a name="id2576842"></a><h3>
383
353
<a name="BonoboWidgetAsyncFn"></a>BonoboWidgetAsyncFn ()</h3>
384
 
<a class="indexterm" name="id2576936"></a><pre class="programlisting">void                (*BonoboWidgetAsyncFn)              (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *widget,
 
354
<a class="indexterm" name="id2576855"></a><pre class="programlisting">void                (*BonoboWidgetAsyncFn)              (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *widget,
385
355
                                                         CORBA_Environment *ev,
386
 
                                                         <a
387
 
href="../glib/glib-Basic-Types.html#gpointer"
388
 
>gpointer</a> user_data);</pre>
 
356
                                                         gpointer user_data);</pre>
389
357
<p>
390
358
 
391
359
</p>
414
382
</div>
415
383
<hr>
416
384
<div class="refsect2" lang="en">
417
 
<a name="id2577025"></a><h3>
 
385
<a name="id2576944"></a><h3>
418
386
<a name="bonobo-widget-new-control-async"></a>bonobo_widget_new_control_async ()</h3>
419
 
<a class="indexterm" name="id2577038"></a><pre class="programlisting"><a
420
 
href="../gtk/GtkWidget.html"
421
 
>GtkWidget</a>*          bonobo_widget_new_control_async     (const char *moniker,
 
387
<a class="indexterm" name="id2576957"></a><pre class="programlisting">GtkWidget*          bonobo_widget_new_control_async     (const char *moniker,
422
388
                                                         Bonobo_UIContainer uic,
423
389
                                                         <a href="libbonoboui-bonobo-widget.html#BonoboWidgetAsyncFn">BonoboWidgetAsyncFn</a> fn,
424
 
                                                         <a
425
 
href="../glib/glib-Basic-Types.html#gpointer"
426
 
>gpointer</a> user_data);</pre>
 
390
                                                         gpointer user_data);</pre>
427
391
<p>
428
392
This method creates a widget, returns it to the user, and
429
393
asynchronously activates a control to insert into the widget.</p>
465
429
</div>
466
430
<hr>
467
431
<div class="refsect2" lang="en">
468
 
<a name="id2577171"></a><h3>
 
432
<a name="id2577090"></a><h3>
469
433
<a name="bonobo-widget-construct-control-from-objref"></a>bonobo_widget_construct_control_from_objref ()</h3>
470
 
<a class="indexterm" name="id2577186"></a><pre class="programlisting"><a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a>*       bonobo_widget_construct_control_from_objref
 
434
<a class="indexterm" name="id2577104"></a><pre class="programlisting"><a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a>*       bonobo_widget_construct_control_from_objref
471
435
                                                        (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw,
472
436
                                                         Bonobo_Control control,
473
437
                                                         Bonobo_UIContainer uic,
513
477
</div>
514
478
<hr>
515
479
<div class="refsect2" lang="en">
516
 
<a name="id2577341"></a><h3>
 
480
<a name="id2577259"></a><h3>
517
481
<a name="bonobo-widget-construct-control"></a>bonobo_widget_construct_control ()</h3>
518
 
<a class="indexterm" name="id2577354"></a><pre class="programlisting"><a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a>*       bonobo_widget_construct_control     (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw,
 
482
<a class="indexterm" name="id2577273"></a><pre class="programlisting"><a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a>*       bonobo_widget_construct_control     (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *bw,
519
483
                                                         const char *moniker,
520
484
                                                         Bonobo_UIContainer uic,
521
485
                                                         CORBA_Environment *ev);</pre>
526
490
</p>
527
491
<p>
528
492
This function will unref the passed in <em class="parameter"><code>bw</code></em> in case it cannot launch
529
 
the component and return <a
530
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
531
 
><code class="literal">NULL</code></a> in such a case.  Otherwise it returns
 
493
the component and return <code class="literal">NULL</code> in such a case.  Otherwise it returns
532
494
the <em class="parameter"><code>bw</code></em> itself.</p>
533
495
<p>
534
496
 
559
521
</tr>
560
522
<tr>
561
523
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
562
 
<td> A <a href="libbonoboui-bonobo-widget.html#BonoboWidget"><span class="type">BonoboWidget</span></a> or <a
563
 
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
564
 
><code class="literal">NULL</code></a>
 
524
<td> A <a href="libbonoboui-bonobo-widget.html#BonoboWidget"><span class="type">BonoboWidget</span></a> or <code class="literal">NULL</code>
565
525
</td>
566
526
</tr>
567
527
</tbody>
569
529
</div>
570
530
<hr>
571
531
<div class="refsect2" lang="en">
572
 
<a name="id2577540"></a><h3>
 
532
<a name="id2577459"></a><h3>
573
533
<a name="bonobo-widget-set-property"></a>bonobo_widget_set_property ()</h3>
574
 
<a class="indexterm" name="id2577554"></a><pre class="programlisting">void                bonobo_widget_set_property          (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *control,
 
534
<a class="indexterm" name="id2577473"></a><pre class="programlisting">void                bonobo_widget_set_property          (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *control,
575
535
                                                         const char *first_prop,
576
536
                                                         ...);</pre>
577
537
<p>
619
579
</div>
620
580
<hr>
621
581
<div class="refsect2" lang="en">
622
 
<a name="id2577704"></a><h3>
 
582
<a name="id2577622"></a><h3>
623
583
<a name="bonobo-widget-get-property"></a>bonobo_widget_get_property ()</h3>
624
 
<a class="indexterm" name="id2577718"></a><pre class="programlisting">void                bonobo_widget_get_property          (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *control,
 
584
<a class="indexterm" name="id2577636"></a><pre class="programlisting">void                bonobo_widget_get_property          (<a href="libbonoboui-bonobo-widget.html#BonoboWidget">BonoboWidget</a> *control,
625
585
                                                         const char *first_prop,
626
586
                                                         ...);</pre>
627
587
<p>
669
629
</div>
670
630
<hr>
671
631
<div class="refsect2" lang="en">
672
 
<a name="id2577867"></a><h3>
 
632
<a name="id2577786"></a><h3>
673
633
<a name="bonobo-widget-get-uih"></a>bonobo_widget_get_uih()</h3>
674
 
<a class="indexterm" name="id2577880"></a><pre class="programlisting">#define bonobo_widget_get_uih(w) bonobo_widget_get_ui_container (w)
 
634
<a class="indexterm" name="id2577799"></a><pre class="programlisting">#define bonobo_widget_get_uih(w) bonobo_widget_get_ui_container (w)
675
635
</pre>
676
636
<p>
677
637
 
696
656
</div>
697
657
</div>
698
658
<div class="refsect1" lang="en">
699
 
<a name="id2577925"></a><h2>See Also</h2>
 
659
<a name="id2577844"></a><h2>See Also</h2>
700
660
<p>
701
661
   Object activation happens with <a
702
662
href="../libbonobo/libbonobo-bonobo-moniker-util.html#bonobo-get-object"