File: //usr/local/ssl/share/gtk-doc/html/libbonoboui/libbonoboui-bonobo-ui-util.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>bonobo-ui-util</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" 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.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="bonobo-controls.html" title="Controls">
<link rel="chapter" href="bonobo-ui.html" title="Bonobo UI">
<link rel="chapter" href="bonobo-support-utilities.html" title="Supporting Classes">
</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"><nobr><a href="#id2786561" class="shortcut">Top</a>
 | 
<a href="#id2787093" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonoboui-bonobo-ui-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2786561"></a><span class="refentrytitle">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">
<h2>Synopsis</h2>
<pre class="synopsis">
char* <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-pixbuf-to-xml">bonobo_ui_util_pixbuf_to_xml</a> (<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-xml-to-pixbuf">bonobo_ui_util_xml_to_pixbuf</a> (const char *xml);
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-xml-get-icon-widget">bonobo_ui_util_xml_get_icon_widget</a>
(<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node,
<a
href="/usr/share/gtk-doc/html/gtk/gtk-Themeable-Stock-Images.html#GtkIconSize"
>GtkIconSize</a> icon_size);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-xml-set-pixbuf">bonobo_ui_util_xml_set_pixbuf</a> (<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-build-help-menu">bonobo_ui_util_build_help_menu</a> (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *listener,
const char *app_prefix,
const char *app_name,
<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *parent);
char* <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-get-ui-fname">bonobo_ui_util_get_ui_fname</a> (const char *component_prefix,
const char *file_name);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-translate-ui">bonobo_ui_util_translate_ui</a> (<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-fixup-help">bonobo_ui_util_fixup_help</a> (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node,
const char *app_prefix,
const char *app_name);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-fixup-icons">bonobo_ui_util_fixup_icons</a> (<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node);
<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a>* <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-new-ui">bonobo_ui_util_new_ui</a> (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
const char *fname,
const char *app_prefix,
const char *app_name);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-set-ui">bonobo_ui_util_set_ui</a> (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
const char *app_prefix,
const char *file_name,
const char *app_name,
CORBA_Environment *opt_ev);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-set-pixbuf">bonobo_ui_util_set_pixbuf</a> (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
const char *path,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf,
CORBA_Environment *opt_ev);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-accel-name">bonobo_ui_util_accel_name</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> accelerator_key,
<a
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> accelerator_mods);
void <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-accel-parse">bonobo_ui_util_accel_parse</a> (const char *name,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> *accelerator_key,
<a
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> *accelerator_mods);
#define <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-decode-str">bonobo_ui_util_decode_str</a> (s,e)
#define <a href="libbonoboui-bonobo-ui-util.html#bonobo-ui-util-encode-str">bonobo_ui_util_encode_str</a> (s)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2787093"></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" lang="en">
<a name="id2787115"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2787125"></a><h3>
<a name="bonobo-ui-util-pixbuf-to-xml"></a>bonobo_ui_util_pixbuf_to_xml ()</h3>
<a class="indexterm" name="id2787138"></a><pre class="programlisting">char* bonobo_ui_util_pixbuf_to_xml (<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> a GdkPixbuf
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the stringified pixbuf.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787207"></a><h3>
<a name="bonobo-ui-util-xml-to-pixbuf"></a>bonobo_ui_util_xml_to_pixbuf ()</h3>
<a class="indexterm" name="id2787221"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* bonobo_ui_util_xml_to_pixbuf (const char *xml);</pre>
<p>
This converts a stringified pixbuf in <em class="parameter"><code>xml</code></em> into a GdkPixbuf</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>xml</code></em> :</span></td>
<td> a string
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a handed reference to the created GdkPixbuf.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787288"></a><h3>
<a name="bonobo-ui-util-xml-get-icon-widget"></a>bonobo_ui_util_xml_get_icon_widget ()</h3>
<a class="indexterm" name="id2787302"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* bonobo_ui_util_xml_get_icon_widget
(<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node,
<a
href="/usr/share/gtk-doc/html/gtk/gtk-Themeable-Stock-Images.html#GtkIconSize"
>GtkIconSize</a> icon_size);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
<td> the node
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_size</code></em> :</span></td>
<td> the desired size of the icon
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787390"></a><h3>
<a name="bonobo-ui-util-xml-set-pixbuf"></a>bonobo_ui_util_xml_set_pixbuf ()</h3>
<a class="indexterm" name="id2787403"></a><pre class="programlisting">void bonobo_ui_util_xml_set_pixbuf (<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
<td> the node
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> the pixbuf
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787488"></a><h3>
<a name="bonobo-ui-util-build-help-menu"></a>bonobo_ui_util_build_help_menu ()</h3>
<a class="indexterm" name="id2787501"></a><pre class="programlisting">void bonobo_ui_util_build_help_menu (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *listener,
const char *app_prefix,
const char *app_name,
<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *parent);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>listener</code></em> :</span></td>
<td> associated component
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></td>
<td> application prefix
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_name</code></em> :</span></td>
<td> application name
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent</code></em> :</span></td>
<td> toplevel node
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787625"></a><h3>
<a name="bonobo-ui-util-get-ui-fname"></a>bonobo_ui_util_get_ui_fname ()</h3>
<a class="indexterm" name="id2787639"></a><pre class="programlisting">char* bonobo_ui_util_get_ui_fname (const char *component_prefix,
const char *file_name);</pre>
<p>
Builds a path to the xml file that stores the GUI.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component_prefix</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
<td> the file name of the xml file.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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" lang="en">
<a name="id2787722"></a><h3>
<a name="bonobo-ui-util-translate-ui"></a>bonobo_ui_util_translate_ui ()</h3>
<a class="indexterm" name="id2787736"></a><pre class="programlisting">void bonobo_ui_util_translate_ui (<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
<td> the node to start at.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787788"></a><h3>
<a name="bonobo-ui-util-fixup-help"></a>bonobo_ui_util_fixup_help ()</h3>
<a class="indexterm" name="id2787802"></a><pre class="programlisting">void bonobo_ui_util_fixup_help (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node,
const char *app_prefix,
const char *app_name);</pre>
<p>
This searches for 'BuiltMenuItems' placeholders, and then
fills them with the application's menu items.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component</code></em> :</span></td>
<td> the UI component
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
<td> the node to search under
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></td>
<td> the application prefix
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_name</code></em> :</span></td>
<td> the application name
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787919"></a><h3>
<a name="bonobo-ui-util-fixup-icons"></a>bonobo_ui_util_fixup_icons ()</h3>
<a class="indexterm" name="id2787933"></a><pre class="programlisting">void bonobo_ui_util_fixup_icons (<a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a> *node);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
<td> the node
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2787985"></a><h3>
<a name="bonobo-ui-util-new-ui"></a>bonobo_ui_util_new_ui ()</h3>
<a class="indexterm" name="id2787998"></a><pre class="programlisting"><a href="libbonoboui-bonobo-ui-node.html#BonoboUINode">BonoboUINode</a>* bonobo_ui_util_new_ui (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
const char *fname,
const char *app_prefix,
const char *app_name);</pre>
<p>
Loads an xml tree from a file, cleans the
doc cruft from its nodes; and translates the nodes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component</code></em> :</span></td>
<td> The component help callback should be on
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fname</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_name</code></em> :</span></td>
<td> Application name ( for finding help )
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The translated tree ready to be merged.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2788126"></a><h3>
<a name="bonobo-ui-util-set-ui"></a>bonobo_ui_util_set_ui ()</h3>
<a class="indexterm" name="id2788140"></a><pre class="programlisting">void bonobo_ui_util_set_ui (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
const char *app_prefix,
const char *file_name,
const char *app_name,
CORBA_Environment *opt_ev);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component</code></em> :</span></td>
<td> the component
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_prefix</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
<td> the filename of the file to merge relative to the prefix.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>app_name</code></em> :</span></td>
<td> the application name - for help merging
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2788282"></a><h3>
<a name="bonobo-ui-util-set-pixbuf"></a>bonobo_ui_util_set_pixbuf ()</h3>
<a class="indexterm" name="id2788296"></a><pre class="programlisting">void bonobo_ui_util_set_pixbuf (<a href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent">BonoboUIComponent</a> *component,
const char *path,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf,
CORBA_Environment *opt_ev);</pre>
<p>
This helper function sets a pixbuf at a certain path into an
xml tree.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>component</code></em> :</span></td>
<td> the component
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
<td> the path into the xml tree
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> the pixbuf
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2788412"></a><h3>
<a name="bonobo-ui-util-accel-name"></a>bonobo_ui_util_accel_name ()</h3>
<a class="indexterm" name="id2788425"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* bonobo_ui_util_accel_name (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> accelerator_key,
<a
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> accelerator_mods);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>accelerator_key</code></em> :</span></td>
<td> the key
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>accelerator_mods</code></em> :</span></td>
<td> the modifiers
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the stringified representation
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2788521"></a><h3>
<a name="bonobo-ui-util-accel-parse"></a>bonobo_ui_util_accel_parse ()</h3>
<a class="indexterm" name="id2788534"></a><pre class="programlisting">void bonobo_ui_util_accel_parse (const char *name,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> *accelerator_key,
<a
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> *accelerator_mods);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>accelerator_key</code></em> :</span></td>
<td> output of the key
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>accelerator_mods</code></em> :</span></td>
<td> output of the mods
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2788631"></a><h3>
<a name="bonobo-ui-util-decode-str"></a>bonobo_ui_util_decode_str()</h3>
<a class="indexterm" name="id2788644"></a><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>
<span class="term"><em class="parameter"><code>s</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>e</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2788701"></a><h3>
<a name="bonobo-ui-util-encode-str"></a>bonobo_ui_util_encode_str()</h3>
<a class="indexterm" name="id2788715"></a><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>
<span class="term"><em class="parameter"><code>s</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>