path: root/embed/ephy-web-view.h

/*
 *  Copyright © 2008 Gustavo Noronha Silva
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  $Id$
 */

#if !defined (__EPHY_EPIPHANY_H_INSIDE__) && !defined (EPIPHANY_COMPILATION)
#error "Only <epiphany/epiphany.h> can be included directly."
#endif

#ifndef EPHY_WEB_VIEW_H
#define EPHY_WEB_VIEW_H

#include <glib-object.h>
#include <glib.h>
#include <gtk/gtk.h>
#include <webkit/webkit.h>

#include "ephy-embed-event.h"

G_BEGIN_DECLS

#define EPHY_TYPE_WEB_VIEW         (ephy_web_view_get_type ())
#define EPHY_WEB_VIEW(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EPHY_TYPE_WEB_VIEW, EphyWebView))
#define EPHY_WEB_VIEW_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EPHY_TYPE_WEB_VIEW, EphyWebViewClass))
#define EPHY_IS_WEB_VIEW(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EPHY_TYPE_WEB_VIEW))
#define EPHY_IS_WEB_VIEW_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EPHY_TYPE_WEB_VIEW))
#define EPHY_WEB_VIEW_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EPHY_TYPE_WEB_VIEW, EphyWebViewClass))

typedef struct _EphyWebViewClass  EphyWebViewClass;
typedef struct _EphyWebView    EphyWebView;
typedef struct _EphyWebViewPrivate  EphyWebViewPrivate;

typedef enum
{
    EPHY_WEB_VIEW_NAV_UP    = 1 << 0,
    EPHY_WEB_VIEW_NAV_BACK  = 1 << 1,
    EPHY_WEB_VIEW_NAV_FORWARD   = 1 << 2
} EphyWebViewNavigationFlags;

typedef enum
{
    EPHY_WEB_VIEW_STATE_UNKNOWN = 0,
    EPHY_WEB_VIEW_STATE_START       = 1 << 0,
    EPHY_WEB_VIEW_STATE_REDIRECTING = 1 << 1,
    EPHY_WEB_VIEW_STATE_TRANSFERRING    = 1 << 2,
    EPHY_WEB_VIEW_STATE_NEGOTIATING = 1 << 3,
    EPHY_WEB_VIEW_STATE_STOP        = 1 << 4,

    EPHY_WEB_VIEW_STATE_IS_REQUEST  = 1 << 5,
    EPHY_WEB_VIEW_STATE_IS_DOCUMENT = 1 << 6,
    EPHY_WEB_VIEW_STATE_IS_NETWORK  = 1 << 7,
    EPHY_WEB_VIEW_STATE_IS_WINDOW   = 1 << 8,
    EPHY_WEB_VIEW_STATE_RESTORING   = 1 << 9
} EphyWebViewNetState;

typedef enum
{
    EPHY_WEB_VIEW_CHROME_MENUBAR    = 1 << 0,
    EPHY_WEB_VIEW_CHROME_TOOLBAR    = 1 << 1,
    EPHY_WEB_VIEW_CHROME_STATUSBAR  = 1 << 2,
    EPHY_WEB_VIEW_CHROME_BOOKMARKSBAR   = 1 << 3
} EphyWebViewChrome;

#define EPHY_WEB_VIEW_CHROME_ALL (EPHY_WEB_VIEW_CHROME_MENUBAR |    \
                   EPHY_WEB_VIEW_CHROME_TOOLBAR |   \
                   EPHY_WEB_VIEW_CHROME_STATUSBAR | \
                   EPHY_WEB_VIEW_CHROME_BOOKMARKSBAR)

typedef enum
{
    EPHY_WEB_VIEW_PRINTPREVIEW_GOTO_PAGENUM = 0,
    EPHY_WEB_VIEW_PRINTPREVIEW_PREV_PAGE    = 1,
    EPHY_WEB_VIEW_PRINTPREVIEW_NEXT_PAGE    = 2,
    EPHY_WEB_VIEW_PRINTPREVIEW_HOME     = 3,
    EPHY_WEB_VIEW_PRINTPREVIEW_END      = 4
} EphyWebViewPrintPreviewNavType;

typedef enum
{
    EPHY_WEB_VIEW_STATE_IS_UNKNOWN,
    EPHY_WEB_VIEW_STATE_IS_INSECURE,
    EPHY_WEB_VIEW_STATE_IS_BROKEN,
    EPHY_WEB_VIEW_STATE_IS_SECURE_LOW,
    EPHY_WEB_VIEW_STATE_IS_SECURE_MED,
    EPHY_WEB_VIEW_STATE_IS_SECURE_HIGH
} EphyWebViewSecurityLevel;

typedef enum
{
    EPHY_WEB_VIEW_DOCUMENT_HTML,
    EPHY_WEB_VIEW_DOCUMENT_XML,
    EPHY_WEB_VIEW_DOCUMENT_IMAGE,
    EPHY_WEB_VIEW_DOCUMENT_OTHER
} EphyWebViewDocumentType;

typedef enum
{
    EPHY_WEB_VIEW_ADDRESS_EXPIRE_NOW,
    EPHY_WEB_VIEW_ADDRESS_EXPIRE_NEXT,
    EPHY_WEB_VIEW_ADDRESS_EXPIRE_CURRENT
} EphyWebViewAddressExpire;

struct _EphyWebView
{
  WebKitWebView parent;

  /*< private >*/
  EphyWebViewPrivate *priv;
};

struct _EphyWebViewClass
{
  WebKitWebViewClass parent_class;

  /* Signals */
  int    (* context_menu)   (EphyWebView *view,
                                 EphyEmbedEvent *event);
  void   (* favicon)        (EphyWebView *view,
                                 const char *location);
  void   (* feed_link)      (EphyWebView *view,
                                 const char *type,
                                 const char *title,
                                 const char *address);
  void   (* search_link)    (EphyWebView *view,
                                 const char *type,
                                 const char *title,
                                 const char *address);
  gboolean (* dom_mouse_click)  (EphyWebView *view,
                                 EphyEmbedEvent *event);
  gboolean (* dom_mouse_down)   (EphyWebView *view,
                                 EphyEmbedEvent *event);
  void   (* dom_content_loaded) (EphyWebView *view,
                                 gpointer event);
  void   (* popup_blocked)  (EphyWebView *view,
                                 const char *address,
                                 const char *target,
                                 const char *features);
  void   (* content_blocked)    (EphyWebView *view,
                                 const char *uri);
  gboolean (* modal_alert)  (EphyWebView *view);
  void   (* modal_alert_closed) (EphyWebView *view);
  void   (* document_type)  (EphyWebView *view,
                                 EphyWebViewDocumentType type);
  void   (* new_window)     (EphyWebView *view,
                                 EphyWebView *new_view);
  gboolean (* search_key_press) (EphyWebView *view,
                                 GdkEventKey *event);
  gboolean (* close_request)    (EphyWebView *view);

  void   (* new_document_now)   (EphyWebView *view,
                                 const char *uri);
};

GType                      ephy_web_view_get_type                (void);
GType                      ephy_web_view_net_state_get_type      (void);
GType                      ephy_web_view_chrome_get_type         (void);
GType                      ephy_web_view_security_level_get_type (void);
GtkWidget *                ephy_web_view_new                     (void);
void                       ephy_web_view_load_request            (EphyWebView                     *view,
                                                                  WebKitNetworkRequest            *request);
void                       ephy_web_view_load_url                (EphyWebView                     *view,
                                                                  const char                      *url);
void                       ephy_web_view_copy_back_history       (EphyWebView                     *source,
                                                                  EphyWebView                     *dest);
gboolean                   ephy_web_view_get_load_status         (EphyWebView                     *view);
const char *               ephy_web_view_get_loading_title       (EphyWebView                     *view);
GdkPixbuf *                ephy_web_view_get_icon                (EphyWebView                     *view);
EphyWebViewDocumentType    ephy_web_view_get_document_type       (EphyWebView                     *view);
EphyWebViewNavigationFlags ephy_web_view_get_navigation_flags    (EphyWebView                     *view);
const char *               ephy_web_view_get_status_message      (EphyWebView                     *view);
const char *               ephy_web_view_get_link_message        (EphyWebView                     *view);
gboolean                   ephy_web_view_get_visibility          (EphyWebView                     *view);
void                       ephy_web_view_set_link_message        (EphyWebView                     *view,
                                                                  char                            *link_message);
void                       ephy_web_view_load_icon               (EphyWebView                     *view);
void                       ephy_web_view_load_icon               (EphyWebView                     *view);
void                       ephy_web_view_set_security_level      (EphyWebView                     *view,
                                                                  EphyWebViewSecurityLevel         level);
void                       ephy_web_view_set_visibility          (EphyWebView                     *view,
                                                                  gboolean                         visibility);
const char *               ephy_web_view_get_typed_address       (EphyWebView                     *view);
void                       ephy_web_view_set_typed_address       (EphyWebView                     *view,
                                                                  const char                      *address,
                                                                  EphyWebViewAddressExpire         expire);
gboolean                   ephy_web_view_get_is_blank            (EphyWebView                     *view);
gboolean                   ephy_web_view_has_modified_forms      (EphyWebView                     *view);
char *                     ephy_web_view_get_location            (EphyWebView                     *view,
                                                                  gboolean                         toplevel);
void                       ephy_web_view_go_up                   (EphyWebView                     *view);
char *                     ephy_web_view_get_js_status           (EphyWebView                     *view);
void                       ephy_web_view_get_security_level      (EphyWebView                     *view,
                                                                  EphyWebViewSecurityLevel        *level,
                                                                  char                           **description);
void                       ephy_web_view_show_page_certificate   (EphyWebView                     *view);
void                       ephy_web_view_set_print_preview_mode  (EphyWebView                     *view,
                                                                  gboolean                         preview_mode);
int                        ephy_web_view_print_preview_n_pages   (EphyWebView                     *view);
void                       ephy_web_view_print_preview_navigate  (EphyWebView                     *view,
                                                                  EphyWebViewPrintPreviewNavType   type,
                                                                  int                              page);
GSList *                   ephy_web_view_get_go_up_list          (EphyWebView                     *view);
void                       ephy_web_view_set_title               (EphyWebView                     *view,
                                                                  const char                      *view_title);
const char *               ephy_web_view_get_icon_address        (EphyWebView                     *view);
const char *               ephy_web_view_get_title               (EphyWebView                     *view);
gboolean                   ephy_web_view_can_go_up               (EphyWebView                     *view);
const char *               ephy_web_view_get_address             (EphyWebView                     *view);
const char *               ephy_web_view_get_title_composite     (EphyWebView                     *view);

/* These should be private */
void                       ephy_web_view_set_address             (EphyWebView                     *embed,
                                                                  const char                      *address);
void                       ephy_web_view_set_icon_address        (EphyWebView                     *view,
                                                                  const char                      *address);
void                       ephy_web_view_update_from_net_state   (EphyWebView                     *view,
                                                                  const char                      *uri,
                                                                  EphyWebViewNetState              state);
void                       ephy_web_view_location_changed        (EphyWebView                     *view,
                                                                  const char                      *location);
void                       ephy_web_view_set_loading_title       (EphyWebView                     *view,
                                                                  const char                      *title,
                                                                  gboolean                         is_address);
void                       ephy_web_view_popups_manager_reset    (EphyWebView                     *view);


G_END_DECLS

#endif