browser-eal/include/gwebwidget.h File Reference

#include <glib-object.h>
#include "gwebcommon.h"

Include dependency graph for gwebwidget.h:

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

Go to the source code of this file.

Defines

#define G_WEBWIDGET_SIGNAL_URL_CHANGED   "url_changed"
#define G_WEBWIDGET_SIGNAL_TITLE   "title_changed"
#define G_WEBWIDGET_SIGNAL_START_LOADING   "start_loading"
#define G_WEBWIDGET_SIGNAL_FINISHED_LOADING   "finished_loading"
#define G_WEBWIDGET_SIGNAL_LOADING_PROGRESS   "loading_progress"
#define G_WEBWIDGET_SIGNAL_SECURITY_MODE_CHANGED   "security_mode_changed"
#define G_WEBWIDGET_SIGNAL_AUTHENTIFICATION_REQUIRED   "authentication_required"
#define G_WEBWIDGET_SIGNAL_ALERT   "alert"
#define G_WEBWIDGET_SIGNAL_CONFIRM   "confirm"
#define G_WEBWIDGET_SIGNAL_PROMPT   "prompt"
#define G_WEBWIDGET_SIGNAL_MAILTO   "mailto"
#define G_WEBWIDGET_SIGNAL_UNKNOWN_PROTOCOL   "unknown_protocol"
#define G_WEBWIDGET_SIGNAL_CLOSE_WINDOW   "close_window"
#define G_WEBWIDGET_SIGNAL_WINDOW_REQUEST   "window_request"
#define G_WEBWIDGET_SIGNAL_DOWNLOAD_REQUEST   "download_request"
#define G_WEBWIDGET_SIGNAL_RAISE_REQUEST   "raise_request"
#define G_WEBWIDGET_SIGNAL_LOWER_REQUEST   "lower_request"
#define G_WEBWIDGET_SIGNAL_UPLOAD_DIALOG   "upload_dialog"
#define G_WEBWIDGET_SIGNAL_FILE_UPLOAD_STARTED   "file_upload_started"
#define G_WEBWIDGET_SIGNAL_FILE_UPLOAD_PROGRESS   "file_upload_progress"
#define G_WEBWIDGET_SIGNAL_FILE_UPLOAD_FINISHED   "file_upload_finished"
#define G_WEBWIDGET_SIGNAL_WEBENGINE_POPUP_MENU   "webengine_popup_menu"
#define G_WEBWIDGET_SIGNAL_EXTERNAL_ACTION   "external_action"
#define G_WEBWIDGET_SIGNAL_MODAL_DIALOG   "modal_dialog"
#define G_WEBWIDGET_SIGNAL_ENCODING   "encoding"
#define G_WEBWIDGET_SIGNAL_FRAME_STACKING_CHANGED   "frame_stacking_changed"
#define G_WEBWIDGET_SIGNAL_MODAL_CERTIFICATE_DIALOG   "modal-certificate-dialog"
#define G_WEBWIDGET_SIGNAL_RSS_REQUEST   "rss-request"

Functions

void g_web_widget_signal_url_changed (GObject *browser_window, const gchar *url)
void g_web_widget_signal_title (GObject *engine_widget, const gchar *title, GObject *browser_window)
void g_web_widget_signal_start_loading (GObject *engine_widget, const gchar *url, GObject *browser_window)
void g_web_widget_signal_finished_loading (GObject *engine_widget, gint finish_status, gint page_size, gboolean has_frames, GObject *browser_window)
void g_web_widget_signal_loading_progress (GObject *browser_window, gint loaded_images, gint total_images)
void g_web_widget_signal_security_mode_changed (GObject *engine_widget, gint mode, GObject *browser_window)
void g_web_widget_signal_authentication_required (GObject *engine_widget, gint authentication_type, const gchar *server, const gchar *message, GObject *browser_window)
void g_web_widget_signal_alert (GObject *engine_widget, const gchar *message, GObject *browser_window)
gboolean g_web_widget_signal_confirm (GObject *engine_widget, const gchar *message, GObject *browser_window)
gchar * g_web_widget_signal_prompt (GObject *engine_widget, const gchar *message, const gchar *default_value, GObject *browser_window)
void g_web_widget_signal_mailto (GObject *engine_widget, const gchar *url, GObject *browser_window)
void g_web_widget_signal_unknown_protocol (GObject *engine_widget, const gchar *url, GObject *browser_window)
void g_web_widget_signal_close_window (GObject *engine_widget, GObject *browser_window)
void g_web_widget_signal_window_request (GObject *engine_widget, gpointer context, const gchar *url, gboolean in_background, GObject *browser_window)
void g_web_widget_signal_download_request (GObject *engine_widget, const gchar *url, const gchar *suggested_filename, const gchar *mimetype, glong size, gint mode, GObject *browser_window)
void g_web_widget_signal_raise_request (GObject *engine_widget, GObject *browser_window)
void g_web_widget_signal_lower_request (GObject *engine_widget, GObject *browser_window)
gboolean g_web_widget_signal_upload_dialog (GObject *engine_widget, const gchar *path, const gchar *filter, gchar **result, GObject *browser_window)
void g_web_widget_signal_file_upload_started (GObject *engine_widget, GObject *browser_window)
void g_web_widget_signal_file_upload_progress (GObject *engine_widget, gint bytes, const gchar *message, GObject *browser_window)
void g_web_widget_signal_file_upload_finished (GObject *engine_widget, GObject *browser_window)
void g_web_widget_signal_webengine_popup_menu (GObject *engine_widget, guint menutype, gint x, gint y, const gchar *text, const gchar *url, const gchar *image_url, const gchar *frame_url, GObject *browser_window)
void g_web_widget_signal_external_action (GObject *engine_widget, const gchar *action)
GWebDialogButton g_web_widget_signal_modal_dialog (GObject *engine_widget, const gchar *caption, const gchar *message, GWebDialogMessageType type, GWebDialogButton button1, GWebDialogButton button2, GWebDialogButton button3, GObject *browser_window)
void g_web_widget_signal_encoding (GObject *engine_widget, GWebEngineEncoding encoding, GObject *browser_window)
void g_web_widget_signal_frame_stacking_changed (GObject *engine_widget, gboolean on, GObject *browser_window)
GWebDialogButton g_web_widget_signal_modal_certificate_dialog (GObject *engine_widget, const gchar *caption, GWebCertificateMessage message, GWebDialogMessageType type, GWebDialogButton button1, GWebDialogButton button2, GWebDialogButton button3, GObject *browser_window)
void g_web_widget_signal_rss_request (GObject *engine_widget, gchar *url, gchar *title, GObject *browser_window)


Define Documentation

#define G_WEBWIDGET_SIGNAL_ALERT   "alert"

Definition at line 120 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_AUTHENTIFICATION_REQUIRED   "authentication_required"

Definition at line 106 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_CLOSE_WINDOW   "close_window"

Definition at line 174 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_CONFIRM   "confirm"

Definition at line 130 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_DOWNLOAD_REQUEST   "download_request"

Definition at line 202 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_ENCODING   "encoding"

Definition at line 351 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_EXTERNAL_ACTION   "external_action"

Definition at line 310 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_FILE_UPLOAD_FINISHED   "file_upload_finished"

Definition at line 279 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_FILE_UPLOAD_PROGRESS   "file_upload_progress"

Definition at line 267 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_FILE_UPLOAD_STARTED   "file_upload_started"

Definition at line 258 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_FINISHED_LOADING   "finished_loading"

Definition at line 61 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_FRAME_STACKING_CHANGED   "frame_stacking_changed"

Definition at line 360 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_LOADING_PROGRESS   "loading_progress"

Definition at line 77 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_LOWER_REQUEST   "lower_request"

Definition at line 231 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_MAILTO   "mailto"

Definition at line 154 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_MODAL_CERTIFICATE_DIALOG   "modal-certificate-dialog"

Definition at line 371 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_MODAL_DIALOG   "modal_dialog"

Definition at line 329 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_PROMPT   "prompt"

Definition at line 140 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_RAISE_REQUEST   "raise_request"

Definition at line 223 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_RSS_REQUEST   "rss-request"

Definition at line 393 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_SECURITY_MODE_CHANGED   "security_mode_changed"

Definition at line 96 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_START_LOADING   "start_loading"

Definition at line 51 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_TITLE   "title_changed"

Definition at line 41 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_UNKNOWN_PROTOCOL   "unknown_protocol"

Definition at line 164 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_UPLOAD_DIALOG   "upload_dialog"

Definition at line 240 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_URL_CHANGED   "url_changed"

Definition at line 32 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_WEBENGINE_POPUP_MENU   "webengine_popup_menu"

Definition at line 287 of file gwebwidget.h.

#define G_WEBWIDGET_SIGNAL_WINDOW_REQUEST   "window_request"

Definition at line 183 of file gwebwidget.h.


Function Documentation

void g_web_widget_signal_alert ( GObject *  engine_widget,
const gchar *  message,
GObject *  browser_window 
)

An alert dialog was requested

Parameters:
engine_widget Engine widget
message (const gchar*) The message

void g_web_widget_signal_authentication_required ( GObject *  engine_widget,
gint  authentication_type,
const gchar *  server,
const gchar *  message,
GObject *  browser_window 
)

Http authentication is required

Parameters:
engine_widget Engine widget
authenticaion_type a GtkWebEngineAuthenticationType to indicate what kind of authentication was requested
server (const gchar*) The server that requested the authentication
message (const gchar*) A message from the server

void g_web_widget_signal_close_window ( GObject *  engine_widget,
GObject *  browser_window 
)

The widget wants to be closed This method should destroy the widget and all ui that is attached to it (typically a toplevel window with buttons, urlentry etc....)

Parameters:
engine_widget Engine widget

gboolean g_web_widget_signal_confirm ( GObject *  engine_widget,
const gchar *  message,
GObject *  browser_window 
)

A confirm (OK/Cancel) dialog was requested

Parameters:
engine_widget Engine widget
message (const gchar*) The message

void g_web_widget_signal_download_request ( GObject *  engine_widget,
const gchar *  url,
const gchar *  suggested_filename,
const gchar *  mimetype,
glong  size,
gint  mode,
GObject *  browser_window 
)

The browser wants to download this file

The UI should use this information to initiate a transfer using the gtkEngine_transfer api

Parameters:
engine_widget Engine widget
url The url that was requested for download
suggested_filename The suggested filename
mimetype The mimetype
size The size
mode DownloadRequestMode

void g_web_widget_signal_encoding ( GObject *  engine_widget,
GWebEngineEncoding  encoding,
GObject *  browser_window 
)

The page has decided on an encoding

Parameters:
engine_widget Engine widget

void g_web_widget_signal_external_action ( GObject *  engine_widget,
const gchar *  action 
)

An external action (as defined in input.ini) was requested from the browser The external action signal can be added in the [Browser Widget] context. When the browser widget (or any of its children) is focused, this signal will be emitted along with the following string, if key in the definition was pressed.

Example (to be added to input.ini)

[Gtk Widget] Esc = External Action, "Escape was pressed" Esc ctrl = External Action, "Escape and control was pressed"

Parameters:
engine_widget Engine widget
action The description of the action as described in preferences

void g_web_widget_signal_file_upload_finished ( GObject *  engine_widget,
GObject *  browser_window 
)

The file uploading has finished

Parameters:
engine_widget Engine widget

void g_web_widget_signal_file_upload_progress ( GObject *  engine_widget,
gint  bytes,
const gchar *  message,
GObject *  browser_window 
)

File upload progress.

Parameters:
engine_widget Engine widget
bytes The number of bytes sent so far.
message Status message.

void g_web_widget_signal_file_upload_started ( GObject *  engine_widget,
GObject *  browser_window 
)

Started uploading file(s). E.g. The user submited a form containing a file input.

Parameters:
engine_widget Engine widget

void g_web_widget_signal_finished_loading ( GObject *  engine_widget,
gint  finish_status,
gint  page_size,
gboolean  has_frames,
GObject *  browser_window 
)

The pages has finished loading

Parameters:
engine_widget Engine widget
has_frames TRUE if the page is a frameset. FALSE if it's a normal document even if it contains iframe tags and even if those iframes contain documents which themselves are framesets.
finish_status 
page_size 

void g_web_widget_signal_frame_stacking_changed ( GObject *  engine_widget,
gboolean  on,
GObject *  browser_window 
)

Frame stacking mode changed Signal name: "frame-stacking-changed"

Parameters:
engine_widget Engine widget
on TRUE if frame stacking was turned on, false if it was turned off

void g_web_widget_signal_loading_progress ( GObject *  browser_window,
gint  loaded_images,
gint  total_images 
)

Indicate page load progress

Parameters:
engine_widget Engine widget
loaded_images (gint) Nnumber of images, external scripts and other inline elements loaded (or skipped if the loading is turned off) for this page. This gives a crude approximation of how much work has been done and how much is left.
total_images (gint) Total number of images, external scripts and other inline elements on the page. This is the "currently known" number and will change while a HTML document is loaded and parsed.

void g_web_widget_signal_lower_request ( GObject *  engine_widget,
GObject *  browser_window 
)

The browser requests to lower the current window

Parameters:
engine_widget Engine widget
void No parameter to this signal

void g_web_widget_signal_mailto ( GObject *  engine_widget,
const gchar *  url,
GObject *  browser_window 
)

A mailto link was clicked

Parameters:
engine_widget Engine widget
url (const gchar*) The mailto url

GWebDialogButton g_web_widget_signal_modal_certificate_dialog ( GObject *  engine_widget,
const gchar *  caption,
GWebCertificateMessage  message,
GWebDialogMessageType  type,
GWebDialogButton  button1,
GWebDialogButton  button2,
GWebDialogButton  button3,
GObject *  browser_window 
)

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

Parameters:
engine_widget Engine widget
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

GWebDialogButton g_web_widget_signal_modal_dialog ( GObject *  engine_widget,
const gchar *  caption,
const gchar *  message,
GWebDialogMessageType  type,
GWebDialogButton  button1,
GWebDialogButton  button2,
GWebDialogButton  button3,
GObject *  browser_window 
)

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

Parameters:
engine_widget Engine widget
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

gchar* g_web_widget_signal_prompt ( GObject *  engine_widget,
const gchar *  message,
const gchar *  default_value,
GObject *  browser_window 
)

A Ecmascript prompt dialog was requested

Parameters:
engine_widget Engine widget
message (const gchar*) A message
default_value (const gchar*) Default value for the text entry
Returns:
a g_malloced string that Engine will free, or NULL if cancel was pressed

void g_web_widget_signal_raise_request ( GObject *  engine_widget,
GObject *  browser_window 
)

The browser requests to raise the current window

Parameters:
engine_widget Engine widget

void g_web_widget_signal_rss_request ( GObject *  engine_widget,
gchar *  url,
gchar *  title,
GObject *  browser_window 
)

A RSS feed was selected.

Parameters:
engine_widget Engine widget
url (gchar*) The url to the rss feed
title (gchar*) The title of the rss feed

void g_web_widget_signal_security_mode_changed ( GObject *  engine_widget,
gint  mode,
GObject *  browser_window 
)

The security display mode has changed

Parameters:
engine_widget Engine widget
GtkWebEngineSecurityMode) the new security mode

void g_web_widget_signal_start_loading ( GObject *  engine_widget,
const gchar *  url,
GObject *  browser_window 
)

A page has started loading

Parameters:
engine_widget Engine widget
url (const gchar*) The url that started to load

void g_web_widget_signal_title ( GObject *  engine_widget,
const gchar *  title,
GObject *  browser_window 
)

The page title changed

Parameters:
engine_widget Engine widget
title The new title of the page

void g_web_widget_signal_unknown_protocol ( GObject *  engine_widget,
const gchar *  url,
GObject *  browser_window 
)

A link with an unknown protocol was clicked

Parameters:
engine_widget Engine widget
url (const gchar*) The unknown url

gboolean g_web_widget_signal_upload_dialog ( GObject *  engine_widget,
const gchar *  path,
const gchar *  filter,
gchar **  result,
GObject *  browser_window 
)

Called when an upload dialog is requested Signal name: "upload-dialog"

Parameters:
engine_widget Engine widget
path The default path
filter The default filter
result Pointer to where the file name should be saved. The implementor must allocate the space with g_malloc, it will be freed inside Engine.
Returns:
TRUE if OK was pressed

void g_web_widget_signal_url_changed ( GObject *  browser_window,
const gchar *  url 
)

The browser changed the current url, for example slashdot.org -> http://www.slashdot.org

Parameters:
engine The engine
url (const gchar*) The new url

void g_web_widget_signal_webengine_popup_menu ( GObject *  engine_widget,
guint  menutype,
gint  x,
gint  y,
const gchar *  text,
const gchar *  url,
const gchar *  image_url,
const gchar *  frame_url,
GObject *  browser_window 
)

A popup-menu was requested Signal name: "webengine-popup-menu"

Parameters:
engine_widget Engine widget
menutype Which type of menu, GWebEnginePopupMenuType
x X point of popup-menu
y Y point of popup-menu
text The text that was clicked
url The URL that was clicked
image_url The URL of the image that was clicked
frame_url The URL of the frame in focus

void g_web_widget_signal_window_request ( GObject *  engine_widget,
gpointer  context,
const gchar *  url,
gboolean  in_background,
GObject *  browser_window 
)

Callback function that Engine uses to request a new browser window Signal name: "window-request"

Parameters:
engine_widget Engine widget
context. If this is non-NULL, Engine has already created a context for this window to use. Use this context when creating a new widget If Engine has already created a context for the window to use, the other parameters may be overridden by Engine.
url Url to load
in_background True if Engine wants to open this window in the background
unrequested True if opening of the window wasn't requested by the user.


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