← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/api/tmpl/bonobo-arg.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-02-18 14:40:51 UTC
  • mto: (3.1.1 etch) (1.1.25 upstream)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20050218144051-fo4h9qh2gim8x3wt
Tags: upstream-2.8.1
Import upstream version 2.8.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/tmpl/bonobo-arg.sgml
9
9
The BonoboArg code, and macros are designed to make the
10
10
use of CORBA_Any's slightly simpler by providing a glib
11
11
like binding for them. The bonobo-arg code also provides
12
 
mappings between Gtk Args and CORBA_anys.
 
12
mappings between GValues and CORBA_anys.
13
13
</para>
14
14
 
15
15
<para>
24
24
          CORBA_Environment *ev,
25
25
          gpointer           user_data)
26
26
{
27
 
        GtkObject *clock = user_data;
 
27
        GObject *clock = user_data;
28
28
 
29
29
        switch (arg_id) {
30
30
 
75
75
 
76
76
<!-- ##### MACRO BONOBO_ARG_SHORT ##### -->
77
77
<para>
78
 
 
 
78
the short type
79
79
</para>
80
80
 
81
81
 
96
96
 
97
97
<!-- ##### MACRO BONOBO_ARG_LONGLONG ##### -->
98
98
<para>
99
 
 
 
99
the long long type
100
100
</para>
101
101
 
102
102
 
117
117
 
118
118
<!-- ##### MACRO BONOBO_ARG_CHAR ##### -->
119
119
<para>
120
 
 
 
120
the char type
121
121
</para>
122
122
 
123
123
 
152
152
@c: a BonoboArgType for checking
153
153
@t: the C type of the value eg. for BONOBO_ARG_LONG: CORBA_long
154
154
@e: an optional CORBA_Environment or NULL.
155
 
</para>
156
155
 
157
156
 
158
157
<!-- ##### MACRO BONOBO_ARG_GET_BOOLEAN ##### -->
159
158
<para>
160
 
this macro returns a CORBA_boolean from inside a BonoboArg,
161
 
if the BonoboArg's type does not match, the behavior is
 
159
This macro returns a CORBA_boolean from inside a BonoboArg.
 
160
If the BonoboArg's type does not match, the behavior is
162
161
undefined, and may cause faults.
163
162
</para>
164
163
 
176
175
 
177
176
<!-- ##### MACRO BONOBO_ARG_GET_SHORT ##### -->
178
177
<para>
179
 
 
 
178
This macro returns a CORBA_short from inside a BonoboArg.
 
179
If the BonoboArg's type does not match, the behavior is
 
180
undefined, and may cause faults.
180
181
</para>
181
182
 
182
 
@a: 
 
183
@a: the BonoboArg to extract the value from.
183
184
 
184
185
 
185
186
<!-- ##### MACRO BONOBO_ARG_SET_SHORT ##### -->
186
187
<para>
187
 
 
 
188
This macro sets the value of @a to contain @v
188
189
</para>
189
190
 
190
 
@a: 
191
 
@v: 
 
191
@a: the Bonobo arg to insert the value into
 
192
@v: a CORBA_short.
192
193
 
193
194
 
194
195
<!-- ##### MACRO BONOBO_ARG_GET_INT ##### -->
231
232
 
232
233
<!-- ##### MACRO BONOBO_ARG_GET_LONGLONG ##### -->
233
234
<para>
234
 
 
 
235
this macro returns a CORBA_long_long from from inside a BonoboArg,
 
236
if the BonoboArg's type does not match, the behavior is
 
237
undefined, and may cause faults.
235
238
</para>
236
239
 
237
 
@a: 
 
240
@a: the BonoboArg to extract the value from.
238
241
 
239
242
 
240
243
<!-- ##### MACRO BONOBO_ARG_SET_LONGLONG ##### -->
241
244
<para>
242
 
 
 
245
This macro sets the value of @a to contain @v
243
246
</para>
244
247
 
245
 
@a: 
246
 
@v: 
 
248
@a: the Bonobo arg to insert the value into
 
249
@v: a CORBA_long_long.
247
250
 
248
251
 
249
252
<!-- ##### MACRO BONOBO_ARG_GET_FLOAT ##### -->
267
270
 
268
271
<!-- ##### MACRO BONOBO_ARG_GET_DOUBLE ##### -->
269
272
<para>
270
 
this macro returns a CORBA_double from inside a BonoboArg,
271
 
if the BonoboArg's type does not match, the behavior is
 
273
This macro returns a CORBA_double from inside a BonoboArg.
 
274
If the BonoboArg's type does not match, the behavior is
272
275
undefined, and may cause faults.
273
276
</para>
274
277
 
286
289
 
287
290
<!-- ##### MACRO BONOBO_ARG_GET_CHAR ##### -->
288
291
<para>
289
 
 
 
292
This macro returns a CORBA_char from inside a BonoboArg,
 
293
If the BonoboArg's type does not match, the behavior is
 
294
undefined, and may cause faults.
290
295
</para>
291
296
 
292
 
@a: 
 
297
@a: the BonoboArg to extract the value from.
293
298
 
294
299
 
295
300
<!-- ##### MACRO BONOBO_ARG_SET_CHAR ##### -->
296
301
<para>
297
 
 
 
302
This macro sets the value of @a to contain @v
298
303
</para>
299
304
 
300
 
@a: 
301
 
@v: 
 
305
@a: the Bonobo arg to insert the value into
 
306
@v: a CORBA_char.
302
307
 
303
308
 
304
309
<!-- ##### MACRO BONOBO_ARG_GET_STRING ##### -->