EphyTab

## EphyTab EphyTab — Represents an Epiphany tab |

## Synopsis

                EphyTab;
    EphyTab*    ephy_tab_new                    (void);
    EphyEmbed*  ephy_tab_get_embed              (EphyTab *tab);
    EphyTab*    ephy_tab_for_embed              (EphyEmbed *embed);
    const char* ephy_tab_get_icon_address       (EphyTab *tab);
    const char* ephy_tab_get_location           (EphyTab *tab);
    EphyEmbedSecurityLevel ephy_tab_get_security_level
                                                (EphyTab *tab);
    const char* ephy_tab_get_title              (EphyTab *tab);
    float       ephy_tab_get_zoom               (EphyTab *tab);
    gboolean    ephy_tab_get_load_status        (EphyTab *tab);
    int         ephy_tab_get_load_percent       (EphyTab *tab);
    const char* ephy_tab_get_link_message       (EphyTab *tab);
    const char* ephy_tab_get_status_message     (EphyTab *tab);

## Object Hierarchy

      GObject
       +----GtkObject
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBin
                               +----EphyTab

## Implemented Interfaces

EphyTab implements AtkImplementorIface and EphyLink.

## Properties

      "address"              gchararray            : Read / Write
      "document-type"        EphyEmbedDocumentType  : Read
      "hidden-popup-count"   gint                  : Read
      "icon"                 gchararray            : Read
      "load-progress"        gint                  : Read
      "load-status"          gboolean              : Read
      "message"              gchararray            : Read
      "navigation"           EphyTabNavigationFlags  : Read
      "popups-allowed"       gboolean              : Read / Write
      "security-level"       EphyEmbedSecurityLevel  : Read
      "title"                gchararray            : Read
      "visibility"           gboolean              : Read
      "zoom"                 gfloat                : Read

## Description

Each EphyWindow contains a GtkNotebook which holds one or more EphyTab:s. An EphyTab is basically a container for an EphyEmbed.

To retrieve an EphyTab's parent EphyWindow, use `gtk_widget_get_toplevel()`.

## Details

### EphyTab

    typedef struct _EphyTab EphyTab;

### ephy_tab_new ()

    EphyTab*    ephy_tab_new                    (void);

Equivalent to `g_object_new()`, but returns an EphyTab so you don't have to cast it.

Returns : | a new EphyTab

### ephy_tab_get_embed ()

    EphyEmbed*  ephy_tab_get_embed              (EphyTab *tab);

Returns `tab`'s EphyEmbed.

`tab` : | an EphyTab
Returns : | `tab`'s EphyEmbed

### ephy_tab_for_embed ()

    EphyTab*    ephy_tab_for_embed              (EphyEmbed *embed);

Returns the EphyTab which holds `embed`.

`embed` : | an EphyEmbed
Returns : | the EphyTab which holds `embed`

### ephy_tab_get_icon_address ()

    const char* ephy_tab_get_icon_address       (EphyTab *tab);

Returns a URL which points to `tab`'s favicon.

`tab` : | an EphyTab
Returns : | a URL to `tab`'s favicon

### ephy_tab_get_location ()

    const char* ephy_tab_get_location           (EphyTab *tab);

Returns the text that `tab`'s EphyWindow will display in its location toolbar entry when `tab` is selected.

This is not guaranteed to be the same as `tab`'s EphyEmbed's location, available through `ephy_embed_get_location()`. As the user types a new address into the location entry, `ephy_tab_get_location()`'s returned string will change.

`tab` : | an EphyTab
Returns : | `tab`'s EphyWindow's location entry when `tab` is selected

### ephy_tab_get_security_level ()

    EphyEmbedSecurityLevel ephy_tab_get_security_level
                                                (EphyTab *tab);

Returns the security level of the webpage loaded in `tab`.

`tab` : | an EphyTab
Returns : | `tab`'s loaded page's security level

### ephy_tab_get_title ()

    const char* ephy_tab_get_title              (EphyTab *tab);

Returns the title of the web page loaded in `tab`.

`tab` : | an EphyTab
Returns : | `tab`'s loaded web page's title

### ephy_tab_get_zoom ()

    float       ephy_tab_get_zoom               (EphyTab *tab);

Returns the zoom level of the web page loaded in `tab`. A return value of 1.0 corresponds to 100% zoom (normal size).

`tab` : | an EphyTab
Returns : | `tab`'s loaded page's zoom level

### ephy_tab_get_load_status ()

    gboolean    ephy_tab_get_load_status        (EphyTab *tab);

Returns whether the web page in `tab` has finished loading. A web page is only finished loading after all images, styles, and other dependencies have been downloaded and rendered.

`tab` : | an EphyTab
Returns : | `TRUE` if the page is still loading, `FALSE` if complete

### ephy_tab_get_load_percent ()

    int         ephy_tab_get_load_percent       (EphyTab *tab);

Returns the page load percentage (displayed in the progressbar).

`tab` : | an EphyTab
Returns : | a percentage from 0 to 100.

### ephy_tab_get_link_message ()

    const char* ephy_tab_get_link_message       (EphyTab *tab);

Returns the message displayed in `tab`'s EphyWindow's EphyStatusbar when the user hovers the mouse over a hyperlink.

The message returned has a limited lifetime, and so should be copied with `g_strdup()` if it must be stored.

Listen to the "link_message" signal on the `tab`'s EphyEmbed to be notified when the link message changes.

`tab` : | an EphyTab
Returns : | The current link statusbar message

### ephy_tab_get_status_message ()

    const char* ephy_tab_get_status_message     (EphyTab *tab);

Returns the message displayed in `tab`'s EphyWindow's EphyStatusbar. If the user is hovering the mouse over a hyperlink, this function will return the same value as `ephy_tab_get_link_message()`. Otherwise, it will return a network status message, or NULL.

The message returned has a limited lifetime, and so should be copied with `g_strdup()` if it must be stored.

Listen to "notify::message" to be notified when the message property changes.

`tab` : | an EphyTab
Returns : | The current statusbar message

## Properties

### The "`address`" property

      "address"              gchararray            : Read / Write

The tab's address.

Default value: ""

### The "`document-type`" property

      "document-type"        EphyEmbedDocumentType  : Read

The tab's documen type.

Default value: EPHY_EMBED_DOCUMENT_HTML

### The "`hidden-popup-count`" property

      "hidden-popup-count"   gint                  : Read

The tab's number of blocked popup windows.

Allowed values: >= 0

Default value: 0

### The "`icon`" property

      "icon"                 gchararray            : Read

The tab icon's address.

Default value: NULL

### The "`load-progress`" property

      "load-progress"        gint                  : Read

The tab's load progress in percent.

Allowed values: [0,100]

Default value: 0

### The "`load-status`" property

      "load-status"          gboolean              : Read

The tab's load status.

Default value: FALSE

### The "`message`" property

      "message"              gchararray            : Read

The tab's statusbar message.

Default value: NULL

### The "`navigation`" property

      "navigation"           EphyTabNavigationFlags  : Read

The tab's navigation flags.

### The "`popups-allowed`" property

      "popups-allowed"       gboolean              : Read / Write

Whether popup windows are to be displayed.

Default value: FALSE

### The "`security-level`" property

      "security-level"       EphyEmbedSecurityLevel  : Read

The tab's security level.

Default value: EPHY_EMBED_STATE_IS_UNKNOWN

### The "`title`" property

      "title"                gchararray            : Read

The tab's title.

Default value: "Blank page"

### The "`visibility`" property

      "visibility"           gboolean              : Read

The tab's visibility.

Default value: TRUE

### The "`zoom`" property

      "zoom"                 gfloat                : Read

The tab's zoom.

Allowed values: [0.707107,4]

Default value: 1