browser-eal/include/gweb.h File Reference

#include <glib-object.h>
#include "gwebengine.h"
#include "gwebtransferitem.h"
#include "gwebhistorylist.h"
#include "gwebpluginlist.h"
#include "gwebtransferitemlist.h"
#include "gwebpassman.h"

Include dependency graph for gweb.h:

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

Define Documentation

#define G_IS_WEB ( obj ) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_WEB))

Definition at line 84 of file gweb.h.

#define G_IS_WEB_CLASS ( vtable ) (G_TYPE_CHECK_CLASS_TYPE ((vtable), G_TYPE_WEB))

Definition at line 85 of file gweb.h.

#define G_TYPE_WEB (g_web_get_type ())

GWeb

Definition at line 81 of file gweb.h.

#define G_WEB ( obj ) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_WEB, GWeb))

Definition at line 82 of file gweb.h.

#define G_WEB_CLASS ( vtable ) (G_TYPE_CHECK_CLASS_CAST ((vtable), G_TYPE_WEB, GWebIface))

Definition at line 83 of file gweb.h.

#define G_WEB_GET_CLASS ( inst ) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_WEB, GWebIface))

Definition at line 86 of file gweb.h.

Referenced by g_web_certificate_free(), g_web_certificate_iter_free(), g_web_clear_all_history(), g_web_clear_cache(), g_web_clear_passwords(), g_web_clear_personal_data(), g_web_confirm_cookie(), g_web_delete_all_cookies(), g_web_delete_personal_data(), g_web_destroy(), g_web_disconnect(), g_web_enable_url_loading(), g_web_free_memory(), g_web_get_automatic_redirection_enabled(), g_web_get_browse_offline(), g_web_get_cache_size(), g_web_get_certificate_context_iter(), g_web_get_certificate_enum_message(), g_web_get_certificate_iter(), g_web_get_cookie_acceptance(), g_web_get_default_home_page(), g_web_get_frame_borders_enabled(), g_web_get_global(), g_web_get_history_list(), g_web_get_home_page(), g_web_get_js_enabled(), g_web_get_language(), g_web_get_load_images(), g_web_get_location_completion_suffixes(), g_web_get_maximum_cache_size(), g_web_get_memory_cache(), g_web_get_new_window_loads(), g_web_get_password_manager(), g_web_get_plugin_enabled(), g_web_get_plugins_enabled(), g_web_get_plugins_list(), g_web_get_popup_acceptance(), g_web_get_pref(), g_web_get_remember_password(), g_web_get_remember_password_for_forms(), g_web_get_ssl2_support(), g_web_get_user_agent_id(), g_web_get_web_transfer_item_list(), g_web_home_page_set(), g_web_initialize_web_transfer_item(), g_web_new_web_engine_window(), g_web_new_web_engine_window_with_context(), g_web_new_web_transfer_item(), g_web_notify_plugins(), g_web_perform_crtificate_context_action(), g_web_reset_cache_history_length(), g_web_restore_transfers(), g_web_resume(), g_web_set_automatic_redirection_enabled(), g_web_set_browse_offline(), g_web_set_cache_size(), g_web_set_cookie_acceptance(), g_web_set_default_home_page(), g_web_set_frame_borders_enabled(), g_web_set_home_page(), g_web_set_js_enabled(), g_web_set_language(), g_web_set_load_images(), g_web_set_location_completion_suffixes(), g_web_set_memory_cache(), g_web_set_new_window_loads(), g_web_set_oom_cb(), g_web_set_plugin_enabled(), g_web_set_plugin_ignore_filepath(), g_web_set_plugins_enabled(), g_web_set_popup_acceptance(), g_web_set_pref(), g_web_set_remember_password(), g_web_set_remember_password_for_forms(), g_web_set_ssl2_support(), g_web_set_ua_string(), g_web_set_user_agent_id(), g_web_store_personal_data(), g_web_store_transfers(), g_web_suspend(), g_web_suspended(), g_web_username_matchinfo_delete(), g_web_username_matchinfo_get_matches(), and g_web_username_matchinfo_get_username().

#define G_WEB_SIGNAL_ASK_COOKIE "ask-cookie"

"ask-cookie" signal.

Definition at line 813 of file gweb.h.

#define G_WEB_SIGNAL_CERTIFICATE_DETAILS "certificate-details"

"certificate-details" signal.

Definition at line 871 of file gweb.h.

#define G_WEB_SIGNAL_CERTIFICATE_DIALOG "certificate-dialog"

"certificate-dialog" signal.

Definition at line 841 of file gweb.h.

#define G_WEB_SIGNAL_CERTIFICATE_PASSWORD_DIALOG "certificate-password-dialog"

"certificate-password-dialog" signal.

Definition at line 854 of file gweb.h.

#define G_WEB_SIGNAL_MODAL_DIALOG "modal-dialog"

"modal-dialog" signal.

Definition at line 789 of file gweb.h.

#define G_WEB_SIGNAL_ON_SELECT "on-submit"

"on-submit" signal.

Definition at line 884 of file gweb.h.

#define G_WEB_SIGNAL_SELECT_MATCH "select-match"

"select-match" signal.

Definition at line 898 of file gweb.h.

Typedef Documentation

typedef struct _GWeb GWeb

Definition at line 88 of file gweb.h.

typedef struct _GWebIface GWebIface

Definition at line 89 of file gweb.h.

Enumeration Type Documentation

enum GCallbackAction

Enumerator:

G_CALLBACK_NO_ACTION
G_CALLBACK_OOM_ACTION
G_CALLBACK_RESET_ACTION

Definition at line 57 of file gweb.h.

enum GCookieAcceptance

GCookieAcceptance. Cookies Support.

Enumerator:

G_ACCEPT_COOKIE_ALWAYS	Accept and handle all cookies except illegal domain cookies
G_ACCEPT_COOKIE_PROMPT	Confirm cookie before processing them
G_ACCEPT_COOKIE_NEVER	Refuse all cookies

Definition at line 40 of file gweb.h.

enum GMemoryCache

GMemoryCache. Memory Cache.

Enumerator:

G_MEMORY_CACHE_AUTOMATIC	Automatic memory cahe
G_MEMORY_CACHE_LARGE	Memory cache 4096kB
G_MEMORY_CACHE_MEDIUM	Memory cache 2048kB
G_MEMORY_CACHE_DEFAULT	Memory cache 1024kB
G_MEMORY_CACHE_SMALL	Memory cache 512kB
G_MEMORY_CACHE_OFF	Memory cahe off

Definition at line 68 of file gweb.h.

enum GPopupAcceptance

GPopupAcceptance. Popup Support.

Enumerator:

G_ACCEPT_POPUP_ALWAYS	Accept popup support Always
G_ACCEPT_POPUP_PROMPT	Ask before popping up
G_ACCEPT_POPUP_NEVER	No popups at all

Definition at line 50 of file gweb.h.

Function Documentation

void g_web_certificate_free	(	GWeb *	self,
		GObject *	cert
	)

Free certificate object.

Parameters:

	self	Object pointer
	cert	Certificate object.

Definition at line 455 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_certificate_iter_free	(	GWeb *	self,
		GObject *	iterator
	)

Free iterator object.

Parameters:

	self	Object pointer
	iterator	The iterator.

Definition at line 461 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_clear_all_history ( GWeb * self )

Clear all global history.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 539 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_clear_cache ( GWeb * self )

Empty the disk cache.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 294 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_clear_passwords ( GWeb * self )

Clear all passwords.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 533 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_clear_personal_data ( GWeb * self )

Empty the personal data

Parameters:

self

Object pointer

Definition at line 545 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_confirm_cookie	(	GWeb *	self,
		gpointer	context,
		gboolean	accept,
		GWebCookieAction	action
	)

Confirm a cookie request.

Parameters:

	self	Object pointer
	context	The context for which the cookie was requested
	accept	The cookie (accept was pressed)
	action	The action that was chosen

Returns:: G_WEB_STATUS_OK on success.

Definition at line 416 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_delete_all_cookies ( GWeb * self )

Delete All cookies.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 410 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_delete_personal_data	(	GWeb *	self,
		const gchar *	server,
		const gchar *	username
	)

Delete personal data saved for an authentication dialog.

Parameters:

	self	Object pointer
	server	The server.
	username	The username.

Returns:: G_WEB_STATUS_OK on success.

Definition at line 503 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_destroy ( GWeb * self )

Destroy object.

Parameters:

self

Object pointer

Definition at line 59 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_disconnect ( GWeb * self )

Close all connections.

Parameters:

self

Object pointer

Definition at line 288 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_enable_url_loading	(	GWeb *	self,
		gboolean	enable
	)

Enable or disable URL loading.

Parameters:

	self	Object pointer
	enable	Enable flag.

Definition at line 385 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_free_memory	(	GWeb *	self,
		gboolean	progressive
	)

Free Memory

Parameters:

	self	Object pointer
	progressive	free.

Definition at line 391 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_automatic_redirection_enabled ( GWeb * self )

Get whether Automatic redirection is enabled or not.

Parameters:

self

Object pointer

Returns:: TRUE, if Automatic Redirection is Enabled, FALSE otherwise

Definition at line 270 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_browse_offline ( GWeb * self )

Get whether offline browsing is enabled or not.

Parameters:

self

Object pointer

Returns:: TRUE, if browse offline is enabled, FALSE, if not

Definition at line 258 of file gweb.c.

References G_WEB_GET_CLASS.

gint g_web_get_cache_size ( GWeb * self )

Get the Cache size.

Parameters:

self

Object pointer

Returns:: The size of Cache

Definition at line 246 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_get_certificate_context_iter	(	GWeb *	self,
		GObject *	context,
		GObject **	iterator
	)

Gets an iterator with the certificates handled by this certificate context.

Parameters:

	self	Object pointer
	context	The certificate context.
	iterator	The iterator.

Returns:

G_WEB_STATUS_OK on success. A negative value indicates one of the following errors:

G_WEB_ERR_NULL_POINTER - Got a NULL argument.

Definition at line 443 of file gweb.c.

References G_WEB_GET_CLASS.

GWebCertificateMessage g_web_get_certificate_enum_message	(	GWeb *	self,
		GObject *	context
	)

Gets an enumeration value for the dialog message for certificate dialog.

Parameters:

	self	Object pointer
	context	The certificate context.

Returns:: The certificate message, which is one of the following: G_WEB_CERT_MESS_UNTRUSTED - Untrusted certificate G_WEB_CERT_MESS_WRONGNAME - Invalid or mismatched name G_WEB_CERT_MESS_EXPIRED - Certificate expired G_WEB_CERT_MESS_PREVALID - Certificate not valid yet G_WEB_CERT_MESS_ALGORITHM - Wrong certificate algorithm G_WEB_CERT_MESS_VERSION - Wrong certificate version G_WEB_CERT_MESS_UNKNOWN - Unknown error G_WEB_CERT_MESS_VALID - Valid certificate

Definition at line 428 of file gweb.c.

References G_WEB_GET_CLASS.

GObject* g_web_get_certificate_iter	(	GWeb *	self,
		GObject **	iterator
	)

Gets the certificate at the current position.

Parameters:

	self	Object pointer
	iterator	The iterator.

Returns:: The certificate, or NULL if the certificate has been deleted or if the iterator is empty.

Definition at line 449 of file gweb.c.

References G_WEB_GET_CLASS.

GCookieAcceptance g_web_get_cookie_acceptance ( GWeb * self )

Get the value(Always or Ask first or Never) of cookies Acceptance.

Parameters:

self

Object pointer

Returns:: Cookie Acceptance value (Always or Ask first or Never)

Definition at line 331 of file gweb.c.

References G_WEB_GET_CLASS.

gchar* g_web_get_default_home_page ( GWeb * self )

Get the Default Home page URL.

Parameters:

self

Object pointer

Returns:: Returns default home page url produced by Nokia or a service provider.

Definition at line 149 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_frame_borders_enabled ( GWeb * self )

Get whether Frame Borders are enabled or disabled.

Parameters:

self

Object pointer

Returns:: TRUE, if frame borders enabled. FALSE, if not

Definition at line 167 of file gweb.c.

References G_WEB_GET_CLASS.

GObject* g_web_get_global ( GWeb * self )

Get the global instance.

Parameters:

self

Object pointer

Returns:: Pointer to Web Global

Definition at line 422 of file gweb.c.

References G_WEB_GET_CLASS.

GWebHistoryList* g_web_get_history_list ( GWeb * self )

Get the history list object.

Parameters:

self

Object pointer

Returns:: Web History List object

Definition at line 307 of file gweb.c.

References G_WEB_GET_CLASS.

gchar* g_web_get_home_page ( GWeb * self )

Get the Home page URL.

Parameters:

self

Object pointer

Returns:: Returns home page URL string

Definition at line 113 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_js_enabled ( GWeb * self )

Get whether ecmascript is enabled or not.

Parameters:

self

Object pointer

Returns:: TRUE, if ecmascript is enabled. FALSE, if not

Definition at line 222 of file gweb.c.

References G_WEB_GET_CLASS.

gchar* g_web_get_language ( GWeb * self )

Get language.

Parameters:

self

Object pointer

Returns:: Returns language string

Definition at line 125 of file gweb.c.

References G_WEB_GET_CLASS.

GWebEngineImagePolicy g_web_get_load_images ( GWeb * self )

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

Parameters:

self

Object pointer

Returns:: Image policy

Definition at line 282 of file gweb.c.

References G_WEB_GET_CLASS.

gchar* g_web_get_location_completion_suffixes ( GWeb * self )

Get the Location Completion Suffixes.

Parameters:

self

Object pointer

Returns:: Returns location completion suffixes

Definition at line 179 of file gweb.c.

References G_WEB_GET_CLASS.

gint g_web_get_maximum_cache_size ( GWeb * self )

Get the Maximum Cache size.

Parameters:

self

Object pointer

Returns:: Returns Maximum Cache size.

Definition at line 137 of file gweb.c.

References G_WEB_GET_CLASS.

GMemoryCache g_web_get_memory_cache ( GWeb * self )

Get the value of Memory Cache.

Parameters:

self

Object pointer

Returns:: Memory Cache.

Definition at line 234 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_new_window_loads ( GWeb * self )

Get whether default local home page will be loaded or not.

Parameters:

self

Object pointer

Returns:: TRUE, if default local home page will be loaded, FALSE otherwise

Definition at line 319 of file gweb.c.

References G_WEB_GET_CLASS.

GWebPasswordManager* g_web_get_password_manager	(	GWeb *	self,
		const gchar *	server,
		gint	index
	)

Create the password manager to get the personal data that is store for the server.

Parameters:

	self	Object pointer
	server	The server.
	index	The index.

Returns:: Web password manager object

Definition at line 491 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_plugin_enabled	(	GWeb *	self,
		gchar *	name
	)

Get whether plugin is enabled or not.

Parameters:

	self	Object pointer
	name	The name of the plugin, Ex:libdefaultplugin.so

Returns:: TRUE, if the plugin is enabled. FALSE, FALSE otherwise.

Definition at line 557 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_plugins_enabled ( GWeb * self )

Get whether plugins are enabled or disabled.

Parameters:

self

Object pointer

Returns:: TRUE, if plugins enabled. FALSE, if not

Definition at line 210 of file gweb.c.

References G_WEB_GET_CLASS.

GWebPluginList* g_web_get_plugins_list ( GWeb * self )

Get the Plugin List object.

Parameters:

self

Object pointer

Returns:: Web Plugins List object

Definition at line 301 of file gweb.c.

References G_WEB_GET_CLASS.

GPopupAcceptance g_web_get_popup_acceptance ( GWeb * self )

Get the value (Always or Ask first or Never) of Popup Acceptance.

Parameters:

self

Object pointer

Returns:: Popup Acceptance value (Always or Ask first or Never)

Definition at line 343 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_remember_password ( GWeb * self )

Returns whether remember password is on or off for authentication dialog.

Parameters:

self

Object pointer

Returns:: TRUE, if remember password is on. FALSE, if not

Definition at line 515 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_remember_password_for_forms ( GWeb * self )

Returns whether remember password is on or off for forms.

Parameters:

self

Object pointer

Returns:: TRUE, if remember password is on. FALSE, if not

Definition at line 527 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_get_ssl2_support ( GWeb * self )

Get SSL2 support status

Parameters:

self

Object pointer

Returns:: TRUE, if SLL2 support enabled. FALSE, if not

Definition at line 204 of file gweb.c.

References G_WEB_GET_CLASS.

GType g_web_get_type ( void )

Definition at line 38 of file gweb.c.

References g_web_base_init().

Here is the call graph for this function:

gint g_web_get_user_agent_id ( GWeb * self )

Get the UserAgent ID.

Parameters:

self

Object pointer

Returns:: UserAgent ID.

Definition at line 379 of file gweb.c.

References G_WEB_GET_CLASS.

GWebTransferItemList* g_web_get_web_transfer_item_list ( GWeb * self )

Get Web Transfer Item List.

Parameters:

self

Object pointer

Returns:: Web Transfer Item List object

Definition at line 101 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_home_page_set ( GWeb * self )

Returns whether Home Page is set or not.

Parameters:

self

Object pointer

Returns:: TRUE, if home page is set. FALSE, if not

Definition at line 155 of file gweb.c.

References G_WEB_GET_CLASS.

GWebTransferItem* g_web_initialize_web_transfer_item	(	GWeb *	self,
		GObject *	web_transfer_item
	)

Initialized Web Transfer Item.

Parameters:

	self	Object pointer
	web_transfer_item	Transfer Item pointer

Returns:: Web Transfer Item object

Definition at line 95 of file gweb.c.

References G_WEB_GET_CLASS.

GWebEngine* g_web_new_web_engine_window ( GWeb * self )

Create Web Engine object.

Parameters:

self

Object pointer

Returns:: Web Engine object

Definition at line 65 of file gweb.c.

References G_WEB_GET_CLASS.

GWebEngine* g_web_new_web_engine_window_with_context	(	GWeb *	self,
		gpointer	context,
		gboolean	leave_tracks,
		gboolean	without_history
	)

Create Web Engine object with context.

Parameters:

	self	Object pointer
	context	Context from where the Web Engine was requested
	leave_tracks	TRUE create a new widget, where visited pages won't be listed in the history and their contents won't be stored in the cache. else FALSE.
	without_history	TRUE Create a new widget without history. Visited pages will not be listed in the global history

Returns:: Web Engine object

Definition at line 71 of file gweb.c.

References G_WEB_GET_CLASS.

GWebTransferItem* g_web_new_web_transfer_item	(	GWeb *	self,
		const gchar *	url,
		const gchar *	filename
	)

Create Web Transfer Item.

Parameters:

	self	Object pointer
	url	The URL to download from
	filename	The file to save to

Returns:: Web Transfer Item object

Definition at line 89 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_notify_plugins	(	GWeb *	self,
		gint	event
	)

Sends a event message to all plugins currently open Using the NPP_HandleEvent signal

Parameters:

	self	Object pointer
	event	The event to be sent to the plugin

Definition at line 467 of file gweb.c.

References G_WEB_GET_CLASS.

GWebCertificateReaction g_web_perform_crtificate_context_action	(	GWeb *	self,
		GObject *	context,
		GWebCertificateAction	action,
		GObject *	cert
	)

Performs a certificate action as a result of a button press in a certificates dialog.

For every action the caller must perform the reaction specified by the return value.

Parameters:

	self	Object pointer
	context	The certificate context.
	action	The action to perform.
	cert	The currently selected certificate, or NULL to let Engine decide.

Returns:

A reaction to be performed by on the dialog by the caller. A negative value indicates one of the following errors:

G_WEB_ERR - Internal error occured.
G_WEB_ERR_NO_MEMORY - Out of memory while performing the action.
G_WEB_ERR_NULL_POINTER - Got a NULL context
G_WEB_ERR_OUT_OF_RANGE - non exisiting action
G_WEB_ERR_NOT_SUPPORTED - The action is not supported for this certificate context.

Definition at line 434 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_reset_cache_history_length ( GWeb * self )

Reset the cache size and history length.

Parameters:

self

Object pointer

Definition at line 131 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_restore_transfers ( GWeb * self )

Restore transfers that where previously stored by storeTransfers(). The transfers should be restored at startup before any transfers are initiated.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 404 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_resume ( GWeb * self )

Resume settings, state, etc, switch on times.

Parameters:

self

Object pointer

Definition at line 361 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_automatic_redirection_enabled	(	GWeb *	self,
		gboolean	enabled
	)

Enable/Disable the automatic redirection through client pull.

Parameters:

	self	Object pointer
	enabled	TRUE to enable the automatic redirection, FALSE otherwise

Returns:: G_WEB_STATUS_OK on success.

Definition at line 264 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_browse_offline	(	GWeb *	self,
		gboolean	offline
	)

Enable/Disable offline browsing.

Parameters:

	self	Object pointer
	offline	TRUE to enable offline browsing, FALSE otherwise

Returns:: G_WEB_STATUS_OK on success.

Definition at line 252 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_cache_size	(	GWeb *	self,
		gint	size
	)

Set the cache size.

Parameters:

	self	Object pointer
	size	size of the Cache

Returns:: G_WEB_STATUS_OK on success.

Definition at line 240 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_set_cookie_acceptance	(	GWeb *	self,
		GCookieAcceptance	acceptance
	)

Set the cookies Acceptance value (Always or Ask first or Never).

Parameters:

	self	Object pointer
	acceptance	Cookie Acceptance value

Definition at line 325 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_default_home_page	(	GWeb *	self,
		const gchar *	default_page
	)

Set the Default home page URL.

Parameters:

	self	Object pointer
	default_page	Default home page to be set

Returns:: G_WEB_STATUS_OK on success.

Definition at line 143 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_set_frame_borders_enabled	(	GWeb *	self,
		gboolean	enabled
	)

Set the Frame Borders always be displayed even if the page says otherwise.

Parameters:

	self	Object pointer
	enabled	TRUE to enable the frame borders always and FALSE otherwise

Definition at line 161 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_home_page	(	GWeb *	self,
		const gchar *	home_page
	)

Set the Home page URL.

Parameters:

	self	Object pointer
	home_page	Home page to be set

Returns:: G_WEB_STATUS_OK on success.

Definition at line 107 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_js_enabled	(	GWeb *	self,
		gboolean	enabled
	)

Enable/Disable the ecmascript.

Parameters:

	self	Object pointer
	enabled	TRUE to enable the ecmascript, FALSE otherwise

Returns:: G_WEB_STATUS_OK on success.

Definition at line 216 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_language	(	GWeb *	self,
		const gchar *	language
	)

Set language.

Parameters:

	self	Object pointer
	language	Language to be set

Returns:: G_WEB_STATUS_OK on success.

Definition at line 119 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_load_images	(	GWeb *	self,
		GWebEngineImagePolicy	level
	)

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

Parameters:

	self	Object pointer
	level	Image policy value

Returns:: G_WEB_STATUS_OK on success.

Definition at line 276 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_location_completion_suffixes	(	GWeb *	self,
		const gchar *	suffixes
	)

Set the Location Completion Suffixes(eg "com, org" will be added to the URL).

Parameters:

	self	Object pointer
	suffixes	Suffixes to be set

Returns:: G_WEB_STATUS_OK on success.

Definition at line 173 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_set_memory_cache	(	GWeb *	self,
		GMemoryCache	acceptance
	)

Set the Memory Cache value.

Parameters:

	self	Object pointer
	acceptance	MemoryCache value

Definition at line 228 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_new_window_loads	(	GWeb *	self,
		gboolean	loads
	)

Enable/Disable to load default local home page.

Parameters:

	self	Object pointer
	loads	TRUE to load default local home page, FALSE to load the defined home page

Returns:: G_WEB_STATUS_OK on success.

Definition at line 313 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_oom_cb	(	GWeb *	self,
		GFunc	func
	)

Definition at line 191 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_plugin_enabled	(	GWeb *	self,
		gchar *	name,
		gboolean	enabled
	)

Enable/Disable the plugin at runtime.

Parameters:

	self	Object pointer
	name	The name of the plugin, Ex:libdefaultplugin.so
	enabled	TRUE to enable the plugin, FALSE otherwise

Returns:: G_WEB_STATUS_OK on success.

Definition at line 551 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_plugin_ignore_filepath ( GWeb * self )

Set the plugin ignore file path.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 563 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_plugins_enabled	(	GWeb *	self,
		gboolean	enabled
	)

Enable/Disable Plugins.

Parameters:

	self	Object pointer
	enabled	TRUE to enable the plugins, FALSE to disable the plugins

Returns:: G_WEB_STATUS_OK on success.

Definition at line 185 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_set_popup_acceptance	(	GWeb *	self,
		GPopupAcceptance	acceptance
	)

Set the Popup Acceptance value (Always or Ask first or Never).

Parameters:

	self	Object pointer
	acceptance	Popup Acceptance value

Definition at line 337 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_remember_password	(	GWeb *	self,
		gboolean	rpassword
	)

Enable/Disable to remember password for authentication dialog

Parameters:

	self	Object pointer
	rpassword	TRUE to remember password, FALSE, if not

Returns:: G_WEB_STATUS_OK on success.

Definition at line 509 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_remember_password_for_forms	(	GWeb *	self,
		gboolean	rpassword
	)

Enable/Disable to remember password for forms.

Parameters:

	self	Object pointer
	rpassword	TRUE to remember password, FALSE, if not

Returns:: G_WEB_STATUS_OK on success.

Definition at line 521 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_ssl2_support	(	GWeb *	self,
		gboolean	enabled
	)

Enable/Disable SSL2 support.

Parameters:

	self	Object pointer
	enabled	TRUE to enable SSL2 support, FALSE to disable SSL2 support

Returns:: G_WEB_STATUS_OK on success.

Definition at line 198 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_set_ua_string	(	GWeb *	self,
		gchar *	ua_string
	)

Sets a custom extension for the user agent string. The user agent string is composed of the internal ua string with the extension appended at the end.

Parameters:

	self	Object pointer
	ua_string	The new ua string extension or NULL to remove the current extension.

Definition at line 367 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_set_user_agent_id	(	GWeb *	self,
		gint	ua_id
	)

Configures engine to identify itself as a specific browser type

Parameters:

	self	Object pointer
	ua_id	browser UserAgent ID.

Returns:: G_WEB_STATUS_OK on success.

Definition at line 373 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_signal_ask_cookie	(	GObject *	global,
		gpointer	context,
		gint	actions,
		const gchar *	url,
		const gchar *	name,
		const gchar *	value,
		const gchar *	domain,
		const gchar *	path,
		gboolean	illegal_path
	)

Request a cookie dialog Signal name: "ask-cookie"

Parameters:

	global	The global browser instance
	context	The cookie context. Return this context with a call to g_web_confirm_cookie
	actions	Integer with GCookieAction flags. Tells which actions are allowed on this cookie
	url	The cookie url
	name	The cookie name
	value	The cookie value
	domain	The cookie domain
	path	The cookie path
	illegal_path	TRUE if the cookie has an illegal path
	expire	The expiry date of the cookie in seconds since the epoch

void g_web_signal_certificate_details	(	GObject *	global,
		gpointer	details
	)

Certificate details were offered Signal name: "certificate-details"

Parameters:

	engine	The global browser instance
	details.	A X509 certificate

gboolean g_web_signal_certificate_dialog	(	GObject *	global,
		gpointer	ctx
	)

Callback that Engine uses to request a certificate dialog. Signal name: "certificate-dialog"

Parameters:

	global	The global browser instance from where the signal is emitted.
	ctx	The certificate context describing the dialog.

Returns:: TRUE on success, FALSE on error.

void g_web_signal_certificate_password_dialog	(	GObject *	global,
		const gchar *	title,
		const gchar *	text,
		gchar **	password
	)

Request a certificate password dialog. Signal name: "certificate-password-dialog"

Parameters:

	global	The global browser instance
	title	The password dialog title
	text	The password dialog text
	password	Pointer to the password string. The implementor must allocate the space. It will be freed by Engine.

GWebDialogButton g_web_signal_modal_dialog	(	GObject *	global,
		const gchar *	caption,
		const gchar *	message,
		GWebDialogMessageType	type,
		GWebDialogButton	button1,
		GWebDialogButton	button2,
		GWebDialogButton	button3
	)

Callback that Engine uses to request a modal dialog with a message Signal name: "modal-dialog"

Parameters:

	global	The global browser instance from where the signal is emitted
	caption	The caption for the dialog
	message	The message in the dialog
	type	The type of dialog
	button1	First button
	button2	Second button (G_WEB_DIALOG_NO_BUTTON if no button)
	button3	Third button (G_WEB_DIALOG_NO_BUTTON if no button)

Returns:: The implementation if this function should return the button that was clicked as a reply

GWebPasswordAction g_web_signal_on_submit_cb ( GObject * global )

Request for a usernames choice dialog, as a page was submitted. Signal name: "on-submit"

Parameters:

global

The global browser instance

Returns:: The GWebPasswordAction chosen by the user.

gint g_web_signal_select_match	(	GObject *	global,
		gpointer	info
	)

Callback that Engine uses when multiple username/password entries exists when the password storage functionality is activated. Signal name: "select-match"

Parameters:

	global	The global browser instance
	info	Containing the different usernames.

Returns:: The selected username index

GWebStatus g_web_store_personal_data	(	GWeb *	self,
		const gchar *	server,
		const gchar *	username,
		const gchar *	password
	)

Store personal data. Should be used for authentication dialogs, the forms data is saved via the on-submit signal return value.

Parameters:

	self	Object pointer
	server	The server.
	username	The username.
	password	The password.

Returns:: G_WEB_STATUS_OK on success.

Definition at line 497 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_store_transfers ( GWeb * self )

Store the state of all transfers. The transfers are typically stored just before closing down the browser so that the transfers can be restored and continued the next time the browser is started.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 398 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_suspend ( GWeb * self )

Suspend the browser and reclaims the memory.

Parameters:

self

Object pointer

Returns:: G_WEB_STATUS_OK on success.

Definition at line 349 of file gweb.c.

References G_WEB_GET_CLASS.

gboolean g_web_suspended ( GWeb * self )

Check if browser was suspended.

Parameters:

self

Object pointer

Returns:: TRUE, if browser was suspended, FALSE otherwise

Definition at line 355 of file gweb.c.

References G_WEB_GET_CLASS.

void g_web_username_matchinfo_delete	(	GWeb *	self,
		GObject *	info,
		gint	index
	)

Delete the n:th item from the password storage.

Parameters:

	self	Object pointer
	info	The pasword storage struct info.
	index	The index

Definition at line 485 of file gweb.c.

References G_WEB_GET_CLASS.

gint g_web_username_matchinfo_get_matches	(	GWeb *	self,
		GObject *	info
	)

Get the number of stored username/password sets stored for a forms element or all forms elements at a server.

Parameters:

	self	Object pointer
	info	The struct that has been emitted from the engine.

Returns:: The number of matches, or -1 if an error has occurred.

Definition at line 473 of file gweb.c.

References G_WEB_GET_CLASS.

GWebStatus g_web_username_matchinfo_get_username	(	GWeb *	self,
		GObject *	info,
		gint	index,
		gchar **	username
	)

Get the username of the n:th match.

Parameters:

	self	Object pointer
	info	The pasword storage struct info.
	index	The index.
	username	Return argument for the username. The string must be freed using g_free().

Returns:: G_WEB_STATUS_OK on success.

Definition at line 479 of file gweb.c.

References G_WEB_GET_CLASS.

Generated on Tue Sep 25 10:37:04 2007 for browser-eal by

1.5.1


Data Structures
struct	_GWebIface
Defines
#define	G_TYPE_WEB (g_web_get_type ())
#define	G_WEB(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_WEB, GWeb))
#define	G_WEB_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), G_TYPE_WEB, GWebIface))
#define	G_IS_WEB(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_WEB))
#define	G_IS_WEB_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), G_TYPE_WEB))
#define	G_WEB_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_WEB, GWebIface))
#define	G_WEB_SIGNAL_MODAL_DIALOG "modal-dialog"
#define	G_WEB_SIGNAL_ASK_COOKIE "ask-cookie"
#define	G_WEB_SIGNAL_CERTIFICATE_DIALOG "certificate-dialog"
#define	G_WEB_SIGNAL_CERTIFICATE_PASSWORD_DIALOG "certificate-password-dialog"
#define	G_WEB_SIGNAL_CERTIFICATE_DETAILS "certificate-details"
#define	G_WEB_SIGNAL_ON_SELECT "on-submit"
#define	G_WEB_SIGNAL_SELECT_MATCH "select-match"
Typedefs
typedef _GWeb	GWeb
typedef _GWebIface	GWebIface
Enumerations
enum	GCookieAcceptance { G_ACCEPT_COOKIE_ALWAYS = 0, G_ACCEPT_COOKIE_PROMPT, G_ACCEPT_COOKIE_NEVER }
enum	GPopupAcceptance { G_ACCEPT_POPUP_ALWAYS = 0, G_ACCEPT_POPUP_PROMPT, G_ACCEPT_POPUP_NEVER }
enum	GCallbackAction { G_CALLBACK_NO_ACTION = 0, G_CALLBACK_OOM_ACTION = 1, G_CALLBACK_RESET_ACTION = 2 }
enum	GMemoryCache { G_MEMORY_CACHE_AUTOMATIC = 0, G_MEMORY_CACHE_LARGE, G_MEMORY_CACHE_MEDIUM, G_MEMORY_CACHE_DEFAULT, G_MEMORY_CACHE_SMALL, G_MEMORY_CACHE_OFF }
Functions
GType	g_web_get_type (void)
void	g_web_destroy (GWeb *self)
GWebEngine *	g_web_new_web_engine_window (GWeb *self)
GWebEngine *	g_web_new_web_engine_window_with_context (GWeb *self, gpointer context, gboolean leave_tracks, gboolean without_history)
GWebTransferItem *	g_web_new_web_transfer_item (GWeb self, const gchar url, const gchar *filename)
GWebTransferItem *	g_web_initialize_web_transfer_item (GWeb self, GObject web_transfer_item)
GWebTransferItemList *	g_web_get_web_transfer_item_list (GWeb *self)
GWebStatus	g_web_set_home_page (GWeb self, const gchar home_page)
gchar *	g_web_get_home_page (GWeb *self)
GWebStatus	g_web_set_language (GWeb self, const gchar language)
gchar *	g_web_get_language (GWeb *self)
void	g_web_reset_cache_history_length (GWeb *self)
gint	g_web_get_maximum_cache_size (GWeb *self)
GWebStatus	g_web_set_default_home_page (GWeb self, const gchar default_page)
gchar *	g_web_get_default_home_page (GWeb *self)
gboolean	g_web_home_page_set (GWeb *self)
void	g_web_set_frame_borders_enabled (GWeb *self, gboolean enabled)
gboolean	g_web_get_frame_borders_enabled (GWeb *self)
GWebStatus	g_web_set_location_completion_suffixes (GWeb self, const gchar suffixes)
gchar *	g_web_get_location_completion_suffixes (GWeb *self)
GWebStatus	g_web_set_plugins_enabled (GWeb *self, gboolean enabled)
GWebStatus	g_web_set_ssl2_support (GWeb *self, gboolean enabled)
gboolean	g_web_get_ssl2_support (GWeb *self)
gboolean	g_web_get_plugins_enabled (GWeb *self)
GWebStatus	g_web_set_js_enabled (GWeb *self, gboolean enabled)
gboolean	g_web_get_js_enabled (GWeb *self)
void	g_web_set_memory_cache (GWeb *self, GMemoryCache acceptance)
GMemoryCache	g_web_get_memory_cache (GWeb *self)
GWebStatus	g_web_set_cache_size (GWeb *self, gint size)
gint	g_web_get_cache_size (GWeb *self)
GWebStatus	g_web_set_browse_offline (GWeb *self, gboolean offline)
gboolean	g_web_get_browse_offline (GWeb *self)
GWebStatus	g_web_set_automatic_redirection_enabled (GWeb *self, gboolean enabled)
gboolean	g_web_get_automatic_redirection_enabled (GWeb *self)
GWebStatus	g_web_set_load_images (GWeb *self, GWebEngineImagePolicy level)
GWebEngineImagePolicy	g_web_get_load_images (GWeb *self)
void	g_web_disconnect (GWeb *self)
GWebStatus	g_web_clear_cache (GWeb *self)
GWebPluginList *	g_web_get_plugins_list (GWeb *self)
GWebHistoryList *	g_web_get_history_list (GWeb *self)
GWebStatus	g_web_set_new_window_loads (GWeb *self, gboolean loads)
gboolean	g_web_get_new_window_loads (GWeb *self)
void	g_web_set_cookie_acceptance (GWeb *self, GCookieAcceptance acceptance)
GCookieAcceptance	g_web_get_cookie_acceptance (GWeb *self)
void	g_web_set_popup_acceptance (GWeb *self, GPopupAcceptance acceptance)
GPopupAcceptance	g_web_get_popup_acceptance (GWeb *self)
GWebStatus	g_web_suspend (GWeb *self)
gboolean	g_web_suspended (GWeb *self)
void	g_web_resume (GWeb *self)
void	g_web_set_ua_string (GWeb self, gchar ua_string)
GWebStatus	g_web_set_user_agent_id (GWeb *self, gint ua_id)
gint	g_web_get_user_agent_id (GWeb *self)
void	g_web_enable_url_loading (GWeb *self, gboolean enable)
void	g_web_free_memory (GWeb *self, gboolean progressive)
GWebStatus	g_web_store_transfers (GWeb *self)
GWebStatus	g_web_restore_transfers (GWeb *self)
GWebStatus	g_web_delete_all_cookies (GWeb *self)
GWebStatus	g_web_confirm_cookie (GWeb *self, gpointer context, gboolean accept, GWebCookieAction action)
GObject *	g_web_get_global (GWeb *self)
GWebCertificateMessage	g_web_get_certificate_enum_message (GWeb self, GObject context)
GWebCertificateReaction	g_web_perform_crtificate_context_action (GWeb self, GObject context, GWebCertificateAction action, GObject *cert)
GWebStatus	g_web_get_certificate_context_iter (GWeb self, GObject context, GObject **iterator)
GObject *	g_web_get_certificate_iter (GWeb self, GObject *iterator)
void	g_web_certificate_iter_free (GWeb self, GObject iterator)
void	g_web_certificate_free (GWeb self, GObject cert)
void	g_web_notify_plugins (GWeb *self, gint event)
gint	g_web_username_matchinfo_get_matches (GWeb self, GObject info)
void	g_web_username_matchinfo_delete (GWeb self, GObject info, gint index)
GWebStatus	g_web_username_matchinfo_get_username (GWeb self, GObject info, gint index, gchar **username)
GWebPasswordManager *	g_web_get_password_manager (GWeb self, const gchar server, gint index)
GWebStatus	g_web_store_personal_data (GWeb self, const gchar server, const gchar username, const gchar password)
GWebStatus	g_web_delete_personal_data (GWeb self, const gchar server, const gchar *username)
GWebStatus	g_web_clear_passwords (GWeb *self)
void	g_web_clear_personal_data (GWeb *self)
GWebStatus	g_web_clear_all_history (GWeb *self)
GWebStatus	g_web_set_remember_password (GWeb *self, gboolean rpassword)
gboolean	g_web_get_remember_password (GWeb *self)
GWebStatus	g_web_set_remember_password_for_forms (GWeb *self, gboolean rpassword)
gboolean	g_web_get_remember_password_for_forms (GWeb *self)
GWebStatus	g_web_set_plugin_enabled (GWeb self, gchar name, gboolean enabled)
GWebStatus	g_web_set_oom_cb (GWeb *self, GFunc func)
gboolean	g_web_get_plugin_enabled (GWeb self, gchar name)
GWebStatus	g_web_set_plugin_ignore_filepath (GWeb *self)
GWebDialogButton	g_web_signal_modal_dialog (GObject global, const gchar caption, const gchar *message, GWebDialogMessageType type, GWebDialogButton button1, GWebDialogButton button2, GWebDialogButton button3)
void	g_web_signal_ask_cookie (GObject global, gpointer context, gint actions, const gchar url, const gchar name, const gchar value, const gchar domain, const gchar path, gboolean illegal_path)
gboolean	g_web_signal_certificate_dialog (GObject *global, gpointer ctx)
void	g_web_signal_certificate_password_dialog (GObject global, const gchar title, const gchar text, gchar *password)
void	g_web_signal_certificate_details (GObject *global, gpointer details)
GWebPasswordAction	g_web_signal_on_submit_cb (GObject *global)
gint	g_web_signal_select_match (GObject *global, gpointer info)

browser-eal/include/gweb.h File Reference

Data Structures

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation