This file is indexed.

/usr/share/gtk-doc/html/libbonoboui/libbonoboui-bonobo-ui-util.html is in libbonoboui2-dev 2.24.5-3ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>bonobo-ui-util</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="LibBonoboUI API Reference Manual">
<link rel="up" href="bonobo-ui.html" title="Bonobo UI">
<link rel="prev" href="libbonoboui-bonobo-ui-container.html" title="BonoboUIContainer">
<link rel="next" href="libbonoboui-bonobo-ui-node.html" title="bonobo-ui-node">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonoboui-bonobo-ui-container.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="bonobo-ui.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">LibBonoboUI API Reference Manual</th>
<td><a accesskey="n" href="libbonoboui-bonobo-ui-node.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonoboui-bonobo-ui-util.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonoboui-bonobo-ui-util.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonoboui-bonobo-ui-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonoboui-bonobo-ui-util.top_of_page"></a>bonobo-ui-util</span></h2>
<p>bonobo-ui-util — A collection of utility functions to help with UI related issues</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonoboui-bonobo-ui-util.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">char</span> *              <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-pixbuf-to-xml" title="bonobo_ui_util_pixbuf_to_xml ()">bonobo_ui_util_pixbuf_to_xml</a>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-xml-to-pixbuf" title="bonobo_ui_util_xml_to_pixbuf ()">bonobo_ui_util_xml_to_pixbuf</a>        (<em class="parameter"><code>const <span class="type">char</span> *xml</code></em>);
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-xml-get-icon-widget" title="bonobo_ui_util_xml_get_icon_widget ()">bonobo_ui_util_xml_get_icon_widget</a>  (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>,
                                                         <em class="parameter"><code><span class="type">GtkIconSize</span> icon_size</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-xml-set-pixbuf" title="bonobo_ui_util_xml_set_pixbuf ()">bonobo_ui_util_xml_set_pixbuf</a>       (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-build-help-menu" title="bonobo_ui_util_build_help_menu ()">bonobo_ui_util_build_help_menu</a>      (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *listener</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *parent</code></em>);
<span class="returnvalue">char</span> *              <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-get-ui-fname" title="bonobo_ui_util_get_ui_fname ()">bonobo_ui_util_get_ui_fname</a>         (<em class="parameter"><code>const <span class="type">char</span> *component_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-translate-ui" title="bonobo_ui_util_translate_ui ()">bonobo_ui_util_translate_ui</a>         (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-fixup-help" title="bonobo_ui_util_fixup_help ()">bonobo_ui_util_fixup_help</a>           (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-fixup-icons" title="bonobo_ui_util_fixup_icons ()">bonobo_ui_util_fixup_icons</a>          (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>);
<a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="returnvalue">BonoboUINode</span></a> *      <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-new-ui" title="bonobo_ui_util_new_ui ()">bonobo_ui_util_new_ui</a>               (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *fname</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-set-ui" title="bonobo_ui_util_set_ui ()">bonobo_ui_util_set_ui</a>               (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_ev</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-set-pixbuf" title="bonobo_ui_util_set_pixbuf ()">bonobo_ui_util_set_pixbuf</a>           (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_ev</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-accel-name" title="bonobo_ui_util_accel_name ()">bonobo_ui_util_accel_name</a>           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> accelerator_key</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkModifierType</span> accelerator_mods</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-accel-parse" title="bonobo_ui_util_accel_parse ()">bonobo_ui_util_accel_parse</a>          (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *accelerator_key</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkModifierType</span> *accelerator_mods</code></em>);
#define             <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-decode-str" title="bonobo_ui_util_decode_str()">bonobo_ui_util_decode_str</a>           (s,
                                                         e)
#define             <a class="link" href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-encode-str" title="bonobo_ui_util_encode_str()">bonobo_ui_util_encode_str</a>           (s)
</pre>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-ui-util.description"></a><h2>Description</h2>
<p>
The UI utilities do man things, mostly concerned with smoothing
the flow of XML data from containee to container. There are also
several generaly useful functions used internaly for manipulating
pixmaps. Also, code for stringifying accelerators, fixing up help
and working around libxml bugs. Also a large chunk of code is
included for dynamic UI tree building that is now strongly
deprecated by the various tools to do this from dynamic files.
</p>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-ui-util.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="bonobo-ui-util-pixbuf-to-xml"></a><h3>bonobo_ui_util_pixbuf_to_xml ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              bonobo_ui_util_pixbuf_to_xml        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
<p>
Convert a <em class="parameter"><code>pixbuf</code></em> to a string representation suitable
for passing as a "pixname" attribute with a pixtype
attribute = "pixbuf".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>a GdkPixbuf
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the stringified pixbuf.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-xml-to-pixbuf"></a><h3>bonobo_ui_util_xml_to_pixbuf ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         bonobo_ui_util_xml_to_pixbuf        (<em class="parameter"><code>const <span class="type">char</span> *xml</code></em>);</pre>
<p>
This converts a stringified pixbuf in <em class="parameter"><code>xml</code></em> into a GdkPixbuf
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xml</code></em> :</span></p></td>
<td>a string
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a handed reference to the created GdkPixbuf.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-xml-get-icon-widget"></a><h3>bonobo_ui_util_xml_get_icon_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         bonobo_ui_util_xml_get_icon_widget  (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>,
                                                         <em class="parameter"><code><span class="type">GtkIconSize</span> icon_size</code></em>);</pre>
<p>
This function extracts a pixbuf from the node and returns a GtkWidget
containing a display of the pixbuf.
</p>
<p>
Unused internally.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>the node
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon_size</code></em> :</span></p></td>
<td>the desired size of the icon
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-xml-set-pixbuf"></a><h3>bonobo_ui_util_xml_set_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_xml_set_pixbuf       (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
<p>
Associate <em class="parameter"><code>pixbuf</code></em> with this <em class="parameter"><code>node</code></em> by stringifying it and setting
the requisite attributes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>the node
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>the pixbuf
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-build-help-menu"></a><h3>bonobo_ui_util_build_help_menu ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_build_help_menu      (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *listener</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *parent</code></em>);</pre>
<p>
This routine inserts all the help menu items appropriate for this
application as children of the <em class="parameter"><code>parent</code></em> node.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>associated component
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></p></td>
<td>application prefix
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>application name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>toplevel node
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-get-ui-fname"></a><h3>bonobo_ui_util_get_ui_fname ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              bonobo_ui_util_get_ui_fname         (<em class="parameter"><code>const <span class="type">char</span> *component_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>);</pre>
<p>
Builds a path to the xml file that stores the GUI.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>component_prefix</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>the file name of the xml file.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the path to the file that describes the
UI or NULL if it is not found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-translate-ui"></a><h3>bonobo_ui_util_translate_ui ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_translate_ui         (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>);</pre>
<p>
Quest through a tree looking for translatable properties
( those prefixed with an '_' ). Translates the value of the
property and removes the leading '_'.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>the node to start at.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-fixup-help"></a><h3>bonobo_ui_util_fixup_help ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_fixup_help           (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);</pre>
<p>
This searches for 'BuiltMenuItems' placeholders, and then
fills them with the application's menu items.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
<td>the UI component
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>the node to search under
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></p></td>
<td>the application prefix
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>the application name
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-fixup-icons"></a><h3>bonobo_ui_util_fixup_icons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_fixup_icons          (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="type">BonoboUINode</span></a> *node</code></em>);</pre>
<p>
This function is used to ensure filename pixbuf attributes are
converted to in-line pixbufs on the server side, so that we don't
sent a ( possibly invalid ) filename across the wire.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>the node
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-new-ui"></a><h3>bonobo_ui_util_new_ui ()</h3>
<pre class="programlisting"><a class="link" href="libbonoboui-bonobo-ui-node.html#BonoboUINode" title="BonoboUINode"><span class="returnvalue">BonoboUINode</span></a> *      bonobo_ui_util_new_ui               (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *fname</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);</pre>
<p>
Loads an xml tree from a file, cleans the 
doc cruft from its nodes; and translates the nodes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
<td>The component help callback should be on
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fname</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>Application name ( for finding help )
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The translated tree ready to be merged.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-set-ui"></a><h3>bonobo_ui_util_set_ui ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_set_ui               (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_prefix</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_ev</code></em>);</pre>
<p>
This function loads the UI from the associated file, translates it,
fixes up all the menus, ensures pixbuf filenames are resolved to xml
and then merges the XML to the remote container - this is the best
and most simple entry point for the new UI code.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
<td>the component
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>the filename of the file to merge relative to the prefix.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>the application name - for help merging
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-set-pixbuf"></a><h3>bonobo_ui_util_set_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_set_pixbuf           (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a> *component</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_ev</code></em>);</pre>
<p>
This helper function sets a pixbuf at a certain path into an
xml tree.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
<td>the component
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the path into the xml tree
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>the pixbuf
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-accel-name"></a><h3>bonobo_ui_util_accel_name ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             bonobo_ui_util_accel_name           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> accelerator_key</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkModifierType</span> accelerator_mods</code></em>);</pre>
<p>
This stringifies an <em class="parameter"><code>accelerator_key</code></em> and some <em class="parameter"><code>accelerator_mods</code></em>
it is the converse of bonobo_ui_util_accel_parse
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>accelerator_key</code></em> :</span></p></td>
<td>the key
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accelerator_mods</code></em> :</span></p></td>
<td>the modifiers
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the stringified representation
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-accel-parse"></a><h3>bonobo_ui_util_accel_parse ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_util_accel_parse          (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *accelerator_key</code></em>,
                                                         <em class="parameter"><code><span class="type">GdkModifierType</span> *accelerator_mods</code></em>);</pre>
<p>
This parses the accelerator string and returns the key and mods
associated with it - using a similar format to Gtk+ but one which
doesn't involve inefficient XML entities and avoids other misc.
problems.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accelerator_key</code></em> :</span></p></td>
<td>output of the key
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accelerator_mods</code></em> :</span></p></td>
<td>output of the mods
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-decode-str"></a><h3>bonobo_ui_util_decode_str()</h3>
<pre class="programlisting">#define         bonobo_ui_util_decode_str(s,e) g_strdup (s)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>e</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-util-encode-str"></a><h3>bonobo_ui_util_encode_str()</h3>
<pre class="programlisting">#define         bonobo_ui_util_encode_str(s)   g_strdup (s)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>