FmSidePane

FmSidePane — A widget for side pane displaying

Synopsis

struct              FmSidePane;
struct              FmSidePaneClass;
enum                FmSidePaneMode;
void                fm_side_pane_chdir                  (FmSidePane *sp,
                                                         FmPath *path);
FmPath *            fm_side_pane_get_cwd                (FmSidePane *sp);
FmSidePaneMode      fm_side_pane_get_mode               (FmSidePane *sp);
GtkWidget *         fm_side_pane_get_title_bar          (FmSidePane *sp);
FmSidePane *        fm_side_pane_new                    (void);
void                fm_side_pane_set_mode               (FmSidePane *sp,
                                                         FmSidePaneMode mode);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkVBox
                                 +----FmSidePane

Implemented Interfaces

FmSidePane implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Signals

  "chdir"                                          : Run Last
  "mode-changed"                                   : Run Last

Description

include: libfm/fm-side-pane.h

The FmSidePane widget displays side pane for fast navigation across places.

Details

struct FmSidePane

struct FmSidePane;

struct FmSidePaneClass

struct FmSidePaneClass {
    GtkVBoxClass parent_class;
    void (*chdir)(FmSidePane* sp, guint button, FmPath* path);
    void (*mode_changed)(FmSidePane* sp);
};

GtkVBoxClass parent_class;

the parent class

chdir ()

the class closure for the "chdir" signal

mode_changed ()

the class closure for the "mode-changed" signal

enum FmSidePaneMode

typedef enum {
    FM_SP_NONE,
    FM_SP_PLACES,
    FM_SP_DIR_TREE,
    FM_SP_REMOTE
} FmSidePaneMode;

Mode of side pane view.

FM_SP_NONE

invalid mode

FM_SP_PLACES

FmPlacesView mode

FM_SP_DIR_TREE

FmDirTreeView mode

FM_SP_REMOTE

reserved mode

fm_side_pane_chdir ()

void                fm_side_pane_chdir                  (FmSidePane *sp,
                                                         FmPath *path);

Changes active path in the side pane.

sp :

a widget to apply

path :

new path

Since 0.1.12


fm_side_pane_get_cwd ()

FmPath *            fm_side_pane_get_cwd                (FmSidePane *sp);

Retrieves current active path in the side pane. Returned data are owned by side pane and should not be freed by caller.

sp :

a widget to inspect

Returns :

active file path.

Since 0.1.12


fm_side_pane_get_mode ()

FmSidePaneMode      fm_side_pane_get_mode               (FmSidePane *sp);

Retrieves side pane view mode.

sp :

a widget to inspect

Returns :

current view mode.

Since 0.1.12


fm_side_pane_get_title_bar ()

GtkWidget *         fm_side_pane_get_title_bar          (FmSidePane *sp);

Retrieves side pane title bar widget.

sp :

a widget to inspect

Returns :

pointer to title bar of side pane. [transfer none]

Since 0.1.14


fm_side_pane_new ()

FmSidePane *        fm_side_pane_new                    (void);

Creates new side pane.

Returns :

a new FmSidePane widget. [transfer full]

Since 0.1.12


fm_side_pane_set_mode ()

void                fm_side_pane_set_mode               (FmSidePane *sp,
                                                         FmSidePaneMode mode);

Changes side pane view mode.

sp :

a widget to apply

mode :

new mode for the side pane

Since 0.1.12

Signal Details

The "chdir" signal

void                user_function                      (FmSidePane *pane,
                                                        guint       button,
                                                        gpointer    path,
                                                        gpointer    user_data)      : Run Last

The "chdir" signal is emitted when current selected directory in the pane is changed.

pane :

the widget which emitted the signal

button :

the button path was activated with

path :

(FmPath *) new directory path

user_data :

user data set when the signal handler was connected.

Since 0.1.12


The "mode-changed" signal

void                user_function                      (FmSidePane *pane,
                                                        gpointer    user_data)      : Run Last

The "mode-changed" signal is emitted when view mode in the pane is changed.

pane :

the widget which emitted the signal

user_data :

user data set when the signal handler was connected.

Since 0.1.12