EmerillonSidebar

## EmerillonSidebar EmerillonSidebar |

## Synopsis

                        EmerillonSidebar;
                        EmerillonSidebarClass;
                        EmerillonSidebarPrivate;
    GtkWidget *         emerillon_sidebar_new               (void);
    void                emerillon_sidebar_add_page          (EmerillonSidebar *sidebar,
                                                             const gchar *title,
                                                             GtkWidget *main_widget);
    void                emerillon_sidebar_remove_page       (EmerillonSidebar *sidebar,
                                                             GtkWidget *main_widget);
    void                emerillon_sidebar_set_page          (EmerillonSidebar *sidebar,
                                                             GtkWidget *main_widget);
    gint                emerillon_sidebar_get_n_pages       (EmerillonSidebar *sidebar);
    gboolean            emerillon_sidebar_is_empty          (EmerillonSidebar *sidebar);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkVBox
                                           +----EmerillonSidebar

## Implemented Interfaces

EmerillonSidebar implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Properties

      "current-page"             GtkWidget*            : Read / Write

## Signals

      "page-added"                                     : Run First
      "page-removed"                                   : Run First

## Description

## Details

### EmerillonSidebar

    typedef struct _EmerillonSidebar EmerillonSidebar;

### EmerillonSidebarClass

    typedef struct {
      GtkVBoxClass base_class;

      void (* page_added)   (EmerillonSidebar *sidebar,
                             GtkWidget *main_widget);

      void (* page_removed) (EmerillonSidebar *sidebar,
                             GtkWidget *main_widget);
    } EmerillonSidebarClass;

### EmerillonSidebarPrivate

    typedef struct _EmerillonSidebarPrivate EmerillonSidebarPrivate;

### emerillon_sidebar_new ()

    GtkWidget *         emerillon_sidebar_new               (void);

### emerillon_sidebar_add_page ()

    void                emerillon_sidebar_add_page          (EmerillonSidebar *sidebar,
                                                             const gchar *title,
                                                             GtkWidget *main_widget);

Adds a new page to the sidebar

See: `emerillon_window_get_sidebar()`

`sidebar` : | An EmerillonSidebar instance. [in]
`title` : | Sidebar title. [in]
`main_widget` : | A GtkWidget which should be embedded in the sidebar. [in]

### emerillon_sidebar_remove_page ()

    void                emerillon_sidebar_remove_page       (EmerillonSidebar *sidebar,
                                                             GtkWidget *main_widget);

### emerillon_sidebar_set_page ()

    void                emerillon_sidebar_set_page          (EmerillonSidebar *sidebar,
                                                             GtkWidget *main_widget);

### emerillon_sidebar_get_n_pages ()

    gint                emerillon_sidebar_get_n_pages       (EmerillonSidebar *sidebar);

Returns the number of pages `sidebar` has.

`sidebar` : | An EmerillonSidebar instance. [in]
Returns : | The number of pages `sidebar` has. If `sidebar` isn't an EmerillonSidebar instance this function returns TRUE.

### emerillon_sidebar_is_empty ()

    gboolean            emerillon_sidebar_is_empty          (EmerillonSidebar *sidebar);

Checks if the `sidebar` is empty

`sidebar` : | An EmerillonSidebar instance. [in]
Returns : | TRUE if `sidebar` has no pages or isn't an EmerillonSidebar instance

## Property Details

### The `"current-page"` property

      "current-page"             GtkWidget*            : Read / Write

The currently visible page.

## Signal Details

### The `"page-added"` signal

    void                user_function                      (EmerillonSidebar *emerillonsidebar,
                                                            GtkWidget        *widget,
                                                            gpointer          user_data)             : Run First

### The `"page-removed"` signal

    void                user_function                      (EmerillonSidebar *emerillonsidebar,
                                                            GtkWidget        *widget,
                                                            gpointer          user_data)             : Run First