← Back to branch summary

~ubuntu-branches/ubuntu/quantal/libbonobo/quantal-201207170711

« back to all changes in this revision

Viewing changes to doc/api/html/libbonobo-bonobo-object.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-03-06 18:53:16 UTC
  • mfrom: (1.1.25 upstream) (3.1.3 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090306185316-uf09r30g7cvf67xi
Tags: 2.24.1-1
* New upstream bugfix release.
* debian/control.in:
  + Build depend on GLib >= 2.14.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/html/libbonobo-bonobo-object.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>BonoboObject</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.2">
7
7
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
8
8
<link rel="up" href="factories.html" title="Objects, Factories, Reference Counting">
9
9
<link rel="prev" href="factories.html" title="Objects, Factories, Reference Counting">
75
75
Bonobo_Unknown      <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-release-unref" title="bonobo_object_release_unref ()">bonobo_object_release_unref</a>         (Bonobo_Unknown object,
76
76
                                                         CORBA_Environment *opt_ev);
77
77
<a
78
 
href="../glib/glib-Basic-Types.html#gpointer"
 
78
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
79
79
>gpointer</a>            <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-ref" title="bonobo_object_ref ()">bonobo_object_ref</a>                   (<a
80
 
href="../glib/glib-Basic-Types.html#gpointer"
 
80
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
81
81
>gpointer</a> obj);
82
82
void                <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-idle-unref" title="bonobo_object_idle_unref ()">bonobo_object_idle_unref</a>            (<a
83
 
href="../glib/glib-Basic-Types.html#gpointer"
 
83
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
84
84
>gpointer</a> obj);
85
85
<a
86
 
href="../glib/glib-Basic-Types.html#gpointer"
 
86
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
87
87
>gpointer</a>            <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-unref" title="bonobo_object_unref ()">bonobo_object_unref</a>                 (<a
88
 
href="../glib/glib-Basic-Types.html#gpointer"
 
88
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
89
89
>gpointer</a> obj);
90
90
void                <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-set-immortal" title="bonobo_object_set_immortal ()">bonobo_object_set_immortal</a>          (<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
91
91
                                                         <a
92
 
href="../glib/glib-Basic-Types.html#gboolean"
 
92
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
93
93
>gboolean</a> immortal);
94
94
<a
95
 
href="../glib/glib-Basic-Types.html#gpointer"
 
95
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
96
96
>gpointer</a>            <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-trace-refs" title="bonobo_object_trace_refs ()">bonobo_object_trace_refs</a>            (<a
97
 
href="../glib/glib-Basic-Types.html#gpointer"
 
97
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
98
98
>gpointer</a> obj,
99
99
                                                         const char *fn,
100
100
                                                         int line,
101
101
                                                         <a
102
 
href="../glib/glib-Basic-Types.html#gboolean"
 
102
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
103
103
>gboolean</a> ref);
104
104
void                <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-dump-interfaces" title="bonobo_object_dump_interfaces ()">bonobo_object_dump_interfaces</a>       (<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);
105
105
void                <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-check-env" title="bonobo_object_check_env ()">bonobo_object_check_env</a>             (<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
107
107
                                                         CORBA_Environment *ev);
108
108
#define             <a class="link" href="libbonobo-bonobo-object.html#BONOBO-OBJECT-CHECK--CAPS" title="BONOBO_OBJECT_CHECK()">BONOBO_OBJECT_CHECK</a>                 (o,c,e)
109
109
<a
110
 
href="../glib/glib-Basic-Types.html#gboolean"
 
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
111
111
>gboolean</a>            <a class="link" href="libbonobo-bonobo-object.html#bonobo-unknown-ping" title="bonobo_unknown_ping ()">bonobo_unknown_ping</a>                 (Bonobo_Unknown object,
112
112
                                                         CORBA_Environment *opt_ev);
113
113
void                <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-list-unref-all" title="bonobo_object_list_unref_all ()">bonobo_object_list_unref_all</a>        (<a
114
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
114
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
115
115
>GList</a> **list);
116
116
void                <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-slist-unref-all" title="bonobo_object_slist_unref_all ()">bonobo_object_slist_unref_all</a>       (<a
117
 
href="../glib/glib-Singly-Linked-Lists.html#GSList"
 
117
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
118
118
>GSList</a> **list);
119
119
<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *      <a class="link" href="libbonobo-bonobo-object.html#bonobo-object" title="bonobo_object ()">bonobo_object</a>                       (<a
120
 
href="../glib/glib-Basic-Types.html#gpointer"
 
120
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
121
121
>gpointer</a> p);
122
122
#define             <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-fast" title="bonobo_object_fast()">bonobo_object_fast</a>                  (o)
123
123
#define             <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-from-servant" title="bonobo_object_from_servant()">bonobo_object_from_servant</a>          (s)
124
124
#define             <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-get-servant" title="bonobo_object_get_servant()">bonobo_object_get_servant</a>           (o)
125
125
PortableServer_POA  <a class="link" href="libbonobo-bonobo-object.html#bonobo-object-get-poa" title="bonobo_object_get_poa ()">bonobo_object_get_poa</a>               (<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object);
126
126
<a
127
 
href="../gobject/gobject-Type-Information.html#GType"
 
127
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
128
128
>GType</a>               <a class="link" href="libbonobo-bonobo-object.html#bonobo-type-unique" title="bonobo_type_unique ()">bonobo_type_unique</a>                  (<a
129
 
href="../gobject/gobject-Type-Information.html#GType"
 
129
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
130
130
>GType</a> parent_type,
131
131
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> init_fn,
132
132
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> fini_fn,
133
133
                                                         int epv_struct_offset,
134
134
                                                         const <a
135
 
href="../gobject/gobject-Type-Information.html#GTypeInfo"
 
135
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInfo"
136
136
>GTypeInfo</a> *info,
137
137
                                                         const <a
138
 
href="../glib/glib-Basic-Types.html#gchar"
 
138
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
139
139
>gchar</a> *type_name);
140
140
<a
141
 
href="../glib/glib-Basic-Types.html#gboolean"
 
141
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
142
142
>gboolean</a>            <a class="link" href="libbonobo-bonobo-object.html#bonobo-type-setup" title="bonobo_type_setup ()">bonobo_type_setup</a>                   (<a
143
 
href="../gobject/gobject-Type-Information.html#GType"
 
143
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
144
144
>GType</a> type,
145
145
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> init_fn,
146
146
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> fini_fn,
153
153
<a name="libbonobo-bonobo-object.object-hierarchy"></a><h2>Object Hierarchy</h2>
154
154
<pre class="synopsis">
155
155
  <a
156
 
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
156
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
157
157
>GObject</a>
158
158
   +----BonoboObject
159
159
         +----BonoboGenericFactory
170
170
<a name="libbonobo-bonobo-object.properties"></a><h2>Properties</h2>
171
171
<pre class="synopsis">
172
172
  "<a class="link" href="libbonobo-bonobo-object.html#BonoboObject--poa" title='The "poa" property'>poa</a>"                      <a
173
 
href="../glib/glib-Basic-Types.html#gpointer"
 
173
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
174
174
>gpointer</a>              : Read / Write / Construct Only
175
175
</pre>
176
176
</div>
308
308
<pre class="programlisting">#define BONOBO_OBJECT_TYPE        BONOBO_TYPE_OBJECT /* deprecated, you should use BONOBO_TYPE_OBJECT */
309
309
</pre>
310
310
<p>
311
 
Returns the <a
312
 
href="../gtk/gtk-Types.html#GtkType"
313
 
><span class="type">GtkType</span></a> for the BonoboObject object.
 
311
Returns the <span class="type">GtkType</span> for the BonoboObject object.
314
312
</p>
315
313
</div>
316
314
<hr>
617
615
<div class="refsect2" lang="en">
618
616
<a name="bonobo-object-ref"></a><h3>bonobo_object_ref ()</h3>
619
617
<pre class="programlisting"><a
620
 
href="../glib/glib-Basic-Types.html#gpointer"
 
618
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
621
619
>gpointer</a>            bonobo_object_ref                   (<a
622
 
href="../glib/glib-Basic-Types.html#gpointer"
 
620
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
623
621
>gpointer</a> obj);</pre>
624
622
<p>
625
623
Increments the reference count for the aggregate BonoboObject.</p>
645
643
<div class="refsect2" lang="en">
646
644
<a name="bonobo-object-idle-unref"></a><h3>bonobo_object_idle_unref ()</h3>
647
645
<pre class="programlisting">void                bonobo_object_idle_unref            (<a
648
 
href="../glib/glib-Basic-Types.html#gpointer"
 
646
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
649
647
>gpointer</a> obj);</pre>
650
648
<p>
651
649
</p>
662
660
<div class="refsect2" lang="en">
663
661
<a name="bonobo-object-unref"></a><h3>bonobo_object_unref ()</h3>
664
662
<pre class="programlisting"><a
665
 
href="../glib/glib-Basic-Types.html#gpointer"
 
663
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
666
664
>gpointer</a>            bonobo_object_unref                 (<a
667
 
href="../glib/glib-Basic-Types.html#gpointer"
 
665
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
668
666
>gpointer</a> obj);</pre>
669
667
<p>
670
668
Decrements the reference count for the aggregate BonoboObject.</p>
680
678
</tr>
681
679
<tr>
682
680
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
683
 
<td> <code class="literal">NULL</code>.
 
681
<td> <a
 
682
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
683
><code class="literal">NULL</code></a>.
684
684
</td>
685
685
</tr>
686
686
</tbody>
691
691
<a name="bonobo-object-set-immortal"></a><h3>bonobo_object_set_immortal ()</h3>
692
692
<pre class="programlisting">void                bonobo_object_set_immortal          (<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *object,
693
693
                                                         <a
694
 
href="../glib/glib-Basic-Types.html#gboolean"
 
694
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
695
695
>gboolean</a> immortal);</pre>
696
696
<p>
697
697
</p>
715
715
<div class="refsect2" lang="en">
716
716
<a name="bonobo-object-trace-refs"></a><h3>bonobo_object_trace_refs ()</h3>
717
717
<pre class="programlisting"><a
718
 
href="../glib/glib-Basic-Types.html#gpointer"
 
718
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
719
719
>gpointer</a>            bonobo_object_trace_refs            (<a
720
 
href="../glib/glib-Basic-Types.html#gpointer"
 
720
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
721
721
>gpointer</a> obj,
722
722
                                                         const char *fn,
723
723
                                                         int line,
724
724
                                                         <a
725
 
href="../glib/glib-Basic-Types.html#gboolean"
 
725
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
726
726
>gboolean</a> ref);</pre>
727
727
<p>
728
728
</p>
842
842
<div class="refsect2" lang="en">
843
843
<a name="bonobo-unknown-ping"></a><h3>bonobo_unknown_ping ()</h3>
844
844
<pre class="programlisting"><a
845
 
href="../glib/glib-Basic-Types.html#gboolean"
 
845
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
846
846
>gboolean</a>            bonobo_unknown_ping                 (Bonobo_Unknown object,
847
847
                                                         CORBA_Environment *opt_ev);</pre>
848
848
<p>
865
865
</tr>
866
866
<tr>
867
867
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
868
 
<td> <code class="literal">TRUE</code> if the Bonobo::Unknown <em class="parameter"><code>object</code></em> is alive.
 
868
<td> <a
 
869
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
870
><code class="literal">TRUE</code></a> if the Bonobo::Unknown <em class="parameter"><code>object</code></em> is alive.
869
871
</td>
870
872
</tr>
871
873
</tbody>
875
877
<div class="refsect2" lang="en">
876
878
<a name="bonobo-object-list-unref-all"></a><h3>bonobo_object_list_unref_all ()</h3>
877
879
<pre class="programlisting">void                bonobo_object_list_unref_all        (<a
878
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
880
href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
879
881
>GList</a> **list);</pre>
880
882
<p>
881
883
This routine unrefs all valid objects in
896
898
<div class="refsect2" lang="en">
897
899
<a name="bonobo-object-slist-unref-all"></a><h3>bonobo_object_slist_unref_all ()</h3>
898
900
<pre class="programlisting">void                bonobo_object_slist_unref_all       (<a
899
 
href="../glib/glib-Singly-Linked-Lists.html#GSList"
 
901
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
900
902
>GSList</a> **list);</pre>
901
903
<p>
902
904
</p>
913
915
<div class="refsect2" lang="en">
914
916
<a name="bonobo-object"></a><h3>bonobo_object ()</h3>
915
917
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *      bonobo_object                       (<a
916
 
href="../glib/glib-Basic-Types.html#gpointer"
 
918
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
917
919
>gpointer</a> p);</pre>
918
920
<p>
919
921
This function can be passed a BonoboObject * or a
1027
1029
<div class="refsect2" lang="en">
1028
1030
<a name="bonobo-type-unique"></a><h3>bonobo_type_unique ()</h3>
1029
1031
<pre class="programlisting"><a
1030
 
href="../gobject/gobject-Type-Information.html#GType"
 
1032
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
1031
1033
>GType</a>               bonobo_type_unique                  (<a
1032
 
href="../gobject/gobject-Type-Information.html#GType"
 
1034
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
1033
1035
>GType</a> parent_type,
1034
1036
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> init_fn,
1035
1037
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> fini_fn,
1036
1038
                                                         int epv_struct_offset,
1037
1039
                                                         const <a
1038
 
href="../gobject/gobject-Type-Information.html#GTypeInfo"
 
1040
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInfo"
1039
1041
>GTypeInfo</a> *info,
1040
1042
                                                         const <a
1041
 
href="../glib/glib-Basic-Types.html#gchar"
 
1043
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1042
1044
>gchar</a> *type_name);</pre>
1043
1045
<p>
1044
1046
This function is the main entry point for deriving bonobo
1092
1094
<div class="refsect2" lang="en">
1093
1095
<a name="bonobo-type-setup"></a><h3>bonobo_type_setup ()</h3>
1094
1096
<pre class="programlisting"><a
1095
 
href="../glib/glib-Basic-Types.html#gboolean"
 
1097
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1096
1098
>gboolean</a>            bonobo_type_setup                   (<a
1097
 
href="../gobject/gobject-Type-Information.html#GType"
 
1099
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
1098
1100
>GType</a> type,
1099
1101
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> init_fn,
1100
1102
                                                         <a class="link" href="libbonobo-bonobo-object.html#BonoboObjectPOAFn" title="BonoboObjectPOAFn ()">BonoboObjectPOAFn</a> fini_fn,
1207
1209
<div class="refsect2" lang="en">
1208
1210
<a name="BonoboObject--poa"></a><h3>The <code class="literal">"poa"</code> property</h3>
1209
1211
<pre class="programlisting">  "poa"                      <a
1210
 
href="../glib/glib-Basic-Types.html#gpointer"
 
1212
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1211
1213
>gpointer</a>              : Read / Write / Construct Only</pre>
1212
1214
<p>
1213
1215
    Pass this property during construction to specify a custom POA for a BonoboObject. Example:
1231
1233
<a name="BonoboObject-destroy"></a><h3>The <code class="literal">"destroy"</code> signal</h3>
1232
1234
<pre class="programlisting">void                user_function                      (<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> *bonoboobject,
1233
1235
                                                        <a
1234
 
href="../glib/glib-Basic-Types.html#gpointer"
 
1236
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1235
1237
>gpointer</a>      user_data)         : Run Last</pre>
1236
1238
<p>
1237
1239
    Signal emitted when the last reference of a BonoboObject has been
1259
1261
                                                        CorbaObject          *arg1,
1260
1262
                                                        BonoboCorbaException *arg2,
1261
1263
                                                        <a
1262
 
href="../glib/glib-Basic-Types.html#gpointer"
 
1264
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1263
1265
>gpointer</a>              user_data)         : Run Last</pre>
1264
1266
<p>
1265
1267
    Signal emitted from bonobo_object_check_env if a system exception is identified.
1294
1296
<a name="libbonobo-bonobo-object.see-also"></a><h2>See Also</h2>
1295
1297
<p>
1296
1298
<a
1297
 
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
1299
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
1298
1300
><span class="type">GObject</span></a>
1299
1301
</p>
1300
1302
</div>