← 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-arg.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-arg.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>bonobo-arg</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="property-bags.html" title="Property Bags, Events, Listeners">
9
9
<link rel="prev" href="libbonobo-bonobo-property-bag.html" title="BonoboPropertyBag">
81
81
<a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *         <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-new" title="bonobo_arg_new ()">bonobo_arg_new</a>                      (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> t);
82
82
<a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *         <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-new-from" title="bonobo_arg_new_from ()">bonobo_arg_new_from</a>                 (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> t,
83
83
                                                         <a
84
 
href="../glib/glib-Basic-Types.html#gconstpointer"
 
84
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"
85
85
>gconstpointer</a> data);
86
86
void                <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-release" title="bonobo_arg_release ()">bonobo_arg_release</a>                  (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *arg);
87
87
<a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *         <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-copy" title="bonobo_arg_copy ()">bonobo_arg_copy</a>                     (const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *arg);
88
88
void                <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-from-gvalue" title="bonobo_arg_from_gvalue ()">bonobo_arg_from_gvalue</a>              (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *a,
89
89
                                                         const <a
90
 
href="../gobject/gobject-Generic-values.html#GValue"
 
90
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
91
91
>GValue</a> *value);
92
92
<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a>       <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-type-from-gtype" title="bonobo_arg_type_from_gtype ()">bonobo_arg_type_from_gtype</a>          (<a
93
 
href="../gobject/gobject-Type-Information.html#GType"
 
93
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
94
94
>GType</a> t);
95
95
void                <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-to-gvalue" title="bonobo_arg_to_gvalue ()">bonobo_arg_to_gvalue</a>                (<a
96
 
href="../gobject/gobject-Generic-values.html#GValue"
 
96
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
97
97
>GValue</a> *value,
98
98
                                                         const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *arg);
99
99
<a
100
 
href="../gobject/gobject-Type-Information.html#GType"
 
100
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
101
101
>GType</a>               <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-type-to-gtype" title="bonobo_arg_type_to_gtype ()">bonobo_arg_type_to_gtype</a>            (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> id);
102
102
<a
103
 
href="../glib/glib-Basic-Types.html#gboolean"
 
103
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
104
104
>gboolean</a>            <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-is-equal" title="bonobo_arg_is_equal ()">bonobo_arg_is_equal</a>                 (const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *a,
105
105
                                                         const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *b,
106
106
                                                         CORBA_Environment *opt_ev);
107
107
<a
108
 
href="../glib/glib-Basic-Types.html#gboolean"
 
108
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
109
109
>gboolean</a>            <a class="link" href="libbonobo-bonobo-arg.html#bonobo-arg-type-is-equal" title="bonobo_arg_type_is_equal ()">bonobo_arg_type_is_equal</a>            (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> a,
110
110
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> b,
111
111
                                                         CORBA_Environment *opt_ev);
123
123
A typical use of the BonoboArg macros would be in
124
124
  </p>
125
125
<div class="example">
126
 
<a name="id2781980"></a><p class="title"><b>Example 14. Property bag implementation</b></p>
 
126
<a name="id3022248"></a><p class="title"><b>Example 14. Property bag implementation</b></p>
127
127
<div class="example-contents"><pre class="programlisting">
128
128
static void
129
129
get_prop (BonoboPropertyBag *bag,
748
748
<a name="bonobo-arg-new-from"></a><h3>bonobo_arg_new_from ()</h3>
749
749
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *         bonobo_arg_new_from                 (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> t,
750
750
                                                         <a
751
 
href="../glib/glib-Basic-Types.html#gconstpointer"
 
751
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"
752
752
>gconstpointer</a> data);</pre>
753
753
<p>
754
754
Create a new BonoboArg with the specified type and data</p>
821
821
<a name="bonobo-arg-from-gvalue"></a><h3>bonobo_arg_from_gvalue ()</h3>
822
822
<pre class="programlisting">void                bonobo_arg_from_gvalue              (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *a,
823
823
                                                         const <a
824
 
href="../gobject/gobject-Generic-values.html#GValue"
 
824
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
825
825
>GValue</a> *value);</pre>
826
826
<p>
827
827
This maps a GValue <em class="parameter"><code>value</code></em> to a BonoboArg <em class="parameter"><code>a</code></em>;
840
840
<tr>
841
841
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
842
842
<td> <a
843
 
href="../gobject/gobject-Generic-values.html#GValue"
 
843
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
844
844
><span class="type">GValue</span></a> to copy
845
845
</td>
846
846
</tr>
851
851
<div class="refsect2" lang="en">
852
852
<a name="bonobo-arg-type-from-gtype"></a><h3>bonobo_arg_type_from_gtype ()</h3>
853
853
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a>       bonobo_arg_type_from_gtype          (<a
854
 
href="../gobject/gobject-Type-Information.html#GType"
 
854
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
855
855
>GType</a> t);</pre>
856
856
<p>
857
857
</p>
875
875
<div class="refsect2" lang="en">
876
876
<a name="bonobo-arg-to-gvalue"></a><h3>bonobo_arg_to_gvalue ()</h3>
877
877
<pre class="programlisting">void                bonobo_arg_to_gvalue                (<a
878
 
href="../gobject/gobject-Generic-values.html#GValue"
 
878
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
879
879
>GValue</a> *value,
880
880
                                                         const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *arg);</pre>
881
881
<p>
889
889
<tr>
890
890
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
891
891
<td> pointer to a blank <a
892
 
href="../gobject/gobject-Generic-values.html#GValue"
 
892
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
893
893
><span class="type">GValue</span></a>
894
894
</td>
895
895
</tr>
905
905
<div class="refsect2" lang="en">
906
906
<a name="bonobo-arg-type-to-gtype"></a><h3>bonobo_arg_type_to_gtype ()</h3>
907
907
<pre class="programlisting"><a
908
 
href="../gobject/gobject-Type-Information.html#GType"
 
908
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
909
909
>GType</a>               bonobo_arg_type_to_gtype            (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> id);</pre>
910
910
<p>
911
911
This maps a BonoboArgType to a GType</p>
931
931
<div class="refsect2" lang="en">
932
932
<a name="bonobo-arg-is-equal"></a><h3>bonobo_arg_is_equal ()</h3>
933
933
<pre class="programlisting"><a
934
 
href="../glib/glib-Basic-Types.html#gboolean"
 
934
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
935
935
>gboolean</a>            bonobo_arg_is_equal                 (const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *a,
936
936
                                                         const <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg">BonoboArg</a> *b,
937
937
                                                         CORBA_Environment *opt_ev);</pre>
938
938
<p>
939
 
Compares two <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a>'s for equivalence; will return <code class="literal">TRUE</code>
 
939
Compares two <a class="link" href="libbonobo-bonobo-arg.html#BonoboArg" title="BonoboArg"><span class="type">BonoboArg</span></a>'s for equivalence; will return <a
 
940
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
941
><code class="literal">TRUE</code></a>
940
942
if equivalent for all simple cases. For Object references
941
943
CORBA sometimes denies 2 object references are equivalent
942
944
even if they are [ this is a feature_not_bug ].
960
962
</tr>
961
963
<tr>
962
964
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
963
 
<td> optional exception environment or <code class="literal">NULL</code>.
 
965
<td> optional exception environment or <a
 
966
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
967
><code class="literal">NULL</code></a>.
964
968
</td>
965
969
</tr>
966
970
<tr>
967
971
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
968
 
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>a</code></em> == <em class="parameter"><code>b</code></em>
 
972
<td> <a
 
973
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
974
><code class="literal">TRUE</code></a> if <em class="parameter"><code>a</code></em> == <em class="parameter"><code>b</code></em>
969
975
</td>
970
976
</tr>
971
977
</tbody>
975
981
<div class="refsect2" lang="en">
976
982
<a name="bonobo-arg-type-is-equal"></a><h3>bonobo_arg_type_is_equal ()</h3>
977
983
<pre class="programlisting"><a
978
 
href="../glib/glib-Basic-Types.html#gboolean"
 
984
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
979
985
>gboolean</a>            bonobo_arg_type_is_equal            (<a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> a,
980
986
                                                         <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType">BonoboArgType</a> b,
981
987
                                                         CORBA_Environment *opt_ev);</pre>
982
988
<p>
983
989
This compares two <a class="link" href="libbonobo-bonobo-arg.html#BonoboArgType" title="BonoboArgType"><span class="type">BonoboArgType</span></a>'s in <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em>.
984
990
The <em class="parameter"><code>opt_ev</code></em> is an optional <span class="type">CORBA_Environment</span> for
985
 
exceptions, or <code class="literal">NULL</code>. This function is commutative.</p>
 
991
exceptions, or <a
 
992
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
993
><code class="literal">NULL</code></a>. This function is commutative.</p>
986
994
<p>
987
995
</p>
988
996
<div class="variablelist"><table border="0">
1005
1013
</tr>
1006
1014
<tr>
1007
1015
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1008
 
<td> <code class="literal">TRUE</code> if equal, <code class="literal">FALSE</code> if different
 
1016
<td> <a
 
1017
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1018
><code class="literal">TRUE</code></a> if equal, <a
 
1019
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
 
1020
><code class="literal">FALSE</code></a> if different
1009
1021
</td>
1010
1022
</tr>
1011
1023
</tbody>