/usr/share/gtk-doc/html/libfm/FmDirTreeView.html is in libfm-doc 1.2.5-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FmDirTreeView: Libfm Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-gtk.html" title="Libfm Gtk+ Widgets and Objects.">
<link rel="prev" href="FmDirTreeModel.html" title="FmDirTreeModel">
<link rel="next" href="libfm-Drag-and-drop-autoscrolling.html" title="Drag and drop autoscrolling">
<meta name="generator" content="GTK-Doc V1.25 (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="#FmDirTreeView.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#FmDirTreeView.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#FmDirTreeView.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#FmDirTreeView.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#FmDirTreeView.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="libfm-gtk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="FmDirTreeModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libfm-Drag-and-drop-autoscrolling.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FmDirTreeView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FmDirTreeView.top_of_page"></a>FmDirTreeView</span></h2>
<p>FmDirTreeView — A directory tree view widget.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FmDirTreeView.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="FmDirTreeView.html#fm-dir-tree-view-chdir" title="fm_dir_tree_view_chdir ()">fm_dir_tree_view_chdir</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="returnvalue">FmPath</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmDirTreeView.html#fm-dir-tree-view-get-cwd" title="fm_dir_tree_view_get_cwd ()">fm_dir_tree_view_get_cwd</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="returnvalue">FmDirTreeView</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmDirTreeView.html#fm-dir-tree-view-new" title="fm_dir_tree_view_new ()">fm_dir_tree_view_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="FmDirTreeView.html#FmDirTreeView--show-hidden" title="The “show-hidden” property">show-hidden</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.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="FmDirTreeView.html#FmDirTreeView-chdir" title="The “chdir” signal">chdir</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/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="FmDirTreeView.html#FmDirTreeView-item-popup" title="The “item-popup” signal">item-popup</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.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="FmDirTreeView.html#FmDirTreeView-struct" title="struct FmDirTreeView">FmDirTreeView</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmDirTreeView.html#FmDirTreeViewClass" title="struct FmDirTreeViewClass">FmDirTreeViewClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> GtkObject
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkTreeView.html#GtkTreeView-struct">GtkTreeView</a>
<span class="lineart">╰──</span> FmDirTreeView
</pre>
</div>
<div class="refsect1">
<a name="FmDirTreeView.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
FmDirTreeView implements
AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="FmDirTreeView.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm-gtk.h</p>
<p>The <a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> represents view of filesystem as ierarchical tree
of folders where each node can be expanded or collapsed when required.</p>
</div>
<div class="refsect1">
<a name="FmDirTreeView.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fm-dir-tree-view-chdir"></a><h3>fm_dir_tree_view_chdir ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_dir_tree_view_chdir (<em class="parameter"><code><a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> *view</code></em>,
<em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="type">FmPath</span></a> *path</code></em>);</pre>
<p>Queries change selected directory in the <em class="parameter"><code>view</code></em>
to new <em class="parameter"><code>path</code></em>
. The
widget will expand nodes in the tree if that will be needed to
reach requested path.</p>
<div class="refsect3">
<a name="fm-dir-tree-view-chdir.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>view</p></td>
<td class="parameter_description"><p>the widget to change</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>new directory</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-view-get-cwd"></a><h3>fm_dir_tree_view_get_cwd ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="returnvalue">FmPath</span></a> *
fm_dir_tree_view_get_cwd (<em class="parameter"><code><a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> *view</code></em>);</pre>
<p>Retrieves current selected directory. Returned data are owned by <em class="parameter"><code>view</code></em>
and should not be freed by caller.</p>
<div class="refsect3">
<a name="fm-dir-tree-view-get-cwd.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>view</p></td>
<td class="parameter_description"><p>the widget to retrieve info</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-dir-tree-view-get-cwd.returns"></a><h4>Returns</h4>
<p> current directory path. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-view-new"></a><h3>fm_dir_tree_view_new ()</h3>
<pre class="programlisting"><a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="returnvalue">FmDirTreeView</span></a> *
fm_dir_tree_view_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates new <a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> widget.</p>
<div class="refsect3">
<a name="fm-dir-tree-view-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> object.</p>
</div>
<p class="since">Since: 0.1.0</p>
</div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmDirTreeView-struct"></a><h3>struct FmDirTreeView</h3>
<pre class="programlisting">struct FmDirTreeView;</pre>
</div>
<hr>
<div class="refsect2">
<a name="FmDirTreeViewClass"></a><h3>struct FmDirTreeViewClass</h3>
<pre class="programlisting">struct FmDirTreeViewClass {
GtkTreeViewClass parent_class;
void (*chdir)(FmDirTreeView* view, guint button, FmPath* path);
void (*item_popup)(FmDirTreeView* view, GtkUIManager* ui, GtkActionGroup* act_grp, FmFileInfo* file);
};
</pre>
<div class="refsect3">
<a name="FmDirTreeViewClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmDirTreeViewClass.chdir"></a>chdir</code></em> ()</p></td>
<td class="struct_member_description"><p>the class closure for the <a class="link" href="FmDirTreeView.html#FmDirTreeView-chdir" title="The “chdir” signal"><span class="type">“chdir”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmDirTreeViewClass.item-popup"></a>item_popup</code></em> ()</p></td>
<td class="struct_member_description"><p>the class closure for the <a class="link" href="FmDirTreeView.html#FmDirTreeView-item-popup" title="The “item-popup” signal"><span class="type">“item-popup”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="FmDirTreeView--show-hidden"></a><h3>The <code class="literal">“show-hidden”</code> property</h3>
<pre class="programlisting"> “show-hidden” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>The <a class="link" href="FmDirTreeView.html#FmDirTreeView--show-hidden" title="The “show-hidden” property"><span class="type">“show-hidden”</span></a> property defines whether any hidden
files be shown in the tree or not</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: 1.2.0</p>
</div>
</div>
<div class="refsect1">
<a name="FmDirTreeView.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="FmDirTreeView-chdir"></a><h3>The <code class="literal">“chdir”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> *view,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> button,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> path,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The <a class="link" href="FmDirTreeView.html#FmDirTreeView-chdir" title="The “chdir” signal"><span class="type">“chdir”</span></a> signal is emitted when current selected
directory in view is changed.</p>
<div class="refsect3">
<a name="FmDirTreeView-chdir.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>view</p></td>
<td class="parameter_description"><p>a view instance that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>button</p></td>
<td class="parameter_description"><p>always is 1</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>(<a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="type">FmPath</span></a> *) new directory path</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="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="FmDirTreeView-item-popup"></a><h3>The <code class="literal">“item-popup”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> *view,
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *ui,
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *act_grp,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> fi,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The <a class="link" href="FmDirTreeView.html#FmDirTreeView-item-popup" title="The “item-popup” signal"><span class="type">“item-popup”</span></a> signal is emitted when context menu
is created for any directory in the view. Handler can modify the
menu by adding or removing elements.</p>
<div class="refsect3">
<a name="FmDirTreeView-item-popup.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>view</p></td>
<td class="parameter_description"><p>a view instance that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ui</p></td>
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gtk3/GtkUIManager.html#GtkUIManager-struct"><span class="type">GtkUIManager</span></a> using to create the menu</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>act_grp</p></td>
<td class="parameter_description"><p>(<a href="/usr/share/gtk-doc/html/gtk3/GtkActionGroup.html#GtkActionGroup-struct"><span class="type">GtkActionGroup</span></a> *) the menu actions group</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fi</p></td>
<td class="parameter_description"><p>(<a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="type">FmFileInfo</span></a> *) the item where menu popup is activated</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="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: 1.2.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|