/usr/share/gtk-doc/html/rhythmbox/RBDisplayPageTree.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBDisplayPageTree: 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="ch06.html" title="Sources">
<link rel="prev" href="RBDisplayPageModel.html" title="RBDisplayPageModel">
<link rel="next" href="RBImportErrorsSource.html" title="RBImportErrorsSource">
<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="#RBDisplayPageTree.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RBDisplayPageTree.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#RBDisplayPageTree.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#RBDisplayPageTree.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#RBDisplayPageTree.signals" class="shortcut">Signals</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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RBDisplayPageModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RBImportErrorsSource.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RBDisplayPageTree"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBDisplayPageTree.top_of_page"></a>RBDisplayPageTree</span></h2>
<p>RBDisplayPageTree — widget displaying the tree of <a class="link" href="RBDisplayPage.html" title="RBDisplayPage"><span class="type">RBDisplayPage</span></a> instances</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RBDisplayPageTree.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 class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="returnvalue">RBDisplayPageTree</span></a> *
</td>
<td class="function_name">
<a class="link" href="RBDisplayPageTree.html#rb-display-page-tree-new" title="rb_display_page_tree_new ()">rb_display_page_tree_new</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="RBDisplayPageTree.html#rb-display-page-tree-edit-source-name" title="rb_display_page_tree_edit_source_name ()">rb_display_page_tree_edit_source_name</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="RBDisplayPageTree.html#rb-display-page-tree-select" title="rb_display_page_tree_select ()">rb_display_page_tree_select</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="RBDisplayPageTree.html#rb-display-page-tree-toggle-expanded" title="rb_display_page_tree_toggle_expanded ()">rb_display_page_tree_toggle_expanded</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../gtk3/GtkTreeModel.html#GtkTreeModel-struct"><span class="type">GtkTreeModel</span></a> *</td>
<td class="property_name"><a class="link" href="RBDisplayPageTree.html#RBDisplayPageTree--model" title="The “model” property">model</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *</td>
<td class="property_name"><a class="link" href="RBDisplayPageTree.html#RBDisplayPageTree--shell" title="The “shell” property">shell</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBDisplayPageTree.html#RBDisplayPageTree-drop-received" title="The “drop-received” signal">drop-received</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBDisplayPageTree.html#RBDisplayPageTree-selected" title="The “selected” signal">selected</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RBDisplayPageTree.html#RBDisplayPageTree-struct" title="struct RBDisplayPageTree">RBDisplayPageTree</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RBDisplayPageTree.html#RBDisplayPageTreeClass" title="struct RBDisplayPageTreeClass">RBDisplayPageTreeClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkGrid.html#GtkGrid-struct">GtkGrid</a>
<span class="lineart">╰──</span> RBDisplayPageTree
</pre>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBDisplayPageTree implements
AtkImplementorIface, <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a> and <a href="../gtk3/gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.description"></a><h2>Description</h2>
<p>The display page tree widget is a GtkTreeView backed by a GtkListStore
containing the display page instances (sources and other things). Display
pages include sources, such as the library and playlists, and other things
like the visualization display.</p>
<p>Display pages are shown in the list with an icon and the name. The current
playing source is displayed in bold.</p>
<p>Sources are divided into groups - library, stores, playlists, devices,
network shares. Groups are displayed as headers, with expanders for hiding
and showing the sources in the group. Sources themselves may also have
child sources, such as playlists on portable audio players.</p>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-display-page-tree-new"></a><h3>rb_display_page_tree_new ()</h3>
<pre class="programlisting"><a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="returnvalue">RBDisplayPageTree</span></a> *
rb_display_page_tree_new (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);</pre>
<p>Creates the display page tree widget.</p>
<div class="refsect3">
<a name="rb-display-page-tree-new.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>shell</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-display-page-tree-new.returns"></a><h4>Returns</h4>
<p> the display page tree widget.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-display-page-tree-edit-source-name"></a><h3>rb_display_page_tree_edit_source_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_display_page_tree_edit_source_name (<em class="parameter"><code><a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a> *display_page_tree</code></em>,
<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>);</pre>
<p>Initiates editing of the name of the specified source. The row for the source
is selected and given input focus, allowing the user to edit the name.
source_name_edited_cb is called when the user finishes editing.</p>
<div class="refsect3">
<a name="rb-display-page-tree-edit-source-name.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>display_page_tree</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> to edit</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-display-page-tree-select"></a><h3>rb_display_page_tree_select ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_display_page_tree_select (<em class="parameter"><code><a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a> *display_page_tree</code></em>,
<em class="parameter"><code><a class="link" href="RBDisplayPage.html" title="RBDisplayPage"><span class="type">RBDisplayPage</span></a> *page</code></em>);</pre>
<p>Selects the specified page in the tree. This will result in the 'selected'
signal being emitted.</p>
<div class="refsect3">
<a name="rb-display-page-tree-select.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>display_page_tree</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>page</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPage.html" title="RBDisplayPage"><span class="type">RBDisplayPage</span></a> to select</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-display-page-tree-toggle-expanded"></a><h3>rb_display_page_tree_toggle_expanded ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_display_page_tree_toggle_expanded (<em class="parameter"><code><a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a> *display_page_tree</code></em>,
<em class="parameter"><code><a class="link" href="RBDisplayPage.html" title="RBDisplayPage"><span class="type">RBDisplayPage</span></a> *page</code></em>);</pre>
<p>If <em class="parameter"><code>page</code></em>
is expanded (children visible), collapses it, otherwise expands it.</p>
<div class="refsect3">
<a name="rb-display-page-tree-toggle-expanded.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>display_page_tree</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>page</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPage.html" title="RBDisplayPage"><span class="type">RBDisplayPage</span></a> to toggle</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBDisplayPageTree-struct"></a><h3>struct RBDisplayPageTree</h3>
<pre class="programlisting">struct RBDisplayPageTree;</pre>
</div>
<hr>
<div class="refsect2">
<a name="RBDisplayPageTreeClass"></a><h3>struct RBDisplayPageTreeClass</h3>
<pre class="programlisting">struct RBDisplayPageTreeClass {
GtkGridClass parent_class;
/* signals */
void (*selected) (RBDisplayPageTree *tree, RBDisplayPage *page);
void (*drop_received) (RBDisplayPageTree *tree, RBDisplayPage *page, GtkSelectionData *data);
};
</pre>
</div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RBDisplayPageTree--model"></a><h3>The <code class="literal">“model”</code> property</h3>
<pre class="programlisting"> “model” <a href="../gtk3/GtkTreeModel.html#GtkTreeModel-struct"><span class="type">GtkTreeModel</span></a> *</pre>
<p>The <a href="../gtk3/GtkTreeModel.html#GtkTreeModel-struct"><span class="type">GtkTreeModel</span></a> for the display page tree</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="RBDisplayPageTree--shell"></a><h3>The <code class="literal">“shell”</code> property</h3>
<pre class="programlisting"> “shell” <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *</pre>
<p>The <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> instance</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="RBDisplayPageTree.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBDisplayPageTree-drop-received"></a><h3>The <code class="literal">“drop-received”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a> *tree,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> page,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when a drag and drop to the tree completes.</p>
<div class="refsect3">
<a name="RBDisplayPageTree-drop-received.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>tree</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>page</p></td>
<td class="parameter_description"><p>the <span class="type">RBDisplagePage</span> receiving the drop</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>the drop data</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 set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBDisplayPageTree-selected"></a><h3>The <code class="literal">“selected”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a> *tree,
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *page,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when a page is selected from the tree</p>
<div class="refsect3">
<a name="RBDisplayPageTree-selected.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>tree</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBDisplayPageTree.html" title="RBDisplayPageTree"><span class="type">RBDisplayPageTree</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>page</p></td>
<td class="parameter_description"><p>the newly selected <a class="link" href="RBDisplayPage.html" title="RBDisplayPage"><span class="type">RBDisplayPage</span></a></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 set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|