EphyToolbar

## EphyToolbar EphyToolbar — Epiphany's toolbar widget |

## Synopsis

                        EphyToolbar;
    EphyToolbar *       ephy_toolbar_new                    (EphyWindow *window);
    GtkActionGroup *    ephy_toolbar_get_action_group       (EphyToolbar *toolbar);
    void                ephy_toolbar_set_favicon            (EphyToolbar *toolbar,
                                                             GdkPixbuf *icon);
    void                ephy_toolbar_set_show_leave_fullscreen
                                                            (EphyToolbar *toolbar,
                                                             gboolean show);
    void                ephy_toolbar_activate_location      (EphyToolbar *toolbar);
    const char *        ephy_toolbar_get_location           (EphyToolbar *toolbar);
    void                ephy_toolbar_set_location           (EphyToolbar *toolbar,
                                                             const char *address);
    void                ephy_toolbar_set_navigation_actions (EphyToolbar *toolbar,
                                                             gboolean back,
                                                             gboolean forward,
                                                             gboolean up);
    void                ephy_toolbar_set_navigation_tooltips
                                                            (EphyToolbar *toolbar,
                                                             const char *back_title,
                                                             const char *forward_title);
    void                ephy_toolbar_set_security_state     (EphyToolbar *toolbar,
                                                             gboolean is_secure,
                                                             gboolean show_lock,
                                                             const char *stock_id,
                                                             const char *tooltip);
    void                ephy_toolbar_set_spinning           (EphyToolbar *toolbar,
                                                             gboolean spinning);
    void                ephy_toolbar_set_zoom               (EphyToolbar *toolbar,
                                                             gboolean can_zoom,
                                                             float zoom);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkVBox
                                           +----EggEditableToolbar
                                                 +----EphyToolbar

## Implemented Interfaces

EphyToolbar implements AtkImplementorIface, GtkBuildable, GtkOrientable and EphyLink.

## Properties

      "window"                   EphyWindow*           : Write / Construct Only

## Signals

      "activation-finished"                            : Run First
      "exit-clicked"                                   : Run First
      "lock-clicked"                                   : Run First

## Description

EphyToolbar is a customized EggEditableToolbar.

## Details

### EphyToolbar

    typedef struct _EphyToolbar EphyToolbar;

### ephy_toolbar_new ()

    EphyToolbar *       ephy_toolbar_new                    (EphyWindow *window);

Creates a new EphyToolbar and associates it with `window`.

`window` : | parent window for the toolbar
Returns : | a new EphyToolbar

### ephy_toolbar_get_action_group ()

    GtkActionGroup *    ephy_toolbar_get_action_group       (EphyToolbar *toolbar);

Gets the GtkActionGroup for `toolbar`.

`toolbar` : | an EphyToolbar widget
Returns : | . [transfer none]

### ephy_toolbar_set_favicon ()

    void                ephy_toolbar_set_favicon            (EphyToolbar *toolbar,
                                                             GdkPixbuf *icon);

Sets `icon` to be the favicon of `toolbar`'s internal EphyLocationEntry.

`toolbar` : | an EphyToolbar widget
`icon` : | a GdkPixbuf icon

### ephy_toolbar_set_show_leave_fullscreen ()

    void                ephy_toolbar_set_show_leave_fullscreen
                                                            (EphyToolbar *toolbar,
                                                             gboolean show);

Tells `toolbar` if it should show the leave fullscreen button or not.

`toolbar` : | an EphyToolbar widget
`show` : | `TRUE` to show the leave fullscreen button

### ephy_toolbar_activate_location ()

    void                ephy_toolbar_activate_location      (EphyToolbar *toolbar);

Calls ephy_location_entry_activate on `toolbar`'s internal EphyLocationEntry.

`toolbar` : | an EphyToolbar widget

### ephy_toolbar_get_location ()

    const char *        ephy_toolbar_get_location           (EphyToolbar *toolbar);

Gets the current address according to `toolbar`'s EphyLocationAction.

`toolbar` : | an EphyToolbar widget
Returns : | current `toolbar` address

### ephy_toolbar_set_location ()

    void                ephy_toolbar_set_location           (EphyToolbar *toolbar,
                                                             const char *address);

Sets the internal EphyLocationAction address to `address`.

`toolbar` : | an EphyToolbar widget
`address` : | new address

### ephy_toolbar_set_navigation_actions ()

    void                ephy_toolbar_set_navigation_actions (EphyToolbar *toolbar,
                                                             gboolean back,
                                                             gboolean forward,
                                                             gboolean up);

Sets the sensivity of navigation buttons in the `toolbar`.

`toolbar` : | an EphyToolbar widget
`back` : | `TRUE` if possible to go backward
`forward` : | `TRUE` if possible to go forward
`up` : | `TRUE` if possible to go up

### ephy_toolbar_set_navigation_tooltips ()

    void                ephy_toolbar_set_navigation_tooltips
                                                            (EphyToolbar *toolbar,
                                                             const char *back_title,
                                                             const char *forward_title);

Sets the titles of back and forward pages as the tooltips of its corresponding navigation buttons.

`toolbar` : | an EphyToolbar widget
`back_title` : | text for back button tooltip
`forward_title` : | text for forward button tooltip

### ephy_toolbar_set_security_state ()

    void                ephy_toolbar_set_security_state     (EphyToolbar *toolbar,
                                                             gboolean is_secure,
                                                             gboolean show_lock,
                                                             const char *stock_id,
                                                             const char *tooltip);

Sets properties on the lock icon inside the internal EphyLocationEntry.

`toolbar` : | an EphyToolbar widget
`is_secure` : | `TRUE` if the page is loaded over a secure connection
`show_lock` : | `TRUE` to show the lock icon in the location entry
`stock_id` : | stock-id to be used as the lock icon
`tooltip` : | tooltip for the lock icon

### ephy_toolbar_set_spinning ()

    void                ephy_toolbar_set_spinning           (EphyToolbar *toolbar,
                                                             gboolean spinning);

Controls the internal EphySpinner activity.

`toolbar` : | an EphyToolbar widget
`spinning` : | `TRUE` to set the internal EphySpinner as active

### ephy_toolbar_set_zoom ()

    void                ephy_toolbar_set_zoom               (EphyToolbar *toolbar,
                                                             gboolean can_zoom,
                                                             float zoom);

Sets the zoom level to `zoom`, but only if `can_zoom` is `TRUE`.

`toolbar` : | an EphyToolbar widget
`can_zoom` : | `TRUE` if the current EphyWebView can zoom
`zoom` : | new zoom level

## Property Details

### The `"window"` property

      "window"                   EphyWindow*           : Write / Construct Only

Parent window of the toolbar.

## Signal Details

### The `"activation-finished"` signal

    void                user_function                      (EphyToolbar *toolbar,
                                                            gpointer     user_data)      : Run First

Emitted when the user clicks on the security icon of the internal EphyLocationEntry.

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

### The `"exit-clicked"` signal

    void                user_function                      (EphyToolbar *toolbar,
                                                            gpointer     user_data)      : Run First

Emitted when the user clicks on the security icon of the internal EphyLocationEntry.

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

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

    void                user_function                      (EphyToolbar *toolbar,
                                                            gpointer     user_data)      : Run First

Emitted when the user clicks on the security icon of the internal EphyLocationEntry.

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