libfm-doc 1.2.4-1ubuntu1 / usr / share / gtk-doc / html / libfm / FmDirTreeModel.html

This file is indexed.

/usr/share/gtk-doc/html/libfm/FmDirTreeModel.html is in libfm-doc 1.2.4-1ubuntu1.

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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FmDirTreeModel: 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="libfm-Clipboard-operations.html" title="Clipboard operations">
<link rel="next" href="FmDirTreeView.html" title="FmDirTreeView">
<meta name="generator" content="GTK-Doc V1.24 (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="#FmDirTreeModel.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#FmDirTreeModel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#FmDirTreeModel.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#FmDirTreeModel.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="libfm-Clipboard-operations.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="FmDirTreeView.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FmDirTreeModel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FmDirTreeModel.top_of_page"></a>FmDirTreeModel</span></h2>
<p>FmDirTreeModel — A model for directory tree view</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FmDirTreeModel.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="FmDirTreeModel.html#fm-dir-tree-model-add-root" title="fm_dir_tree_model_add_root ()">fm_dir_tree_model_add_root</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-get-icon-size" title="fm_dir_tree_model_get_icon_size ()">fm_dir_tree_model_get_icon_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-get-show-hidden" title="fm_dir_tree_model_get_show_hidden ()">fm_dir_tree_model_get_show_hidden</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="FmDirTreeModel.html#fm-dir-tree-model-load-row" title="fm_dir_tree_model_load_row ()">fm_dir_tree_model_load_row</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="returnvalue">FmDirTreeModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-new" title="fm_dir_tree_model_new ()">fm_dir_tree_model_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="FmDirTreeModel.html#fm-dir-tree-model-set-icon-size" title="fm_dir_tree_model_set_icon_size ()">fm_dir_tree_model_set_icon_size</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="FmDirTreeModel.html#fm-dir-tree-model-set-show-hidden" title="fm_dir_tree_model_set_show_hidden ()">fm_dir_tree_model_set_show_hidden</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="FmDirTreeModel.html#fm-dir-tree-model-unload-row" title="fm_dir_tree_model_unload_row ()">fm_dir_tree_model_unload_row</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-row-get-disp-name" title="fm_dir_tree_row_get_disp_name ()">fm_dir_tree_row_get_disp_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="returnvalue">FmFileInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-row-get-file-info" title="fm_dir_tree_row_get_file_info ()">fm_dir_tree_row_get_file_info</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="FmDirTreeModel.html#fm-dir-tree-row-get-file-path" title="fm_dir_tree_row_get_file_path ()">fm_dir_tree_row_get_file_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-row-get-icon" title="fm_dir_tree_row_get_icon ()">fm_dir_tree_row_get_icon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="FmDirTreeModel.html#fm-dir-tree-row-is-loaded" title="fm_dir_tree_row_is_loaded ()">fm_dir_tree_row_is_loaded</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.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="FmDirTreeModel.html#FmDirTreeModel-row-loaded" title="The “row-loaded” signal">row-loaded</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.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="FmDirTreeModel.html#FmDirTreeModel-struct" title="struct FmDirTreeModel">FmDirTreeModel</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmDirTreeModel.html#FmDirTreeModelClass" title="struct FmDirTreeModelClass">FmDirTreeModelClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="FmDirTreeModel.html#FmDirTreeModelCol" title="enum FmDirTreeModelCol">FmDirTreeModelCol</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.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">GObject</a>
    <span class="lineart">╰──</span> FmDirTreeModel
</pre>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
FmDirTreeModel implements
 <a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html">GtkTreeModel</a>.</p>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm-gtk.h</p>
<p>The <a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> represents tree of folders which can be used by
<a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> to create tree-like expandable list of directories.</p>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fm-dir-tree-model-add-root"></a><h3>fm_dir_tree_model_add_root ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_dir_tree_model_add_root (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                            <em class="parameter"><code><a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="type">FmFileInfo</span></a> *root</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Adds a root node for file <em class="parameter"><code>root</code></em>
 into <em class="parameter"><code>model</code></em>
. If <em class="parameter"><code>iter</code></em>
 is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
then on return it will be set to new row data.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.2.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>root</p></td>
<td class="parameter_description"><p>a root path to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p> pointer to iterator to set. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-get-icon-size"></a><h3>fm_dir_tree_model_get_icon_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
fm_dir_tree_model_get_icon_size (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>);</pre>
<p>Retrieves size of icons which are associated with rows.</p>
<p>Before 1.0.0 this API had name fm_dir_tree_get_icon_size.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.3.6"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.9.9.3.7"></a><h4>Returns</h4>
<p> preferrable icom size for the <em class="parameter"><code>model</code></em>
.</p>
</div>
<p class="since">Since: 0.1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-get-show-hidden"></a><h3>fm_dir_tree_model_get_show_hidden ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_dir_tree_model_get_show_hidden (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-load-row"></a><h3>fm_dir_tree_model_load_row ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_dir_tree_model_load_row (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *it</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *tp</code></em>);</pre>
<p>If row with iterator <em class="parameter"><code>it</code></em>
 has its children already retrieved then
does nothing. Else starts retrieving of list of children for row
with iterator <em class="parameter"><code>it</code></em>
 and path <em class="parameter"><code>tp</code></em>
. When children are loaded then a
<a class="link" href="FmDirTreeModel.html#FmDirTreeModel-row-loaded" title="The “row-loaded” signal"><span class="type">“row-loaded”</span></a> signal will be emitted. The folder
associated with the row will be monitored for changes in children
after that.
This API is used when the row is expanded in the view.</p>
<p>Before 1.0.0 this API had name fm_dir_tree_model_expand_row.</p>
<p>See also: <a class="link" href="FmDirTreeModel.html#fm-dir-tree-row-is-loaded" title="fm_dir_tree_row_is_loaded ()"><code class="function">fm_dir_tree_row_is_loaded()</code></a>, <a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-unload-row" title="fm_dir_tree_model_unload_row ()"><code class="function">fm_dir_tree_model_unload_row()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.5.7"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>it</p></td>
<td class="parameter_description"><p>iterator of row to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tp</p></td>
<td class="parameter_description"><p>path of row to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-new"></a><h3>fm_dir_tree_model_new ()</h3>
<pre class="programlisting"><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="returnvalue">FmDirTreeModel</span></a> *
fm_dir_tree_model_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates new <a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> instance.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.6.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> object.</p>
</div>
<p class="since">Since: 0.1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-set-icon-size"></a><h3>fm_dir_tree_model_set_icon_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_dir_tree_model_set_icon_size (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                                 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> icon_size</code></em>);</pre>
<p>Sets size of icons which are associated with rows.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.7.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon_size</p></td>
<td class="parameter_description"><p>new preferrable icon size</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-set-show-hidden"></a><h3>fm_dir_tree_model_set_show_hidden ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_dir_tree_model_set_show_hidden (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                                   <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_hidden</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-model-unload-row"></a><h3>fm_dir_tree_model_unload_row ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_dir_tree_model_unload_row (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *it</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *tp</code></em>);</pre>
<p>If children of row with iterator <em class="parameter"><code>it</code></em>
 are retrieved or monitored
then stops monitoring the folder and forgets children of the row.
This API is used when the row is collapsed in the view.</p>
<p>Before 1.0.0 this API had name fm_dir_tree_model_collapse_row.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.9.6"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>it</p></td>
<td class="parameter_description"><p>iterator of row to unload</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tp</p></td>
<td class="parameter_description"><p>path of row to unload</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-row-get-disp-name"></a><h3>fm_dir_tree_row_get_disp_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
fm_dir_tree_row_get_disp_name (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Retrieves display name of file associated with row of <em class="parameter"><code>iter</code></em>
 in <em class="parameter"><code>model</code></em>
.
Returned data are owned by <em class="parameter"><code>model</code></em>
 and should be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.10.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>the iterator of row to retrieve data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.9.9.10.6"></a><h4>Returns</h4>
<p> the file display name for the row. </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: 1.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-row-get-file-info"></a><h3>fm_dir_tree_row_get_file_info ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="returnvalue">FmFileInfo</span></a> *
fm_dir_tree_row_get_file_info (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Retrieves info for file associated with row of <em class="parameter"><code>iter</code></em>
 in <em class="parameter"><code>model</code></em>
.
Returned data are owned by <em class="parameter"><code>model</code></em>
 and should be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.11.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>the iterator of row to retrieve data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.9.9.11.6"></a><h4>Returns</h4>
<p> the file info for the row. </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: 1.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-row-get-file-path"></a><h3>fm_dir_tree_row_get_file_path ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="returnvalue">FmPath</span></a> *
fm_dir_tree_row_get_file_path (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Retrieves <a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="type">FmPath</span></a> for file associated with row of <em class="parameter"><code>iter</code></em>
 in <em class="parameter"><code>model</code></em>
.
Returned data are owned by <em class="parameter"><code>model</code></em>
 and should be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.12.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>the iterator of row to retrieve data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.9.9.12.6"></a><h4>Returns</h4>
<p> the file path for the row. </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: 1.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-row-get-icon"></a><h3>fm_dir_tree_row_get_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
fm_dir_tree_row_get_icon (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                          <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Retrieves an icon associated with row of <em class="parameter"><code>iter</code></em>
 in <em class="parameter"><code>model</code></em>
. Returned
data are owned by <em class="parameter"><code>model</code></em>
 and should be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.13.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>the iterator of row to retrieve data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.9.9.13.6"></a><h4>Returns</h4>
<p> the icon for the row. </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: 1.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-dir-tree-row-is-loaded"></a><h3>fm_dir_tree_row_is_loaded ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_dir_tree_row_is_loaded (<em class="parameter"><code><a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Checks if the row has its children already retrieved. This check may
need be done since any duplicate calls to <a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-load-row" title="fm_dir_tree_model_load_row ()"><code class="function">fm_dir_tree_model_load_row()</code></a>
will not emit any duplicate <a class="link" href="FmDirTreeModel.html#FmDirTreeModel-row-loaded" title="The “row-loaded” signal"><span class="type">“row-loaded”</span></a> signal.</p>
<div class="refsect3">
<a name="id-1.2.6.9.9.14.5"></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>the model instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>the iterator of row to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.9.9.14.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the row has children already loaded.</p>
</div>
<p class="since">Since: 1.0.0</p>
</div>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmDirTreeModel-struct"></a><h3>struct FmDirTreeModel</h3>
<pre class="programlisting">struct FmDirTreeModel;</pre>
</div>
<hr>
<div class="refsect2">
<a name="FmDirTreeModelClass"></a><h3>struct FmDirTreeModelClass</h3>
<pre class="programlisting">struct FmDirTreeModelClass {
    GObjectClass parent_class;
    void (*row_loaded)(FmDirTreeModel* model, GtkTreePath* row);
};
</pre>
<div class="refsect3">
<a name="id-1.2.6.9.10.3.4"></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><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="FmDirTreeModelClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>the parent class</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmDirTreeModelClass.row-loaded"></a>row_loaded</code></em> ()</p></td>
<td class="struct_member_description"><p>the class closure for the <a class="link" href="FmDirTreeModel.html#FmDirTreeModel-row-loaded" title="The “row-loaded” signal"><span class="type">“row-loaded”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FmDirTreeModelCol"></a><h3>enum FmDirTreeModelCol</h3>
<p>Columns of dir tree model</p>
<div class="refsect3">
<a name="id-1.2.6.9.10.4.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="FM-DIR-TREE-MODEL-COL-ICON:CAPS"></a>FM_DIR_TREE_MODEL_COL_ICON</p></td>
<td class="enum_member_description">
<p>(<span class="type">GdkPixbuf</span> *) icon</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DIR-TREE-MODEL-COL-DISP-NAME:CAPS"></a>FM_DIR_TREE_MODEL_COL_DISP_NAME</p></td>
<td class="enum_member_description">
<p>(<span class="type">char</span> *) displayed name</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DIR-TREE-MODEL-COL-INFO:CAPS"></a>FM_DIR_TREE_MODEL_COL_INFO</p></td>
<td class="enum_member_description">
<p>(<a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="type">FmFileInfo</span></a> *) file info</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DIR-TREE-MODEL-COL-PATH:CAPS"></a>FM_DIR_TREE_MODEL_COL_PATH</p></td>
<td class="enum_member_description">
<p>(<a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="type">FmPath</span></a> *) file path</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DIR-TREE-MODEL-COL-FOLDER:CAPS"></a>FM_DIR_TREE_MODEL_COL_FOLDER</p></td>
<td class="enum_member_description">
<p>(<a class="link" href="FmFolder.html" title="FmFolder"><span class="type">FmFolder</span></a> *) folder object</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="FmDirTreeModel.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="FmDirTreeModel-row-loaded"></a><h3>The <code class="literal">“row-loaded”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="FmDirTreeModel.html" title="FmDirTreeModel"><span class="type">FmDirTreeModel</span></a> *model,
               <a href="/usr/share/gtk-doc/html/gtk3/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>    *row,
               <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="FmDirTreeModel.html#FmDirTreeModel-row-loaded" title="The “row-loaded” signal"><span class="type">“row-loaded”</span></a> signal is emitted when content of
folder <em class="parameter"><code>row</code></em>
 is completely retrieved. It may happen either
after call to <a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-load-row" title="fm_dir_tree_model_load_row ()"><code class="function">fm_dir_tree_model_load_row()</code></a>
or in time of that call (in case if the folder was already cached in
memory).</p>
<p>See also: <a class="link" href="FmDirTreeModel.html#fm-dir-tree-model-unload-row" title="fm_dir_tree_model_unload_row ()"><code class="function">fm_dir_tree_model_unload_row()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.6.9.11.2.6"></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>dir tree model instance that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>row</p></td>
<td class="parameter_description"><p>path to folder row that is ready</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-FIRST:CAPS">Run First</a></p>
<p class="since">Since: 1.0.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.