## EphyStatusbar

EphyStatusbar — A statusbar widget for Epiphany

## Synopsis

                        EphyStatusbar;
    GtkWidget *         ephy_statusbar_new                  (void);
    GtkWidget *         ephy_statusbar_get_security_frame   (EphyStatusbar *statusbar);
    void                ephy_statusbar_set_caret_mode       (EphyStatusbar *statusbar,
                                                             gboolean enabled);
    void                ephy_statusbar_set_security_state   (EphyStatusbar *statusbar,
                                                             const char *stock_id,
                                                             const char *tooltip);
    void                ephy_statusbar_set_popups_state     (EphyStatusbar *statusbar,
                                                             gboolean hidden,
                                                             const char *tooltip);
    void                ephy_statusbar_add_widget           (EphyStatusbar *statusbar,
                                                             GtkWidget *widget);
    void                ephy_statusbar_remove_widget        (EphyStatusbar *statusbar,
                                                             GtkWidget *widget);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkHBox
                                           +----GtkStatusbar
                                                 +----EphyStatusbar

## Implemented Interfaces

EphyStatusbar implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Signals

      "lock-clicked"                                   : Run Last / Action

## Description

EphyStatusbar is Epiphany's default statusbar for all windows.

## Details

### EphyStatusbar

    typedef struct _EphyStatusbar EphyStatusbar;

### ephy_statusbar_new ()

    GtkWidget *         ephy_statusbar_new                  (void);

Creates a new EphyStatusbar.

Returns : | the new EphyStatusbar object

### ephy_statusbar_get_security_frame ()

    GtkWidget *         ephy_statusbar_get_security_frame   (EphyStatusbar *statusbar);

`statusbar` : | an EphyStatusbar
Returns : | the statusbar's lock icon frame. [transfer none]

### ephy_statusbar_set_caret_mode ()

    void                ephy_statusbar_set_caret_mode       (EphyStatusbar *statusbar,
                                                             gboolean enabled);

Sets the statusbar's caret browsing mode indicator.

`statusbar` : | an EphyStatusbar
`enabled` : | `TRUE` to show the caret browsing mode indicator

### ephy_statusbar_set_security_state ()

    void                ephy_statusbar_set_security_state   (EphyStatusbar *statusbar,
                                                             const char *stock_id,
                                                             const char *tooltip);

Sets the statusbar's security icon and its tooltip.

`statusbar` : | an EphyStatusbar
`stock_id` : | stock-id of the icon showing the security state
`tooltip` : | a string detailing the security state

### ephy_statusbar_set_popups_state ()

    void                ephy_statusbar_set_popups_state     (EphyStatusbar *statusbar,
                                                             gboolean hidden,
                                                             const char *tooltip);

Sets the statusbar's popup-blocker icon's tooltip and visibility.

`statusbar` : | an EphyStatusbar
`hidden` : | `TRUE` if popups have been hidden
`tooltip` : | a string to display as tooltip, or `NULL`

### ephy_statusbar_add_widget ()

    void                ephy_statusbar_add_widget           (EphyStatusbar *statusbar,
                                                             GtkWidget *widget);

Adds the `widget` to the statusbar. Use this function whenever you want to add a widget to the statusbar. You can remove the widget again with `ephy_statusbar_remove_widget()`.

`statusbar` : | an EphyStatusbar
`widget` : | a GtkWidget

### ephy_statusbar_remove_widget ()

    void                ephy_statusbar_remove_widget        (EphyStatusbar *statusbar,
                                                             GtkWidget *widget);

Removes `widget`, which must have been added to `statusbar` using `ephy_statusbar_add_widget()`.

`statusbar` : | an EphyStatusbar
`widget` : | a GtkWidget

## Signal Details

### The `"lock-clicked"` signal

    void                user_function                      (EphyStatusbar *statusbar,
                                                            gpointer       user_data)      : Run Last / Action

This signal corresponds to the user clicking on the lock icon on the `statusbar`.

`statusbar` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.