browser-eal/include/gwebengine.h File Reference

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

Include dependency graph for gwebengine.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _GWebEngineIface

Defines

#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))

Typedefs

typedef _GWebEngine GWebEngine
typedef _GWebEngineIface GWebEngineIface

Enumerations

enum  GWebEngineSecurityMode {
  G_WEBENGINE_NO_SECURITY = 0, G_WEBENGINE_LOW_SECURITY, G_WEBENGINE_MEDIUM_SECURITY, G_WEBENGINE_HIGH_SECURITY,
  G_WEBENGINE_UNKNOWN_SECURITY
}
enum  GWebEnginePopupMenuType {
  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
}
enum  GWebEngineLoadingFinishStatus { G_WEBENGINE_LOADING_FINISH_SUCCESS, G_WEBENGINE_LOADING_FINISH_COULDNT_CONNECT, G_WEBENGINE_LOADING_FINISH_UNKNOWN }
enum  GWebEngineAuthenticationType { G_WEBENGINE_AUTHENTICATE = 0, G_WEBENGINE_AUTHENTICATION_WRONG, G_WEBENGINE_PROXY_AUTHENTICATE, G_WEBENGINE_PROXY_AUTHENTICATION_WRONG }

Functions

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)


Define Documentation

#define G_IS_WEB_ENGINE ( obj   )     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_WEB_ENGINE))

Definition at line 100 of file gwebengine.h.

#define G_IS_WEB_ENGINE_CLASS ( vtable   )     (G_TYPE_CHECK_CLASS_TYPE ((vtable), G_TYPE_WEB_ENGINE))

Definition at line 101 of file gwebengine.h.

#define G_TYPE_WEB_ENGINE   (g_web_engine_get_type ())

Definition at line 97 of file gwebengine.h.

#define G_WEB_ENGINE ( obj   )     (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_WEB_ENGINE, GWebEngine))

Definition at line 98 of file gwebengine.h.

#define G_WEB_ENGINE_CLASS ( vtable   )     (G_TYPE_CHECK_CLASS_CAST ((vtable), G_TYPE_WEB_ENGINE, GWebEngineIface))

Definition at line 99 of file gwebengine.h.

#define G_WEB_ENGINE_GET_CLASS ( inst   )     (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_WEB_ENGINE, GWebEngineIface))

Definition at line 102 of file gwebengine.h.

Referenced by g_web_engine_authenticate(), g_web_engine_can_copy(), g_web_engine_can_cut(), g_web_engine_can_go_back(), g_web_engine_can_go_forward(), g_web_engine_can_paste(), g_web_engine_can_selecttext(), g_web_engine_compare_frames_zoom_level(), g_web_engine_copy(), g_web_engine_cut(), g_web_engine_destroy(), g_web_engine_find_text(), g_web_engine_get_back_window_history_list(), g_web_engine_get_engine_notifier(), g_web_engine_get_engine_widget(), g_web_engine_get_favicon_name(), g_web_engine_get_forward_window_history_list(), g_web_engine_get_frame_number(), g_web_engine_get_frame_properties(), g_web_engine_get_frame_stacking(), g_web_engine_get_frame_title(), g_web_engine_get_frame_zoom_level(), g_web_engine_get_image_properties(), g_web_engine_get_layout_mode(), g_web_engine_get_load_images(), g_web_engine_get_server_certificate(), g_web_engine_get_zoom_level(), g_web_engine_go_back(), g_web_engine_go_forward(), g_web_engine_invoke_selectmatch(), g_web_engine_load_follow_link(), g_web_engine_load_home_page(), g_web_engine_load_image(), g_web_engine_load_url(), g_web_engine_load_url_with_css(), g_web_engine_load_url_with_js(), g_web_engine_new_zoom_by_steps(), g_web_engine_notify_plugins(), g_web_engine_paste(), g_web_engine_preload_current_skin(), g_web_engine_reload(), g_web_engine_reset(), g_web_engine_save_current_frame(), g_web_engine_save_web_page(), g_web_engine_save_web_page_image(), g_web_engine_select_all_text(), g_web_engine_set_frame_encoding(), g_web_engine_set_frame_stacking(), g_web_engine_set_frame_zoom_level(), g_web_engine_set_language_encoding(), g_web_engine_set_layout_mode(), g_web_engine_set_load_images(), g_web_engine_set_open_link_mode(), g_web_engine_set_true_zoom_mode(), g_web_engine_set_zoom_level(), g_web_engine_set_zoom_level_around_point(), g_web_engine_stop_load(), and g_web_engine_zoom_by_steps().


Typedef Documentation

typedef struct _GWebEngine GWebEngine

Definition at line 104 of file gwebengine.h.

typedef struct _GWebEngineIface GWebEngineIface

Definition at line 105 of file gwebengine.h.


Enumeration Type Documentation

enum GWebEngineAuthenticationType

GWebEngineAuthenticationType. Enumerates authentication types.

Enumerator:
G_WEBENGINE_AUTHENTICATE  basic http authentication http authentication failed (and the question was asked again)
G_WEBENGINE_AUTHENTICATION_WRONG  proxy authentication
G_WEBENGINE_PROXY_AUTHENTICATE  proxy authentication failed (and the question was asked again)
G_WEBENGINE_PROXY_AUTHENTICATION_WRONG 

Definition at line 85 of file gwebengine.h.

enum GWebEngineLoadingFinishStatus

GWebEngineLoadingFinishStatus. Enumerates loading finish status types.

Enumerator:
G_WEBENGINE_LOADING_FINISH_SUCCESS  Loading of page is finished, with success Loading of page is finished, error while loading page
G_WEBENGINE_LOADING_FINISH_COULDNT_CONNECT  Loading of page is finished, status unknown
G_WEBENGINE_LOADING_FINISH_UNKNOWN 

Definition at line 71 of file gwebengine.h.

enum GWebEnginePopupMenuType

GWebEnginePopupMenuType. Enumerates popup menu types.

Enumerator:
G_WEBENGINE_POPUPMENU_NOTYPE  No type of menu Context menu for document
G_WEBENGINE_POPUPMENU_DOCUMENT  Context menu for link
G_WEBENGINE_POPUPMENU_LINK  Context menu for image
G_WEBENGINE_POPUPMENU_IMAGE  Context menu for text selection
G_WEBENGINE_POPUPMENU_TEXTSELECTION  Context menu for mailto
G_WEBENGINE_POPUPMENU_MAILTO  Context menu for iframes
G_WEBENGINE_POPUPMENU_IFRAME  Context menu for unknown protocol
G_WEBENGINE_POPUPMENU_UNKNOWN_PROTOCOL 

Definition at line 48 of file gwebengine.h.

enum GWebEngineSecurityMode

GWebEngineSecurityMode. Enumerates security modes.

Enumerator:
G_WEBENGINE_NO_SECURITY 
G_WEBENGINE_LOW_SECURITY 
G_WEBENGINE_MEDIUM_SECURITY 
G_WEBENGINE_HIGH_SECURITY 
G_WEBENGINE_UNKNOWN_SECURITY 

Definition at line 36 of file gwebengine.h.


Function Documentation

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

Submit a pending http authentication request.

Parameters:
self Object pointer
ok TRUE if ok was clicked, FALSE if cancel
username The username
password The password

Definition at line 306 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_can_copy ( GWebEngine self  ) 

Checks if it's meaningful to call the g_web_engine_copy.

Parameters:
self Object pointer
Returns:
TRUE if it seems to be meaningful to copy text.

Definition at line 342 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_can_cut ( GWebEngine self  ) 

Checks if it's meaningful to call the g_web_engine_cut.

Parameters:
self Object pointer
Returns:
TRUE if it seems to be meaningful to cut text.

Definition at line 330 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_can_go_back ( GWebEngine self  ) 

Check if the current page is not the first page in the history list.

Parameters:
self Object pointer
Returns:
TRUE, if it can go back to previous page, FALSE otherwise.

Definition at line 125 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_can_go_forward ( GWebEngine self  ) 

Check if the current page is not the last page the history list.

Parameters:
self Object pointer
Returns:
TRUE, if it can go forward to next page, FALSE otherwise.

Definition at line 131 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_can_paste ( GWebEngine self  ) 

Checks if it's meaningful to call the g_web_engine_paste.

Parameters:
self Object pointer
Returns:
TRUE if it seems to be meaningful to paste text.

Definition at line 336 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_can_selecttext ( GWebEngine self  ) 

Checks if it's meaningful to call the g_web_engine_cut.

Parameters:
self Object pointer
Returns:
TRUE if it seems to be meaningful to cut text.

Definition at line 348 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_compare_frames_zoom_level ( GWebEngine self,
gboolean *  equal 
)

Compare the zoom levels of frames/iframes.

Parameters:
self Object pointer
equal Return argument, TRUE if all zoom levels are equal
Returns:
G_WEB_STATUS_OK on success.

Definition at line 162 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_copy ( GWebEngine self  ) 

Copy selected text.

Parameters:
self Object pointer
Returns:
G_WEB_STATUS_OK on success.

Definition at line 318 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_cut ( GWebEngine self  ) 

Cut selected text.

Parameters:
self Object pointer
Returns:
G_WEB_STATUS_OK on success.

Definition at line 312 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_destroy ( GWebEngine self  ) 

Destroy object.

Parameters:
self Object pointer

Definition at line 59 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Search for a text string in current page.

Parameters:
self Object pointer
string The text to search for
reverse If TRUE, search up/left instead of down/right
whole_word Match only whole words
case_sensitive Accept uppercase/lowercase differences as a match.
restart If TRUE, search from the beginning of the document. If FALSE, continue search from previous match
Returns:
TRUE if can find specified text. FALSE, if can't

Definition at line 300 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gint g_web_engine_get_back_window_history_list ( GWebEngine self,
GWebHistoryList **  history 
)

Gets history information for all pages before the current page in the history list.

Parameters:
self Object pointer
history Return argument for the history information. It is set to NULL if the list is empty, or if an error occurs.
Returns:
The number of elements in the history list or a negative value on error. The error values are GWebStatus values.

Definition at line 186 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GObject* g_web_engine_get_engine_notifier ( GWebEngine self  ) 

Gets the engine notifier.

Parameters:
self Object pointer
Returns:
Returns the engine notifier object that will emit signals

Definition at line 366 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GObject* g_web_engine_get_engine_widget ( GWebEngine self  ) 

Gets the engine widget.

Parameters:
self Object pointer
Returns:
Returns the engine widget

Definition at line 360 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Get the icon of the currently loaded page.

Parameters:
self Object pointer
favicon_folder Favicon folder name
Returns:
Name of the icon.

Definition at line 354 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gint g_web_engine_get_forward_window_history_list ( GWebEngine self,
GWebHistoryList **  history 
)

Gets history information for all pages after the current page in the history list.

Parameters:
self Object pointer
history Return argument for the history information. It is set to NULL if the list is empty, or if an error occurs.
Returns:
The number of elements in the history list or a negative value on error. The error values are GWebStatus values.

Definition at line 192 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gint g_web_engine_get_frame_number ( GWebEngine self  ) 

Get the focused frame number.

Parameters:
self Object pointer
Returns:
Focused frame number.

Definition at line 270 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Get the frame properties.

Parameters:
self Object pointer
file_type Return argument, the frame type
file_size Return argument, the frame size in bytes
file_encoding Return argument, the frame encoding
security Return argument, the frame security mode
automatic_encoding Return argument, true if the default encoding of the page was used.
Returns:
G_WEB_STATUS_OK on success.

Definition at line 174 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

gboolean g_web_engine_get_frame_stacking ( GWebEngine self  ) 

Get the status of frame stacking mode(ON/OFF).

Parameters:
self Object pointer
Returns:
TRUE if the frame stacking is on, FALSE otherwise

Definition at line 246 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

const gchar* g_web_engine_get_frame_title ( GWebEngine self,
gint  frame_number 
)

Get the focused frame title.

Parameters:
self Object pointer
frame_number Focused frame number
Returns:
Focused frame title string.

Definition at line 264 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

guint g_web_engine_get_frame_zoom_level ( GWebEngine self  ) 

Get the frame zoom level value.

Parameters:
self Object pointer
Returns:
Frame zoom level in percent

Definition at line 210 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Get the image properties.

Parameters:
self Object pointer
url URL of the image.
file_type Type of the image.
file_size Size of the image.
width Width of the Image.
height Height of the Image.
Returns:
G_WEB_STATUS_OK on success.

Definition at line 168 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebEngineLayoutMode g_web_engine_get_layout_mode ( GWebEngine self  ) 

Get the layout mode when displaying pages.

Parameters:
self Object pointer
Returns:
The layout modes for specifying how pages should be displayed.

Definition at line 222 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebEngineImagePolicy g_web_engine_get_load_images ( GWebEngine self  ) 

Get the Images policy value(Always or Only loaded or Never).

Parameters:
self Object pointer
Returns:
Image policy

Definition at line 234 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GObject* g_web_engine_get_server_certificate ( GWebEngine self  ) 

Gets the server certificate

Parameters:
self Object pointer
Returns:
Returns the certificate.

Definition at line 401 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GType g_web_engine_get_type ( void   ) 

Definition at line 38 of file gwebengine.c.

References g_web_engine_base_init().

Here is the call graph for this function:

guint g_web_engine_get_zoom_level ( GWebEngine self  ) 

Get the zoom level in percent.

Parameters:
self Object pointer
Returns:
The zoom level in percent.

Definition at line 198 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_go_back ( GWebEngine self,
guint  nsteps 
)

Display a page that is before the current page in the history list. An attempt to move back beyond the first page in the history list causes the first page to be displayed. Nothing will change if the current page is the first page in the history list.

Parameters:
self Object pointer
nsteps Number of pages to go back from current page. 1 means previous page.

Definition at line 113 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_go_forward ( GWebEngine self,
guint  nsteps 
)

Display the page that is after the current page in the history list. An attempt to move forward beyond the last page in the history list causes the last page to be displayed. Nothing will change if the current page is the last page in the history list.

Parameters:
self Object pointer
nsteps Number of pages to go forward from current page. 1 means move forward one page.

Definition at line 119 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_invoke_selectmatch ( GWebEngine self  ) 

Invoke the select username dialog to select the stored username and password is filled in the forms element.

Parameters:
self Object pointer

Definition at line 395 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_load_follow_link ( GWebEngine self,
const gchar *  url 
)

Loads and displays the page specified by the url, mimicking the behaviour of the user clicking or navigating to the url.

Parameters:
self Object pointer
url URL of the page to be loaded
Returns:
G_WEB_STATUS_OK on success.

Definition at line 77 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_load_home_page ( GWebEngine self  ) 

Loads and displays home page

Parameters:
self Object pointer

Definition at line 95 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_load_image ( GWebEngine self,
const gchar *  url 
)

Load the image.

Parameters:
self Object pointer
url URL of the image.
Returns:
G_WEB_STATUS_OK on success.

Definition at line 180 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_load_url ( GWebEngine self,
const gchar *  url 
)

Loads and displays the page specified by the URL.

Parameters:
self Object pointer
url URL of the page to be loaded

Definition at line 71 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Loads and displays the page specified by the url, using the specified style sheet.

Parameters:
self Object pointer
url URL of the page to be loaded
cssfile The style sheet
Returns:
G_WEB_STATUS_OK on success.

Definition at line 83 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_load_url_with_js ( GWebEngine self,
gboolean  enable 
)

Enables JS support if ECMAScript is enabled in this window. This setting is the local setting for the window, not any global setting.

Parameters:
self Object pointer
enable TRUE if the window local setting for ECMAScript should be set to allow ECMAScript, FALSE otherwise.

Definition at line 89 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Set the new zoom level by steps

Parameters:
self Object pointer
up parameter, TRUE to increase and vice versa

Definition at line 143 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_notify_plugins ( GWebEngine self,
gint  event 
)

Sends a event message to all plugins in the current window Using the NPP_HandleEvent signal

Parameters:
self Object pointer
event The event to be sent to the plugin (of type GWebPluginEvent)

Definition at line 384 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_paste ( GWebEngine self  ) 

Paste selected text.

Parameters:
self Object pointer
Returns:
G_WEB_STATUS_OK on success.

Definition at line 324 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_preload_current_skin ( GWebEngine self  ) 

Normally the skin elements are loaded when needed, but loading skin might be time consuming if file I/O is very slow. This function makes the skins load immediately, to avoid delays later.

Parameters:
self Object pointer

Definition at line 390 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_reload ( GWebEngine self  ) 

Reloads the current page

Parameters:
self Object pointer

Definition at line 107 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Save the current focused frame.

Parameters:
self Object pointer
setting G_WEBENGINE_SAVE_FRAMES or G_WEBENGINE_SAVE_NO_INLINES or G_WEBENGINE_SAVE_ALL_INLINES
file_name_with_path The filename with path to save.
Returns:
G_WEB_STATUS_OK on success.

Definition at line 258 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Save the current displayed web page.

Parameters:
self Object pointer
setting G_WEBENGINE_SAVE_FRAMES or G_WEBENGINE_SAVE_NO_INLINES or G_WEBENGINE_SAVE_ALL_INLINES
file_name_with_path The filename with path to save.
Returns:
G_WEB_STATUS_OK on success.

Definition at line 252 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Save the image.

Parameters:
self Object pointer
url The URL to save
directory The directory to save to. The directory is created if does not exist.
Returns:
G_WEB_STATUS_OK on success.

Definition at line 276 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_select_all_text ( GWebEngine self  ) 

Select all text in current page.

Parameters:
self Object pointer

Definition at line 282 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_frame_encoding ( GWebEngine self,
GWebEngineEncoding  encoding 
)

Set frame encoding value.

Parameters:
self Object pointer
encoding GWebEngineEncoding value

Definition at line 294 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_frame_stacking ( GWebEngine self,
gboolean  enabled 
)

Turn on/off frame stacking.

Parameters:
self Object pointer
enabled TRUE to enable the frame stacking, FALSE otherwise

Definition at line 240 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_frame_zoom_level ( GWebEngine self,
guint  level 
)

Set the zoom level for frame in percent.

Parameters:
self Object pointer
level The zoom level in percent for frame

Definition at line 204 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_language_encoding ( GWebEngine self,
GWebEngineEncoding  encoding 
)

Set language encoding value.

Parameters:
self Object pointer
encoding GWebEngineEncoding value

Definition at line 288 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_layout_mode ( GWebEngine self,
GWebEngineLayoutMode  mode 
)

Sets the layout mode to use when displaying pages.

Parameters:
self Object pointer
mode The layout mode to use(Normal or MSR)

Definition at line 216 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_load_images ( GWebEngine self,
GWebEngineImagePolicy  level 
)

Set the Image policy value(Always or Only loaded or Never).

Parameters:
self Object pointer
level Image policy value

Definition at line 228 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_open_link_mode ( GWebEngine self,
gboolean  in_new_window 
)

Change the way links are opened when clicked or selected when navigated to. Can either be opened in a new window or the same.

Parameters:
self Object pointer
in_new_window If TRUE, open links in new window. Otherwise clicked/selected links are opened in the same window

Definition at line 372 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

GWebStatus g_web_engine_set_true_zoom_mode ( GWebEngine self,
gboolean  status 
)

(De)activate true zoom for a webpage

Parameters:
self Object pointer
status TRUE if activate true zoom
Returns:
G_WEB_STATUS_OK on success.

Definition at line 378 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_set_zoom_level ( GWebEngine self,
gint  level 
)

Set the zoom level in percent

Parameters:
self Object pointer
level The zoom level in percent

Definition at line 149 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Zoom page around a point.

Parameters:
self Object pointer
x X coordinate.
y Y coordinate.
level The zoom level in percent
Returns:
G_WEB_STATUS_OK on success.

Definition at line 156 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

void g_web_engine_stop_load ( GWebEngine self  ) 

Stop the loading of the current page

Parameters:
self Object pointer

Definition at line 101 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.

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

Set the zoom level by steps

Parameters:
self Object pointer
relative zoom level in percent

Definition at line 137 of file gwebengine.c.

References G_WEB_ENGINE_GET_CLASS.


Generated on Tue Sep 25 10:37:05 2007 for browser-eal by  doxygen 1.5.1