browser-eal/include/gwebengine.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the EAL package.
 *
 * The Initial Developer of the Original Code is Nokia Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2005
 * the Initial Developer. All Rights Reserved.
 *
 * Contact: Leonid Zolotarev <leonid.zolotarev@nokia.com>
 *
 * ***** END LICENSE BLOCK ***** */

#include <glib-object.h>
#include "gwebwidget.h"
#include "gwebhistorylist.h"

#ifndef __GWEBENGINE_H__
#define __GWEBENGINE_H__

G_BEGIN_DECLS

typedef enum
{
        G_WEBENGINE_NO_SECURITY = 0,
        G_WEBENGINE_LOW_SECURITY,
        G_WEBENGINE_MEDIUM_SECURITY,
        G_WEBENGINE_HIGH_SECURITY,
        G_WEBENGINE_UNKNOWN_SECURITY
} GWebEngineSecurityMode;

typedef enum
{
        G_WEBENGINE_POPUPMENU_NOTYPE         = 0x0000,
        G_WEBENGINE_POPUPMENU_DOCUMENT       = 0x0001,
        G_WEBENGINE_POPUPMENU_LINK           = 0x0002,
        G_WEBENGINE_POPUPMENU_IMAGE          = 0x0004,
        G_WEBENGINE_POPUPMENU_TEXTSELECTION  = 0x0008,
        G_WEBENGINE_POPUPMENU_MAILTO         = 0x0010,
        G_WEBENGINE_POPUPMENU_IFRAME         = 0x0020,
        G_WEBENGINE_POPUPMENU_UNKNOWN_PROTOCOL = 0x0040
} GWebEnginePopupMenuType;

typedef enum
{
        G_WEBENGINE_LOADING_FINISH_SUCCESS,
        G_WEBENGINE_LOADING_FINISH_COULDNT_CONNECT,
        G_WEBENGINE_LOADING_FINISH_UNKNOWN
}  GWebEngineLoadingFinishStatus;


typedef enum
{
        G_WEBENGINE_AUTHENTICATE = 0,
        G_WEBENGINE_AUTHENTICATION_WRONG,
        G_WEBENGINE_PROXY_AUTHENTICATE,
        G_WEBENGINE_PROXY_AUTHENTICATION_WRONG
} GWebEngineAuthenticationType;

#define G_TYPE_WEB_ENGINE             (g_web_engine_get_type ())
#define G_WEB_ENGINE(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_WEB_ENGINE, GWebEngine))
#define G_WEB_ENGINE_CLASS(vtable)    (G_TYPE_CHECK_CLASS_CAST ((vtable), G_TYPE_WEB_ENGINE, GWebEngineIface))
#define G_IS_WEB_ENGINE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_WEB_ENGINE))
#define G_IS_WEB_ENGINE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), G_TYPE_WEB_ENGINE))
#define G_WEB_ENGINE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_WEB_ENGINE, GWebEngineIface))

typedef struct _GWebEngine GWebEngine; /* dummy object */
typedef struct _GWebEngineIface GWebEngineIface;

struct _GWebEngineIface {
        GTypeInterface parent;

        void (*destroy) (GWebEngine *self);
        void (*reset) (GWebEngine *self);
        void (*load_url) (GWebEngine *self, const gchar *url); 
        GWebStatus (*load_follow_link) (GWebEngine *self, const gchar *url); 
        GWebStatus (*load_url_with_css) (GWebEngine *self, const gchar *url, const gchar *cssfile);
        void (*load_url_with_js) (GWebEngine *self, gboolean  enable);
        void (*load_home_page) (GWebEngine *self); 
        void (*stop_load) (GWebEngine *self);
        void (*reload) (GWebEngine *self); 
        void (*go_back) (GWebEngine *self, guint nsteps);
        void (*go_forward) (GWebEngine *self, guint nsteps); 
        gboolean (*can_go_back) (GWebEngine *self);
        gboolean (*can_go_forward) (GWebEngine *self);
        void (*set_zoom_level) (GWebEngine *self, gint level);
        void (*zoom_by_steps) (GWebEngine *self, guint relative_zoom, guint* legal_zoom_value);
        void (*new_zoom_by_steps) (GWebEngine *self, gboolean up, guint* legal_zoom_value);
        GWebStatus (*set_zoom_level_around_point) (GWebEngine *self, guint x, guint y, gint level);
        GWebStatus (*compare_frames_zoom_level) (GWebEngine *self, gboolean *equal);
        GWebStatus (*get_image_properties) (GWebEngine *self, const gchar *url, gchar **file_type, guint *file_size, guint *width, guint *height);
        GWebStatus (*get_frame_properties) (GWebEngine *self, gchar **file_type, guint *file_size, GWebEngineEncoding *file_encoding, guint *security, gboolean *automatic_encoding);
        GWebStatus (*load_image) (GWebEngine *self, const gchar* url);
        gint (*get_back_window_history_list) (GWebEngine *self, GWebHistoryList **history);
        gint (*get_forward_window_history_list) (GWebEngine *self, GWebHistoryList **history);
        guint (*get_zoom_level) (GWebEngine *self);
        void (*set_frame_zoom_level) (GWebEngine *self, guint level);
        guint (*get_frame_zoom_level) (GWebEngine *self);
        void (*set_layout_mode) (GWebEngine *self, GWebEngineLayoutMode mode);
        GWebEngineLayoutMode (*get_layout_mode) (GWebEngine *self);
        void (*set_load_images) (GWebEngine *self, GWebEngineImagePolicy level);
        GWebEngineImagePolicy (*get_load_images) (GWebEngine *self); 
        void (*set_frame_stacking) (GWebEngine *self, gboolean enabled);
        gboolean (*get_frame_stacking) (GWebEngine *self);
        GWebStatus (*save_web_page) (GWebEngine *self, GWebEngineSaveAction setting, const gchar *file_name_with_path);
        GWebStatus (*save_current_frame) (GWebEngine *self, GWebEngineSaveAction setting, const gchar *file_name_with_path);
        const gchar* (*get_frame_title) (GWebEngine *self, gint frame_number);
        gint (*get_frame_number) (GWebEngine *self);
        GWebStatus (*save_web_page_image) (GWebEngine *self, const gchar *url, const gchar* directory); 
        void (*select_all_text) (GWebEngine *self);
        void (*set_language_encoding) (GWebEngine *self, GWebEngineEncoding encoding);
        void (*set_frame_encoding) (GWebEngine *self, GWebEngineEncoding encoding);
        gboolean (*find_text) (GWebEngine *self, const gchar *string, gboolean reverse, gboolean whole_word, gboolean case_sensitive, gboolean restart);
        void (*authenticate) (GWebEngine *self, gboolean ok, const gchar *username, const gchar *password);
        GWebStatus (*cut) (GWebEngine *self);
        GWebStatus (*copy) (GWebEngine *self);
        GWebStatus (*paste) (GWebEngine *self);
        gboolean (*can_cut) (GWebEngine *self);
        gboolean (*can_paste) (GWebEngine *self);
        gboolean (*can_copy) (GWebEngine *self);
        gboolean (*can_selecttext) (GWebEngine *self);
        gchar* (*get_favicon_name) (GWebEngine *self, const gchar *favicon_folder);
        GObject* (*get_engine_widget) (GWebEngine *self);
        GObject* (*get_engine_notifier) (GWebEngine *self);
        void (*set_open_link_mode) (GWebEngine *self, gboolean in_new_window);
        GWebStatus (*set_true_zoom_mode) (GWebEngine *self, gboolean status);
        void (*notify_plugins) (GWebEngine *self, gint event);
        void (*preload_current_skin) (GWebEngine *self);
        void (*invoke_selectmatch) (GWebEngine *self);
        GObject* (*get_server_certificate) (GWebEngine *self);
        gboolean (*is_engine_editable_widget) (GWebEngine *self);
};

GType g_web_engine_get_type (void);

void g_web_engine_destroy (GWebEngine *self);

void g_web_engine_load_url (GWebEngine *self, const gchar *url); 

GWebStatus g_web_engine_load_follow_link (GWebEngine *self, const gchar *url); 

GWebStatus g_web_engine_load_url_with_css (GWebEngine *self, const gchar *url, const gchar *cssfile);

void g_web_engine_load_url_with_js (GWebEngine *self, gboolean  enable);

void g_web_engine_load_home_page (GWebEngine *self); 

void g_web_engine_stop_load (GWebEngine *self);

void g_web_engine_reload (GWebEngine *self); 

void g_web_engine_go_back (GWebEngine *self, guint nsteps);

void g_web_engine_go_forward (GWebEngine *self, guint nsteps); 

gboolean g_web_engine_can_go_back (GWebEngine *self);

gboolean g_web_engine_can_go_forward (GWebEngine *self);

void g_web_engine_zoom_by_steps (GWebEngine *self, guint relative_zoom, guint* legal_zoom_value);

void g_web_engine_new_zoom_by_steps (GWebEngine *self, gboolean up, guint* legal_zoom_value);


void g_web_engine_set_zoom_level (GWebEngine *self, gint level);

GWebStatus g_web_engine_set_zoom_level_around_point (GWebEngine *self, guint x, guint y, gint level);

GWebStatus g_web_engine_compare_frames_zoom_level (GWebEngine *self, gboolean *equal);

GWebStatus g_web_engine_get_image_properties (GWebEngine *self, const gchar *url, gchar **file_type, guint *file_size, guint *width, guint *height);

GWebStatus g_web_engine_get_frame_properties (GWebEngine *self, gchar **file_type, guint *file_size, GWebEngineEncoding *file_encoding, guint *security, gboolean *automatic_encoding);

GWebStatus g_web_engine_load_image (GWebEngine *self, const gchar* url);

gint g_web_engine_get_back_window_history_list (GWebEngine *self, GWebHistoryList **history);

gint g_web_engine_get_forward_window_history_list (GWebEngine *self, GWebHistoryList **history);

guint g_web_engine_get_zoom_level (GWebEngine *self);

void g_web_engine_set_frame_zoom_level (GWebEngine *self, guint level);

guint g_web_engine_get_frame_zoom_level (GWebEngine *self);

void g_web_engine_set_layout_mode (GWebEngine *self, GWebEngineLayoutMode mode);

GWebEngineLayoutMode g_web_engine_get_layout_mode (GWebEngine *self);

void g_web_engine_set_load_images (GWebEngine *self, GWebEngineImagePolicy level);

GWebEngineImagePolicy g_web_engine_get_load_images (GWebEngine *self); 

void g_web_engine_set_frame_stacking (GWebEngine *self, gboolean enabled);

gboolean g_web_engine_get_frame_stacking (GWebEngine *self);

GWebStatus g_web_engine_save_web_page (GWebEngine *self, GWebEngineSaveAction setting, const gchar *file_name_with_path);

GWebStatus g_web_engine_save_current_frame (GWebEngine *self, GWebEngineSaveAction setting, const gchar *file_name_with_path);

const gchar* g_web_engine_get_frame_title (GWebEngine *self, gint frame_number);

gint g_web_engine_get_frame_number (GWebEngine *self);

GWebStatus g_web_engine_save_web_page_image (GWebEngine *self, const gchar *url, const gchar* directory);

void g_web_engine_select_all_text (GWebEngine *self);

void g_web_engine_set_language_encoding (GWebEngine *self, GWebEngineEncoding encoding);

void g_web_engine_set_frame_encoding (GWebEngine *self, GWebEngineEncoding encoding);

gboolean g_web_engine_find_text (GWebEngine *self, const gchar *string, gboolean reverse, gboolean whole_word, gboolean case_sensitive, gboolean restart);

void g_web_engine_authenticate (GWebEngine *self, gboolean ok, const gchar *username, const gchar *password);

GWebStatus g_web_engine_cut (GWebEngine *self);

GWebStatus g_web_engine_copy (GWebEngine *self);

GWebStatus g_web_engine_paste (GWebEngine *self);

gboolean g_web_engine_can_cut (GWebEngine *self);

gboolean g_web_engine_can_paste (GWebEngine *self);

gboolean g_web_engine_can_copy (GWebEngine *self);

gboolean g_web_engine_can_selecttext (GWebEngine *self);

gchar* g_web_engine_get_favicon_name (GWebEngine *self, const gchar *favicon_folder);

GObject* g_web_engine_get_engine_widget (GWebEngine *self);

GObject* g_web_engine_get_engine_notifier (GWebEngine *self);

void g_web_engine_set_open_link_mode (GWebEngine *self, gboolean in_new_window);

GWebStatus g_web_engine_set_true_zoom_mode (GWebEngine *self, gboolean status);

void g_web_engine_notify_plugins(GWebEngine *self, gint event); 

void g_web_engine_preload_current_skin(GWebEngine *self);

void g_web_engine_invoke_selectmatch(GWebEngine *self);

GObject* g_web_engine_get_server_certificate (GWebEngine *self);

G_END_DECLS

#endif /* __GWEBENGINE_H__ */

---