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

« back to all changes in this revision

Viewing changes to doc/api/xml/bonobo-moniker.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-03-12 15:39:17 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20070312153917-u4efw149urh2enej
Tags: 2.18.0-0ubuntu1
* New upstream release:
  - Code cleanups
  - Build fix
  - Updated translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
18
18
 
19
19
 
20
20
 
21
 
            <link linkend="BonoboMoniker-struct">BonoboMoniker</link>;
22
 
            <link linkend="BonoboMonikerClass">BonoboMonikerClass</link>;
23
 
<link linkend="BonoboMoniker">BonoboMoniker</link>* <link linkend="bonobo-moniker-construct">bonobo_moniker_construct</link>     (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
24
 
                                             const <link linkend="char">char</link> *prefix);
25
 
<link linkend="Bonobo-Moniker">Bonobo_Moniker</link> <link linkend="bonobo-moniker-get-parent">bonobo_moniker_get_parent</link>    (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
26
 
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);
27
 
<link linkend="void">void</link>        <link linkend="bonobo-moniker-set-parent">bonobo_moniker_set_parent</link>       (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
28
 
                                             <link linkend="Bonobo-Moniker">Bonobo_Moniker</link> parent,
29
 
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);
30
 
const <link linkend="char">char</link>* <link linkend="bonobo-moniker-get-name">bonobo_moniker_get_name</link>         (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
31
 
const <link linkend="char">char</link>* <link linkend="bonobo-moniker-get-name-full">bonobo_moniker_get_name_full</link>    (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
32
 
<link linkend="char">char</link>*       <link linkend="bonobo-moniker-get-name-escaped">bonobo_moniker_get_name_escaped</link> (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
33
 
<link linkend="void">void</link>        <link linkend="bonobo-moniker-set-name">bonobo_moniker_set_name</link>         (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
34
 
                                             const <link linkend="char">char</link> *name);
35
 
const <link linkend="char">char</link>* <link linkend="bonobo-moniker-get-prefix">bonobo_moniker_get_prefix</link>       (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
36
 
<link linkend="void">void</link>        <link linkend="bonobo-moniker-set-case-sensitive">bonobo_moniker_set_case_sensitive</link>
37
 
                                            (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
38
 
                                             <link linkend="gboolean">gboolean</link> sensitive);
39
 
<link linkend="gboolean">gboolean</link>    <link linkend="bonobo-moniker-get-case-sensitive">bonobo_moniker_get_case_sensitive</link>
40
 
                                            (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
 
21
                    <link linkend="BonoboMoniker-struct">BonoboMoniker</link>;
 
22
                    <link linkend="BonoboMonikerClass">BonoboMonikerClass</link>;
 
23
<link linkend="BonoboMoniker">BonoboMoniker</link>*      <link linkend="bonobo-moniker-construct">bonobo_moniker_construct</link>            (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
24
                                                         const <link linkend="char">char</link> *prefix);
 
25
<link linkend="Bonobo-Moniker">Bonobo_Moniker</link>      <link linkend="bonobo-moniker-get-parent">bonobo_moniker_get_parent</link>           (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
26
                                                         <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);
 
27
<link linkend="void">void</link>                <link linkend="bonobo-moniker-set-parent">bonobo_moniker_set_parent</link>           (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
28
                                                         <link linkend="Bonobo-Moniker">Bonobo_Moniker</link> parent,
 
29
                                                         <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);
 
30
const <link linkend="char">char</link>*         <link linkend="bonobo-moniker-get-name">bonobo_moniker_get_name</link>             (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
 
31
const <link linkend="char">char</link>*         <link linkend="bonobo-moniker-get-name-full">bonobo_moniker_get_name_full</link>        (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
 
32
<link linkend="char">char</link>*               <link linkend="bonobo-moniker-get-name-escaped">bonobo_moniker_get_name_escaped</link>     (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
 
33
<link linkend="void">void</link>                <link linkend="bonobo-moniker-set-name">bonobo_moniker_set_name</link>             (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
34
                                                         const <link linkend="char">char</link> *name);
 
35
const <link linkend="char">char</link>*         <link linkend="bonobo-moniker-get-prefix">bonobo_moniker_get_prefix</link>           (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
 
36
<link linkend="void">void</link>                <link linkend="bonobo-moniker-set-case-sensitive">bonobo_moniker_set_case_sensitive</link>   (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
37
                                                         <link linkend="gboolean">gboolean</link> sensitive);
 
38
<link linkend="gboolean">gboolean</link>            <link linkend="bonobo-moniker-get-case-sensitive">bonobo_moniker_get_case_sensitive</link>   (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);
41
39
 
42
40
 
43
41
</synopsis>
118
116
</para></refsect2>
119
117
<refsect2>
120
118
<title><anchor id="bonobo-moniker-construct" role="function"/>bonobo_moniker_construct ()</title>
121
 
<indexterm><primary>bonobo_moniker_construct</primary></indexterm><programlisting><link linkend="BonoboMoniker">BonoboMoniker</link>* bonobo_moniker_construct     (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
122
 
                                             const <link linkend="char">char</link> *prefix);</programlisting>
 
119
<indexterm><primary>bonobo_moniker_construct</primary></indexterm><programlisting><link linkend="BonoboMoniker">BonoboMoniker</link>*      bonobo_moniker_construct            (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
120
                                                         const <link linkend="char">char</link> *prefix);</programlisting>
123
121
<para>
124
122
Constructs a newly created bonobo moniker with the given arguments.</para>
125
123
<para>
136
134
</variablelist></refsect2>
137
135
<refsect2>
138
136
<title><anchor id="bonobo-moniker-get-parent" role="function"/>bonobo_moniker_get_parent ()</title>
139
 
<indexterm><primary>bonobo_moniker_get_parent</primary></indexterm><programlisting><link linkend="Bonobo-Moniker">Bonobo_Moniker</link> bonobo_moniker_get_parent    (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
140
 
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);</programlisting>
 
137
<indexterm><primary>bonobo_moniker_get_parent</primary></indexterm><programlisting><link linkend="Bonobo-Moniker">Bonobo_Moniker</link>      bonobo_moniker_get_parent           (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
138
                                                         <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);</programlisting>
141
139
<para>
142
140
See bonobo_moniker_set_parent;</para>
143
141
<para>
154
152
</variablelist></refsect2>
155
153
<refsect2>
156
154
<title><anchor id="bonobo-moniker-set-parent" role="function"/>bonobo_moniker_set_parent ()</title>
157
 
<indexterm><primary>bonobo_moniker_set_parent</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_moniker_set_parent       (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
158
 
                                             <link linkend="Bonobo-Moniker">Bonobo_Moniker</link> parent,
159
 
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);</programlisting>
 
155
<indexterm><primary>bonobo_moniker_set_parent</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_moniker_set_parent           (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
156
                                                         <link linkend="Bonobo-Moniker">Bonobo_Moniker</link> parent,
 
157
                                                         <link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);</programlisting>
160
158
<para>
161
159
This sets the monikers parent; a moniker is really a long chain
162
160
of hierarchical monikers; referenced by the most local moniker.
176
174
</variablelist></refsect2>
177
175
<refsect2>
178
176
<title><anchor id="bonobo-moniker-get-name" role="function"/>bonobo_moniker_get_name ()</title>
179
 
<indexterm><primary>bonobo_moniker_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* bonobo_moniker_get_name         (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
 
177
<indexterm><primary>bonobo_moniker_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>*         bonobo_moniker_get_name             (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
180
178
<para>
181
179
gets the unescaped name of the moniker less the prefix eg
182
180
file:/tmp/hash\#.gz returns /tmp/hash#.gz</para>
191
189
</variablelist></refsect2>
192
190
<refsect2>
193
191
<title><anchor id="bonobo-moniker-get-name-full" role="function"/>bonobo_moniker_get_name_full ()</title>
194
 
<indexterm><primary>bonobo_moniker_get_name_full</primary></indexterm><programlisting>const <link linkend="char">char</link>* bonobo_moniker_get_name_full    (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
 
192
<indexterm><primary>bonobo_moniker_get_name_full</primary></indexterm><programlisting>const <link linkend="char">char</link>*         bonobo_moniker_get_name_full        (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
195
193
<para>
196
194
gets the full unescaped name of the moniker eg.
197
195
file:/tmp/hash\#.gz returns file:/tmp/hash#.gz</para>
206
204
</variablelist></refsect2>
207
205
<refsect2>
208
206
<title><anchor id="bonobo-moniker-get-name-escaped" role="function"/>bonobo_moniker_get_name_escaped ()</title>
209
 
<indexterm><primary>bonobo_moniker_get_name_escaped</primary></indexterm><programlisting><link linkend="char">char</link>*       bonobo_moniker_get_name_escaped (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
 
207
<indexterm><primary>bonobo_moniker_get_name_escaped</primary></indexterm><programlisting><link linkend="char">char</link>*               bonobo_moniker_get_name_escaped     (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
210
208
<para>
211
209
Get the full, escaped name of the moniker eg.
212
210
file:/tmp/hash\#.gz returns file:/tmp/hash\#.gz</para>
223
221
</variablelist></refsect2>
224
222
<refsect2>
225
223
<title><anchor id="bonobo-moniker-set-name" role="function"/>bonobo_moniker_set_name ()</title>
226
 
<indexterm><primary>bonobo_moniker_set_name</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_moniker_set_name         (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
227
 
                                             const <link linkend="char">char</link> *name);</programlisting>
 
224
<indexterm><primary>bonobo_moniker_set_name</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_moniker_set_name             (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
225
                                                         const <link linkend="char">char</link> *name);</programlisting>
228
226
<para>
229
227
This functions sets the moniker name in <parameter>moniker</parameter> to be <parameter>name</parameter>.</para>
230
228
<para>
239
237
</variablelist></refsect2>
240
238
<refsect2>
241
239
<title><anchor id="bonobo-moniker-get-prefix" role="function"/>bonobo_moniker_get_prefix ()</title>
242
 
<indexterm><primary>bonobo_moniker_get_prefix</primary></indexterm><programlisting>const <link linkend="char">char</link>* bonobo_moniker_get_prefix       (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
 
240
<indexterm><primary>bonobo_moniker_get_prefix</primary></indexterm><programlisting>const <link linkend="char">char</link>*         bonobo_moniker_get_prefix           (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
243
241
<para>
244
242
</para>
245
243
<para>
254
252
</variablelist></refsect2>
255
253
<refsect2>
256
254
<title><anchor id="bonobo-moniker-set-case-sensitive" role="function"/>bonobo_moniker_set_case_sensitive ()</title>
257
 
<indexterm><primary>bonobo_moniker_set_case_sensitive</primary></indexterm><programlisting><link linkend="void">void</link>        bonobo_moniker_set_case_sensitive
258
 
                                            (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
259
 
                                             <link linkend="gboolean">gboolean</link> sensitive);</programlisting>
 
255
<indexterm><primary>bonobo_moniker_set_case_sensitive</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_moniker_set_case_sensitive   (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
 
256
                                                         <link linkend="gboolean">gboolean</link> sensitive);</programlisting>
260
257
<para>
261
258
Sets up whether we use case sensitivity for the default equal impl.</para>
262
259
<para>
271
268
</variablelist></refsect2>
272
269
<refsect2>
273
270
<title><anchor id="bonobo-moniker-get-case-sensitive" role="function"/>bonobo_moniker_get_case_sensitive ()</title>
274
 
<indexterm><primary>bonobo_moniker_get_case_sensitive</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    bonobo_moniker_get_case_sensitive
275
 
                                            (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
 
271
<indexterm><primary>bonobo_moniker_get_case_sensitive</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            bonobo_moniker_get_case_sensitive   (<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker);</programlisting>
276
272
<para>
277
273
</para>
278
274
<para>