/usr/share/gtk-doc/html/libfm/FmSidePane.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 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FmSidePane: 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-File-progress-dialog.html" title="File progress dialog">
<link rel="next" href="libfm-FmSortMode.html" title="FmSortMode">
<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="#FmSidePane.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#FmSidePane.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#FmSidePane.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#FmSidePane.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-File-progress-dialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libfm-FmSortMode.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FmSidePane"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FmSidePane.top_of_page"></a>FmSidePane</span></h2>
<p>FmSidePane — A widget for side pane displaying</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FmSidePane.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">
<span class="c_punctuation">(</span><a class="link" href="FmSidePane.html#FmSidePaneUpdatePopup" title="FmSidePaneUpdatePopup ()">*FmSidePaneUpdatePopup</a><span class="c_punctuation">)</span> <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="FmSidePane.html#fm-side-pane-chdir" title="fm_side_pane_chdir ()">fm_side_pane_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="FmSidePane.html#fm-side-pane-get-cwd" title="fm_side_pane_get_cwd ()">fm_side_pane_get_cwd</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="returnvalue">FmSidePaneMode</span></a>
</td>
<td class="function_name">
<a class="link" href="FmSidePane.html#fm-side-pane-get-mode" title="fm_side_pane_get_mode ()">fm_side_pane_get_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="returnvalue">FmSidePaneMode</span></a>
</td>
<td class="function_name">
<a class="link" href="FmSidePane.html#fm-side-pane-get-mode-by-name" title="fm_side_pane_get_mode_by_name ()">fm_side_pane_get_mode_by_name</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="FmSidePane.html#fm-side-pane-get-mode-label" title="fm_side_pane_get_mode_label ()">fm_side_pane_get_mode_label</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="FmSidePane.html#fm-side-pane-get-mode-name" title="fm_side_pane_get_mode_name ()">fm_side_pane_get_mode_name</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="FmSidePane.html#fm-side-pane-get-mode-tooltip" title="fm_side_pane_get_mode_tooltip ()">fm_side_pane_get_mode_tooltip</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#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="FmSidePane.html#fm-side-pane-get-n-modes" title="fm_side_pane_get_n_modes ()">fm_side_pane_get_n_modes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmSidePane.html#fm-side-pane-get-title-bar" title="fm_side_pane_get_title_bar ()">fm_side_pane_get_title_bar</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmSidePane.html" title="FmSidePane"><span class="returnvalue">FmSidePane</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmSidePane.html#fm-side-pane-new" title="fm_side_pane_new ()">fm_side_pane_new</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="FmSidePane.html#fm-side-pane-set-home-dir" title="fm_side_pane_set_home_dir ()">fm_side_pane_set_home_dir</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="FmSidePane.html#fm-side-pane-set-mode" title="fm_side_pane_set_mode ()">fm_side_pane_set_mode</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="FmSidePane.html#fm-side-pane-set-popup-updater" title="fm_side_pane_set_popup_updater ()">fm_side_pane_set_popup_updater</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="FmSidePane.html#fm-side-pane-set-show-hidden" title="fm_side_pane_set_show_hidden ()">fm_side_pane_set_show_hidden</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmSidePane.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="FmSidePane.html#FmSidePane-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="FmSidePane.html#FmSidePane-mode-changed" title="The “mode-changed” signal">mode-changed</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="FmSidePane.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="FmSidePane.html#FmSidePane-struct" title="struct FmSidePane">FmSidePane</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmSidePane.html#FmSidePaneClass" title="struct FmSidePaneClass">FmSidePaneClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode">FmSidePaneMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmSidePane.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> <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</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html">GtkBox</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkVBox.html">GtkVBox</a>
<span class="lineart">╰──</span> FmSidePane
</pre>
</div>
<div class="refsect1">
<a name="FmSidePane.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
FmSidePane implements
AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="FmSidePane.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm-gtk.h</p>
<p>The <a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> widget displays side pane for fast navigation across
places.</p>
</div>
<div class="refsect1">
<a name="FmSidePane.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FmSidePaneUpdatePopup"></a><h3>FmSidePaneUpdatePopup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*FmSidePaneUpdatePopup<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkUIManager.html"><span class="type">GtkUIManager</span></a> *ui</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a> *act_grp</code></em>,
<em class="parameter"><code><a class="link" href="libfm-FmFileInfo.html#FmFileInfo" title="FmFileInfo"><span class="type">FmFileInfo</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>The callback to update popup menu. It can disable items of menu, add
some new, replace actions, etc. depending of the window and files.
In some cases <em class="parameter"><code>file</code></em>
may be incomplete so callback should check that.</p>
<div class="refsect3">
<a name="id-1.2.6.28.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>sp</p></td>
<td class="parameter_description"><p>the side pane widget</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ui</p></td>
<td class="parameter_description"><p>the object to add interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>act_grp</p></td>
<td class="parameter_description"><p>group of actions to add action</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>the file the popup menu was created for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>pointer passed to <a class="link" href="FmSidePane.html#fm-side-pane-set-popup-updater" title="fm_side_pane_set_popup_updater ()"><code class="function">fm_side_pane_set_popup_updater()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-chdir"></a><h3>fm_side_pane_chdir ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_side_pane_chdir (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</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>Changes active path in the side pane.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.3.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>sp</p></td>
<td class="parameter_description"><p>a widget to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>new path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-cwd"></a><h3>fm_side_pane_get_cwd ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="returnvalue">FmPath</span></a> *
fm_side_pane_get_cwd (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>);</pre>
<p>Retrieves current active path in the side pane. Returned data are
owned by side pane and should not be freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.4.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>sp</p></td>
<td class="parameter_description"><p>a widget to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.4.6"></a><h4>Returns</h4>
<p> active file path.</p>
</div>
<p class="since">Since: 0.1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-mode"></a><h3>fm_side_pane_get_mode ()</h3>
<pre class="programlisting"><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="returnvalue">FmSidePaneMode</span></a>
fm_side_pane_get_mode (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>);</pre>
<p>Retrieves side pane view mode.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.5.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>sp</p></td>
<td class="parameter_description"><p>a widget to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.5.6"></a><h4>Returns</h4>
<p> current view mode.</p>
</div>
<p class="since">Since: 0.1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-mode-by-name"></a><h3>fm_side_pane_get_mode_by_name ()</h3>
<pre class="programlisting"><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="returnvalue">FmSidePaneMode</span></a>
fm_side_pane_get_mode_by_name (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
<p>Finds mode which have an associated name equal to <em class="parameter"><code>str</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.6.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>str</p></td>
<td class="parameter_description"><p>the name of mode</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.6.6"></a><h4>Returns</h4>
<p> mode or FM_SP_NONE if <em class="parameter"><code>str</code></em>
specifies invalid mode.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-mode-label"></a><h3>fm_side_pane_get_mode_label ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
fm_side_pane_get_mode_label (<em class="parameter"><code><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="type">FmSidePaneMode</span></a> mode</code></em>);</pre>
<p>Retrieves label for <em class="parameter"><code>mode</code></em>
which can be used in menus. Returned
data should not be freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.28.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>mode</p></td>
<td class="parameter_description"><p>the view mode</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.7.6"></a><h4>Returns</h4>
<p> desription or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>mode</code></em>
is invalid.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-mode-name"></a><h3>fm_side_pane_get_mode_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
fm_side_pane_get_mode_name (<em class="parameter"><code><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="type">FmSidePaneMode</span></a> mode</code></em>);</pre>
<p>Retrieves the name of the specified side pane <em class="parameter"><code>mode</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>mode</code></em>
is invalid. The name of mode may be used for config save or another
similar purpose. Returned data are owned by implementation and should
be not freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.8.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>mode</p></td>
<td class="parameter_description"><p>mode to convert</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.8.6"></a><h4>Returns</h4>
<p> the name associated with <em class="parameter"><code>mode</code></em>
.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-mode-tooltip"></a><h3>fm_side_pane_get_mode_tooltip ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
fm_side_pane_get_mode_tooltip (<em class="parameter"><code><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="type">FmSidePaneMode</span></a> mode</code></em>);</pre>
<p>Retrieves tooltip for <em class="parameter"><code>mode</code></em>
which can be used in menus. Returned
data should not be freed by caller.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.9.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>mode</p></td>
<td class="parameter_description"><p>the view mode</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.9.6"></a><h4>Returns</h4>
<p> desription or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>mode</code></em>
is invalid.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-n-modes"></a><h3>fm_side_pane_get_n_modes ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
fm_side_pane_get_n_modes (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Tests how many view modes are known to create <a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> widget. The
returned value is the highest FmSidePaneMode that can be used due to
historical reasons since FmSidePaneMode equal to 0 is invalid.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.10.5"></a><h4>Returns</h4>
<p> number of known modes for side pane.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-get-title-bar"></a><h3>fm_side_pane_get_title_bar ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
fm_side_pane_get_title_bar (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>);</pre>
<p>Retrieves side pane title bar widget.</p>
<div class="refsect3">
<a name="id-1.2.6.28.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>sp</p></td>
<td class="parameter_description"><p>a widget to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.11.6"></a><h4>Returns</h4>
<p> pointer to title bar of side pane. </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.14</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-new"></a><h3>fm_side_pane_new ()</h3>
<pre class="programlisting"><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="returnvalue">FmSidePane</span></a> *
fm_side_pane_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates new side pane.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.12.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> widget. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-set-home-dir"></a><h3>fm_side_pane_set_home_dir ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_side_pane_set_home_dir (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *home_dir</code></em>);</pre>
<p>Changes path used by side pane view for "Home" items if view mode has
any such items.</p>
<div class="refsect3">
<a name="id-1.2.6.28.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>sp</p></td>
<td class="parameter_description"><p>a widget to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>home_dir</p></td>
<td class="parameter_description"><p>a new path to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.13.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 current side pane mode accepts this change.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-set-mode"></a><h3>fm_side_pane_set_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_side_pane_set_mode (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>,
<em class="parameter"><code><a class="link" href="FmSidePane.html#FmSidePaneMode" title="enum FmSidePaneMode"><span class="type">FmSidePaneMode</span></a> mode</code></em>);</pre>
<p>Changes side pane view mode.</p>
<div class="refsect3">
<a name="id-1.2.6.28.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>sp</p></td>
<td class="parameter_description"><p>a widget to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>new mode for the side pane</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-set-popup-updater"></a><h3>fm_side_pane_set_popup_updater ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_side_pane_set_popup_updater (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</code></em>,
<em class="parameter"><code><a class="link" href="FmSidePane.html#FmSidePaneUpdatePopup" title="FmSidePaneUpdatePopup ()"><span class="type">FmSidePaneUpdatePopup</span></a> update_popup</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Sets up the callback to update context menu on any item in the sidebar
widget.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.15.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>sp</p></td>
<td class="parameter_description"><p>a widget to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>update_popup</p></td>
<td class="parameter_description"><p> a callback to update popup. </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>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data supplied for callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-side-pane-set-show-hidden"></a><h3>fm_side_pane_set_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_side_pane_set_show_hidden (<em class="parameter"><code><a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *sp</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>
<p>Changes visibility of hidden files in side pane <em class="parameter"><code>sp</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.6.28.9.16.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>sp</p></td>
<td class="parameter_description"><p>a widget to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_hidden</p></td>
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show hidden files in side pane</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.28.9.16.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 current side pane mode accepts this change.</p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
</div>
<div class="refsect1">
<a name="FmSidePane.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmSidePane-struct"></a><h3>struct FmSidePane</h3>
<pre class="programlisting">struct FmSidePane;</pre>
</div>
<hr>
<div class="refsect2">
<a name="FmSidePaneClass"></a><h3>struct FmSidePaneClass</h3>
<pre class="programlisting">struct FmSidePaneClass {
GtkVBoxClass parent_class;
void (*chdir)(FmSidePane* sp, guint button, FmPath* path);
void (*mode_changed)(FmSidePane* sp);
};
</pre>
<div class="refsect3">
<a name="id-1.2.6.28.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><span class="type">GtkVBoxClass</span> <em class="structfield"><code><a name="FmSidePaneClass.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="FmSidePaneClass.chdir"></a>chdir</code></em> ()</p></td>
<td class="struct_member_description"><p>the class closure for the <a class="link" href="FmSidePane.html#FmSidePane-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="FmSidePaneClass.mode-changed"></a>mode_changed</code></em> ()</p></td>
<td class="struct_member_description"><p>the class closure for the <a class="link" href="FmSidePane.html#FmSidePane-mode-changed" title="The “mode-changed” signal"><span class="type">“mode-changed”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FmSidePaneMode"></a><h3>enum FmSidePaneMode</h3>
<p>Mode of side pane view.</p>
<div class="refsect3">
<a name="id-1.2.6.28.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-SP-NONE:CAPS"></a>FM_SP_NONE</p></td>
<td class="enum_member_description">
<p>invalid mode</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-SP-PLACES:CAPS"></a>FM_SP_PLACES</p></td>
<td class="enum_member_description">
<p><a class="link" href="FmPlacesView.html" title="FmPlacesView"><span class="type">FmPlacesView</span></a> mode</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-SP-DIR-TREE:CAPS"></a>FM_SP_DIR_TREE</p></td>
<td class="enum_member_description">
<p><a class="link" href="FmDirTreeView.html" title="FmDirTreeView"><span class="type">FmDirTreeView</span></a> mode</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-SP-REMOTE:CAPS"></a>FM_SP_REMOTE</p></td>
<td class="enum_member_description">
<p>reserved mode</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="FmSidePane.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="FmSidePane-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="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *pane,
<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="FmSidePane.html#FmSidePane-chdir" title="The “chdir” signal"><span class="type">“chdir”</span></a> signal is emitted when current selected
directory in the <em class="parameter"><code>pane</code></em>
is changed.</p>
<div class="refsect3">
<a name="id-1.2.6.28.11.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>pane</p></td>
<td class="parameter_description"><p>the widget which 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>the button path was activated with</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.12</p>
</div>
<hr>
<div class="refsect2">
<a name="FmSidePane-mode-changed"></a><h3>The <code class="literal">“mode-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="FmSidePane.html" title="FmSidePane"><span class="type">FmSidePane</span></a> *pane,
<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="FmSidePane.html#FmSidePane-mode-changed" title="The “mode-changed” signal"><span class="type">“mode-changed”</span></a> signal is emitted when view mode
in the pane is changed.</p>
<div class="refsect3">
<a name="id-1.2.6.28.11.3.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>pane</p></td>
<td class="parameter_description"><p>the widget which emitted the signal</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.12</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|