/usr/share/gtk-doc/html/rhythmbox/rhythmbox-rb-builder-helpers.html is in rhythmbox-doc 3.4.2-4ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>rb-builder-helpers: Rhythmbox Development Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch02.html" title="Lib">
<link rel="prev" href="rhythmbox-rb-file-helpers.html" title="rb-file-helpers">
<link rel="next" href="RBStringValueMap.html" title="RBStringValueMap">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#rhythmbox-rb-builder-helpers.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="rhythmbox-rb-file-helpers.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RBStringValueMap.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="rhythmbox-rb-builder-helpers"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-rb-builder-helpers.top_of_page"></a>rb-builder-helpers</span></h2>
<p>rb-builder-helpers — helper functions for dealing with GtkBuilder files</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="rhythmbox-rb-builder-helpers.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="returnvalue">GtkBuilder</span></a> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-builder-helpers.html#rb-builder-load" title="rb_builder_load ()">rb_builder_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="returnvalue">GtkBuilder</span></a> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-builder-helpers.html#rb-builder-load-plugin-file" title="rb_builder_load_plugin_file ()">rb_builder_load_plugin_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-builder-helpers.html#rb-builder-boldify-label" title="rb_builder_boldify_label ()">rb_builder_boldify_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-builder-helpers.html#rb-combo-box-hyphen-separator-func" title="rb_combo_box_hyphen_separator_func ()">rb_combo_box_hyphen_separator_func</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-builder-helpers.description"></a><h2>Description</h2>
<p>Some simple helper functions to make it a bit easier to deal with
widgets built from GtkBuilder files.</p>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-builder-helpers.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-builder-load"></a><h3>rb_builder_load ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="returnvalue">GtkBuilder</span></a> *
rb_builder_load (<em class="parameter"><code>const <span class="type">char</span> *file</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Locates and reads a GtkBuilder file, automatically connecting
signal handlers where possible.</p>
<p>The caller can specify an absolute path to the file, a resource path
starting with /org/gnome/Rhythmbox/ or just a filename, in which case
the file will be loaded from GResources (in normal builds) or the source
data/ui directory (in uninstalled builds).</p>
<div class="refsect3">
<a name="rb-builder-load.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>filename, either absolute or relative to the data directory</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to autoconnected signal handlers</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-builder-load.returns"></a><h4>Returns</h4>
<p><a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="type">GtkBuilder</span></a> object built from the file. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-builder-load-plugin-file"></a><h3>rb_builder_load_plugin_file ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="returnvalue">GtkBuilder</span></a> *
rb_builder_load_plugin_file (<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *plugin</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *file</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Like <a class="link" href="rhythmbox-rb-builder-helpers.html#rb-builder-load" title="rb_builder_load ()"><span class="type">rb_builder_load</span></a>, except it finds files associated with
plugins as well as those in the core data directories.</p>
<div class="refsect3">
<a name="rb-builder-load-plugin-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p><span class="type">RBPlugin</span> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>name of file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data to pass to autoconnected signal handlers</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-builder-load-plugin-file.returns"></a><h4>Returns</h4>
<p><a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="type">GtkBuilder</span></a> object built from the file. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-builder-boldify-label"></a><h3>rb_builder_boldify_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_builder_boldify_label (<em class="parameter"><code><a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="type">GtkBuilder</span></a> *builder</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>Makes a label built from a GtkBuilder file bold.</p>
<div class="refsect3">
<a name="rb-builder-boldify-label.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>builder</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkBuilder.html#GtkBuilder-struct"><span class="type">GtkBuilder</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name of the label to boldify</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-combo-box-hyphen-separator-func"></a><h3>rb_combo_box_hyphen_separator_func ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_combo_box_hyphen_separator_func (<em class="parameter"><code><a href="../gtk3/GtkTreeModel.html#GtkTreeModel-struct"><span class="type">GtkTreeModel</span></a> *model</code></em>,
<em class="parameter"><code><a href="../gtk3/GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>A row separator function to use for GtkComboBox widgets.
It expects the model to contain a string in its first column,
and interprets a string containing a single hyphen character
as a separator.</p>
<div class="refsect3">
<a name="rb-combo-box-hyphen-separator-func.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkTreeModel.html#GtkTreeModel-struct"><span class="type">GtkTreeModel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>nothing</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-combo-box-hyphen-separator-func.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the row pointed to by <em class="parameter"><code>iter</code></em>
is a separator</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-builder-helpers.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|