![]() |
![]() |
![]() |
WebKitClutter Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
AtkObject; ClutterActor; WebKitWebPage; enum WebKitWebPagePageMode; GType webkit_web_page_get_type (void
); WebKitWebPage * webkit_web_page_new (WebKitIWebView *web_page
); WebKitIWebView * webkit_web_page_get_view (WebKitWebPage *Param1
); WebKitWebFrame * webkit_web_page_get_main_frame (WebKitWebPage *web_page
); void webkit_web_page_get_viewport_size (WebKitWebPage *webPage
,int *width
,int *height
); void webkit_web_page_set_viewport_size (WebKitWebPage *webPage
,const int width
,const int height
); void webkit_web_page_reload (WebKitWebPage *web_page
); void webkit_web_page_reload_bypass_cache (WebKitWebPage *web_page
); void webkit_web_page_load_uri (WebKitWebPage *web_page
,const gchar *uri
); void webkit_web_page_load_string (WebKitWebPage *webPage
,const gchar *content
,const gchar *mimeType
,const gchar *encoding
,const gchar *baseUri
); void webkit_web_page_load_request (WebKitWebPage *web_page
,WebKitNetworkRequest *request
); gboolean webkit_web_page_search_text (WebKitWebPage *web_page
,const gchar *text
,gboolean case_sensitive
,gboolean forward
,gboolean wrap
); guint webkit_web_page_mark_text_matches (WebKitWebPage *web_page
,const gchar *string
,gboolean case_sensitive
,guint limit
); void webkit_web_page_set_highlight_text_matches (WebKitWebPage *web_page
,gboolean highlight
); void webkit_web_page_unmark_text_matches (WebKitWebPage *web_page
); void webkit_web_page_set_settings (WebKitWebPage *web_page
,WebKitWebSettings *settings
); WebKitWebSettings * webkit_web_page_get_settings (WebKitWebPage *web_page
); WebKitWebInspector * webkit_web_page_get_inspector (WebKitWebPage *web_page
); WebKitLoadStatus webkit_web_page_get_load_status (WebKitWebPage *web_page
); gdouble webkit_web_page_get_progress (WebKitWebPage *web_page
); gboolean webkit_web_page_can_go_back (WebKitWebPage *web_page
); gboolean webkit_web_page_can_go_back_or_forward (WebKitWebPage *web_page
,gint steps
); gboolean webkit_web_page_can_go_forward (WebKitWebPage *web_page
); void webkit_web_page_go_back (WebKitWebPage *web_page
); void webkit_web_page_go_back_or_forward (WebKitWebPage *web_page
,gint steps
); void webkit_web_page_go_forward (WebKitWebPage *web_page
); void webkit_web_page_set_maintains_back_forward_list (WebKitWebPage *web_page
,gboolean flag
); WebKitWebBackForwardList * webkit_web_page_get_back_forward_list (WebKitWebPage *web_page
); gboolean webkit_web_page_go_to_back_forward_item (WebKitWebPage *web_page
,WebKitWebHistoryItem *item
); AtkObject * webkit_web_page_get_accessible (WebKitWebPage *page
); void webkit_web_page_stop_loading (WebKitWebPage *web_page
); const gchar * webkit_web_page_get_title (WebKitWebPage *web_page
); const char * webkit_web_page_get_uri (WebKitWebPage *web_page
); WebKitWebWindowFeatures * webkit_web_page_get_window_features (WebKitWebPage *webPage
); WebKitDOMDocument * webkit_web_page_get_dom_document (WebKitWebPage *webPage
); WebKitHitTestResult * webkit_web_page_hit_test (WebKitWebPage *webPage
,int x
,int y
); WebKitHitTestResult * webkit_web_page_hit_test_rectangle (WebKitWebPage *webPage
,int x
,int y
,guint topPadding
,guint bottomPadding
,guint leftPadding
,guint rightPadding
); gboolean webkit_web_page_get_full_content_zoom (WebKitWebPage *web_page
); void webkit_web_page_set_full_content_zoom (WebKitWebPage *web_page
,gboolean full_content_zoom
); gfloat webkit_web_page_get_zoom_level (WebKitWebPage *web_page
); void webkit_web_page_set_zoom_level (WebKitWebPage *web_page
,gfloat zoom_level
); void webkit_web_page_zoom_in (WebKitWebPage *web_page
); void webkit_web_page_zoom_out (WebKitWebPage *web_page
); WebKitWebFrame * webkit_web_page_get_focused_frame (WebKitWebPage *webPage
); void webkit_web_page_execute_script (WebKitWebPage *webPage
,const gchar *script
); const gchar * webkit_web_page_get_icon_uri (WebKitWebPage *web_page
); gboolean webkit_web_page_get_editable (WebKitWebPage *web_page
); void webkit_web_page_set_editable (WebKitWebPage *web_page
,gboolean flag
); gboolean webkit_web_page_can_show_mime_type (WebKitWebPage *web_page
,const gchar *mime_type
); const gchar * webkit_web_page_get_encoding (WebKitWebPage *webPage
); void webkit_web_page_set_custom_encoding (WebKitWebPage *webPage
,const gchar *encoding
); const char * webkit_web_page_get_custom_encoding (WebKitWebPage *webPage
); void webkit_web_page_set_page_mode (WebKitWebPage *web_page
,WebKitWebPagePageMode mode
); WebKitWebPagePageMode webkit_web_page_get_page_mode (WebKitWebPage *web_page
); void webkit_web_page_load_image (WebKitWebPage *webPage
,const gchar *url
); gboolean webkit_web_page_get_use_fixed_layout (WebKitWebPage *webPage
); void webkit_web_page_set_use_fixed_layout (WebKitWebPage *webPage
,gboolean used
); guint webkit_web_page_get_fixed_layout_width (WebKitWebPage *webPage
); void webkit_web_page_set_fixed_layout_width (WebKitWebPage *webPage
,guint width
); guint webkit_web_page_get_fixed_layout_height (WebKitWebPage *webPage
); void webkit_web_page_set_fixed_layout_height (WebKitWebPage *webPage
,guint height
); WebKitDOMElement * (*ChooseElementToZoomCallback) (GSList *candidates
,void *userData
); bool webkit_web_page_get_zoom_target (WebKitWebPage *webPage
,float x
,float y
,int *zoomCenterX
,int *zoomCenterY
,double *zoomFactor
,ChooseElementToZoomCallback callback
,void *userData
);
GObject +----GInitiallyUnowned +----ClutterActor +----MxWidget +----ClutterTexture
GObject +----WebKitWebPage
ClutterActor implements ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.
"fixed-layout-height" guint : Read / Write "fixed-layout-width" guint : Read / Write "icon-uri" gchar* : Read "load-status" WebKitLoadStatus : Read "progress" gdouble : Read "settings" WebKitWebSettings* : Read / Write "title" gchar* : Read "uri" gchar* : Read "use-fixed-layout" gboolean : Read / Write "web-inspector" WebKitWebInspector* : Read "web-view" WebKitIWebView* : Read / Write / Construct Only "window-features" WebKitWebWindowFeatures* : Read / Write "zoom-level" gfloat : Read / Write
"console-message" :Run Last
"create-window" :Run Last
"database-quota-exceeded" :Action
"document-load-finished" :Action
"download-requested" :Run Last
"frame-created" :Action
"geolocation-policy-decision-cancelled" :Run Last
"geolocation-policy-decision-requested" :Run Last
"hovering-over-link" :Run Last
"icon-loaded" :Run Last
"input-method-state-set" :Run Last
"inspection-requested" :Run Last
"microfocus-changed" :Run Last
"mime-type-policy-decision-requested" :Run Last
"navigation-policy-decision-requested" :Run Last
"new-window-policy-decision-requested" :Run Last
"onload-event" :Run Last
"resource-request-starting" :Action
"script-alert" :Run Last
"script-confirm" :Run Last
"script-prompt" :Run Last
"should-interrupt-script" :Run Last
"status-bar-text-changed" :Run Last
"title-changed" :Run Last
"web-load-error" :Run Last
"web-load-finished" :Run Last
"web-load-started" :Run Last
"web-page-ready" :Run Last
"window-object-cleared" :Run Last
typedef enum { WEBKIT_WEB_PAGE_PAGE_MODE_WINDOWED, WEBKIT_WEB_PAGE_PAGE_MODE_FLOATING, WEBKIT_WEB_PAGE_PAGE_MODE_FULLSCREEN, WEBKIT_WEB_PAGE_PAGE_MODE_MAXIMIZED, WEBKIT_WEB_PAGE_PAGE_MODE_MINIMIZED } WebKitWebPagePageMode;
Update dscription.
WebKitWebFrame * webkit_web_page_get_main_frame (WebKitWebPage *web_page
);
void webkit_web_page_get_viewport_size (WebKitWebPage *webPage
,int *width
,int *height
);
void webkit_web_page_set_viewport_size (WebKitWebPage *webPage
,const int width
,const int height
);
void webkit_web_page_reload (WebKitWebPage *web_page
);
Reloads the web_page
.
|
a WebKitWebPage |
void webkit_web_page_reload_bypass_cache (WebKitWebPage *web_page
);
Reloads the web_page
without using any cached data.
|
a WebKitWebPage |
void webkit_web_page_load_uri (WebKitWebPage *web_page
,const gchar *uri
);
Requests loading of the specified URI string.
|
a WebKitWebPage |
|
an URI string |
void webkit_web_page_load_string (WebKitWebPage *webPage
,const gchar *content
,const gchar *mimeType
,const gchar *encoding
,const gchar *baseUri
);
Requests loading of the given content
with the specified mimeType
,
encoding
and baseUri
.
If mimeType
is NULL
, "text/html" is assumed.
If encoding
is NULL
, "UTF-8" is assumed.
|
a WebKitWebPage |
|
an URI string |
|
the MIME type, or NULL
|
|
the encoding, or NULL
|
|
the base URI for relative locations |
void webkit_web_page_load_request (WebKitWebPage *web_page
,WebKitNetworkRequest *request
);
Requests loading of the specified asynchronous client request.
Creates a provisional data source that will transition to a committed data
source once any data has been received. Use webkit_web_page_stop_loading()
to
stop the load.
|
a WebKitWebPage |
|
a WebKitNetworkRequest |
gboolean webkit_web_page_search_text (WebKitWebPage *web_page
,const gchar *text
,gboolean case_sensitive
,gboolean forward
,gboolean wrap
);
Looks for a specified string inside web_page.
|
a WebKitWebPage |
|
a string to look for |
|
whether to respect the case of text |
|
whether to find forward or not |
|
whether to continue looking at the beginning after reaching the end |
Returns : |
TRUE on success or FALSE on failure |
guint webkit_web_page_mark_text_matches (WebKitWebPage *web_page
,const gchar *string
,gboolean case_sensitive
,guint limit
);
Attempts to highlight all occurances of string inside web_page.
|
a WebKitWebPage |
|
a string to look for |
|
whether to respect the case of text |
|
the maximum number of strings to look for or 0 for all |
Returns : |
the number of strings highlighted |
void webkit_web_page_set_highlight_text_matches (WebKitWebPage *web_page
,gboolean highlight
);
Highlights text matches previously marked by webkit_web_page_mark_text_matches.
|
a WebKitWebPage |
|
whether to highlight text matches |
void webkit_web_page_unmark_text_matches (WebKitWebPage *web_page
);
Removes highlighting previously set by webkit_web_page_mark_text_matches.
|
a WebKitWebPage |
void webkit_web_page_set_settings (WebKitWebPage *web_page
,WebKitWebSettings *settings
);
Replaces the WebKitWebSettings instance that is currently attached
to web_page
with settings
. The reference held by the web_page
on
the old WebKitWebSettings instance is dropped, and the reference
count of settings
is increased.
The settings are automatically applied to web_page
.
|
a WebKitWebPage |
|
the WebKitWebSettings to be set. [transfer none] |
WebKitWebSettings * webkit_web_page_get_settings (WebKitWebPage *web_page
);
Obtains the WebKitWebSettings associated with the WebKitWebPage. The WebKitWebPage always has an associated instance of WebKitWebSettings. The reference that is returned by this call is owned by the WebKitWebPage. You may need to increase its reference count if you intend to keep it alive for longer than the WebKitWebPage.
|
a WebKitWebPage |
Returns : |
the WebKitWebSettings instance. [transfer none] |
WebKitWebInspector * webkit_web_page_get_inspector (WebKitWebPage *web_page
);
Obtains the WebKitWebInspector associated with the WebKitWebPage. Every WebKitWebPage object has a WebKitWebInspector object attached to it as soon as it is created, so this function will only return NULL if the argument is not a valid WebKitWebPage.
|
a WebKitWebPage |
Returns : |
the WebKitWebInspector instance. [transfer none] |
WebKitLoadStatus webkit_web_page_get_load_status (WebKitWebPage *web_page
);
Determines the current status of the load.
|
a WebKitWebPage |
Returns : |
the WebKitLoadStatus. |
gdouble webkit_web_page_get_progress (WebKitWebPage *web_page
);
Determines the current progress of the load.
FIXME: Update below comment.
|
a WebKitWebPage |
Returns : |
TRUE or FALSE . |
gboolean webkit_web_page_can_go_back (WebKitWebPage *web_page
);
Determines whether web_page has a previous history item.
|
a WebKitWebPage |
Returns : |
TRUE if able to move back, FALSE otherwise |
gboolean webkit_web_page_can_go_back_or_forward (WebKitWebPage *web_page
,gint steps
);
Determines whether web_page has a history item of steps
. Negative values
represent steps backward while positive values represent steps forward.
|
a WebKitWebPage |
|
the number of steps |
Returns : |
TRUE if able to move back or forward the given number of
steps, FALSE otherwise |
gboolean webkit_web_page_can_go_forward (WebKitWebPage *web_page
);
Determines whether web_page has a next history item.
|
a WebKitWebPage |
Returns : |
TRUE if able to move forward, FALSE otherwise |
void webkit_web_page_go_back (WebKitWebPage *web_page
);
Loads the previous history item.
|
a WebKitWebPage |
void webkit_web_page_go_back_or_forward (WebKitWebPage *web_page
,gint steps
);
Loads the history item that is the number of steps
away from the current
item. Negative values represent steps backward while positive values
represent steps forward.
|
a WebKitWebPage |
|
the number of steps |
void webkit_web_page_go_forward (WebKitWebPage *web_page
);
Loads the next history item.
|
a WebKitWebPage |
void webkit_web_page_set_maintains_back_forward_list (WebKitWebPage *web_page
,gboolean flag
);
Set the page to maintain a back or forward list of history items.
|
a WebKitWebPage |
|
to tell the page to maintain a back or forward list |
WebKitWebBackForwardList * webkit_web_page_get_back_forward_list
(WebKitWebPage *web_page
);
Obtains the WebKitWebBackForwardList associated with the given WebKitWebPage. The WebKitWebBackForwardList is owned by the WebKitWebPage.
|
a WebKitWebPage |
Returns : |
the WebKitWebBackForwardList. [transfer none] |
gboolean webkit_web_page_go_to_back_forward_item (WebKitWebPage *web_page
,WebKitWebHistoryItem *item
);
Go to the specified WebKitWebHistoryItem
|
a WebKitWebPage |
|
a WebKitWebHistoryItem* |
Returns : |
TRUE if loading of item is successful, FALSE if not |
void webkit_web_page_stop_loading (WebKitWebPage *web_page
);
Stops any ongoing load in the web_page
.
|
a WebKitWebPage |
const gchar * webkit_web_page_get_title (WebKitWebPage *web_page
);
Return the web_page
's document title
|
a WebKitWebPage |
Returns : |
the title of web_page
|
const char * webkit_web_page_get_uri (WebKitWebPage *web_page
);
Return the current URI of the contents displayed by the web_page
|
a WebKitWebPage |
Returns : |
the URI of web_page
|
WebKitWebWindowFeatures * webkit_web_page_get_window_features
(WebKitWebPage *webPage
);
Return the instance of WebKitWebWindowFeatures held by the given WebKitWebPage.
|
a WebKitWebPage |
Returns : |
the WebKitWebWindowFeatures. [transfer none] |
WebKitDOMDocument * webkit_web_page_get_dom_document (WebKitWebPage *webPage
);
|
a WebKitWebPage |
Returns : |
the WebKitDOMDocument currently loaded in the webPage . [transfer none]
|
WebKitHitTestResult * webkit_web_page_hit_test (WebKitWebPage *webPage
,int x
,int y
);
Does a 'hit test' in the coordinates specified by x
and y
to figure
out context information about that position in the webPage
.
|
a WebKitWebPage |
|
the X coordinate of the test, relative to the viewport |
|
the Y coordinate of the test, relative to the viewport |
Returns : |
a newly created WebKitHitTestResult with the context of the specified position. [transfer none] |
WebKitHitTestResult * webkit_web_page_hit_test_rectangle (WebKitWebPage *webPage
,int x
,int y
,guint topPadding
,guint bottomPadding
,guint leftPadding
,guint rightPadding
);
Does a 'hit test' in the coordinates specified by x
and y
and the
surrounding area provided by the padding arguments to figure out
context information about that position in the webPage
.
|
a WebKitWebPage |
|
the X coordinate of the test, relative to the viewport |
|
the Y coordinate of the test, relative to the viewport |
|
the number of pixels to consider above the hit test point |
|
the number of pixels to consider bellow the hit test point |
|
the number of pixels to consider to the left the hit test point |
|
the number of pixels to consider to the right the hit test point |
Returns : |
a newly created GList with WebKitHitTestResult objects as the elements with the context of the specified position. |
gboolean webkit_web_page_get_full_content_zoom
(WebKitWebPage *web_page
);
void webkit_web_page_set_full_content_zoom (WebKitWebPage *web_page
,gboolean full_content_zoom
);
gfloat webkit_web_page_get_zoom_level (WebKitWebPage *web_page
);
Return the zoom level of web_page
, i.e. the factor by which elements in
the page are scaled with respect to their original size.
|
a WebKitWebPage |
Returns : |
the zoom level of web_page
|
void webkit_web_page_set_zoom_level (WebKitWebPage *web_page
,gfloat zoom_level
);
Sets the zoom level of web_page
, i.e. the factor by which elements in
the page are scaled with respect to their original size.
|
a WebKitWebPage |
|
the new zoom level |
void webkit_web_page_zoom_in (WebKitWebPage *web_page
);
Increases the zoom level of web_page
. The current zoom
level is incremented by the value of the "zoom-step"
property of the WebKitWebSettings associated with web_page
.
|
a WebKitWebPage |
void webkit_web_page_zoom_out (WebKitWebPage *web_page
);
Decreases the zoom level of web_page
. The current zoom
level is decremented by the value of the "zoom-step"
property of the WebKitWebSettings associated with web_page
.
|
a WebKitWebPage |
WebKitWebFrame * webkit_web_page_get_focused_frame (WebKitWebPage *webPage
);
Return the frame that has focus or an active text selection.
|
a WebKitWebPage |
Returns : |
The focused WebKitWebFrame or NULL if no frame is focused. [transfer none]
|
void webkit_web_page_execute_script (WebKitWebPage *webPage
,const gchar *script
);
This is a convenience to run very simple scripts in the context of the main frame of a given page. If your needs are more complex you should use the JavaScripCore API or the DOM bindings instead.
|
the WebKitWebPage |
|
a string containing the script to be executed |
const gchar * webkit_web_page_get_icon_uri (WebKitWebPage *web_page
);
Obtains the URI for the favicon for the given WebKitWebPage, or
NULL
if there is none.
|
the WebKitWebPage object |
Returns : |
the URI for the favicon, or NULL
|
gboolean webkit_web_page_get_editable (WebKitWebPage *web_page
);
Return whether the user is allowed to edit the document.
Returns TRUE
if web_page
allows the user to edit the HTML document, FALSE
if
it doesn't. You can change web_page
's document programmatically regardless of
this setting using the DOM bindings or JavaScriptCore.
|
a WebKitWebPage |
Returns : |
a gboolean indicating the editable state |
void webkit_web_page_set_editable (WebKitWebPage *web_page
,gboolean flag
);
Sets whether web_page
allows the user to edit its HTML document.
If flag
is TRUE
, web_page
allows the user to edit the document. If flag
is
FALSE
, an element in web_page
's document can only be edited if the
CONTENTEDITABLE attribute has been set on the element or one of its parent
elements. You can change web_page
's document programmatically regardless of
this setting. By default a WebKitWebPage is not editable.
Normally, an HTML document is not editable unless the elements within the document are editable. This function provides a low-level way to make the contents of a WebKitWebPage editable without altering the document or DOM structure.
|
a WebKitWebPage |
|
a gboolean indicating the editable state |
gboolean webkit_web_page_can_show_mime_type (WebKitWebPage *web_page
,const gchar *mime_type
);
This functions returns whether or not a MIME type can be displayed using this page.
|
a WebKitWebPage |
|
a MIME type |
Returns : |
a gboolean indicating if the MIME type can be displayed |
const gchar * webkit_web_page_get_encoding (WebKitWebPage *webPage
);
Return the default encoding of the WebKitWebPage.
|
a WebKitWebPage |
Returns : |
the default encoding |
void webkit_web_page_set_custom_encoding (WebKitWebPage *webPage
,const gchar *encoding
);
Sets the current WebKitWebPage encoding, without modifying the default one, and reloads the page.
|
a WebKitWebPage |
|
the new encoding, or NULL to restore the default encoding |
const char * webkit_web_page_get_custom_encoding (WebKitWebPage *webPage
);
Returns the current encoding of the WebKitWebPage, not the default-encoding of WebKitWebSettings.
|
a WebKitWebPage |
Returns : |
a string containing the current custom encoding for webPage , or NULL if there's none set. |
void webkit_web_page_set_page_mode (WebKitWebPage *web_page
,WebKitWebPagePageMode mode
);
Sets the page-mode property of the WebKitWebPage. Check the property's documentation for more information.
|
the WebKitWebPage that will have its page mode set |
|
the WebKitWebPagePageMode to be set |
WebKitWebPagePageMode webkit_web_page_get_page_mode (WebKitWebPage *web_page
);
Gets the value of the page-mode property of the WebKitWebPage. Check the property's documentation for more information.
|
the WebKitWebPage to obtain the page mode from |
Returns : |
the WebKitWebPagePageMode currently set for the
WebKitWebPage. |
void webkit_web_page_load_image (WebKitWebPage *webPage
,const gchar *url
);
Starts loading the image at url
, if it hadn't been loaded already.
|
a WebKitWebPage |
|
url of the image to load |
gboolean webkit_web_page_get_use_fixed_layout
(WebKitWebPage *webPage
);
void webkit_web_page_set_use_fixed_layout (WebKitWebPage *webPage
,gboolean used
);
guint webkit_web_page_get_fixed_layout_width
(WebKitWebPage *webPage
);
void webkit_web_page_set_fixed_layout_width (WebKitWebPage *webPage
,guint width
);
guint webkit_web_page_get_fixed_layout_height
(WebKitWebPage *webPage
);
void webkit_web_page_set_fixed_layout_height (WebKitWebPage *webPage
,guint height
);
WebKitDOMElement * (*ChooseElementToZoomCallback) (GSList *candidates
,void *userData
);
The type of functions which are used to select the most relevant node when operating a contextual zoom.
|
a list of WebKitDOMElement |
|
a data pointer |
Returns : |
the node to zoom to. |
bool webkit_web_page_get_zoom_target (WebKitWebPage *webPage
,float x
,float y
,int *zoomCenterX
,int *zoomCenterY
,double *zoomFactor
,ChooseElementToZoomCallback callback
,void *userData
);
Compute the zoom center and factor for a contextual zoom requested at the
point defined by the x
and y
arguments.
The callback
(if any) will be called with a list of the candidate nodes to
zoom at. If the callback returns a node, it will be chosen to be zoomed at,
otherwise the first node will be chosen.
|
a WebKitWebPage |
|
the horizontal coordinate of the event |
|
the vertical coordinate of the event |
|
return location for the X coordinate of the zoomed area center. [out] |
|
return location for the Y coordinate of the zoomed area center. [out] |
|
return location for the final zoom factor. [out] |
|
the ChooseElementToZoomCallback, or NULL . [allow-none]
|
|
user data to pass to callback , or NULL . [allow-none]
|
Returns : |
FALSE if no suitable node was found |
"fixed-layout-height"
property "fixed-layout-height" guint : Read / Write
An associated WebKitWebWindowFeatures instance.
Default value: 600
"fixed-layout-width"
property "fixed-layout-width" guint : Read / Write
An associated WebKitWebWindowFeatures instance.
Default value: 800
"icon-uri"
property "icon-uri" gchar* : Read
The URI for the favicon for the WebKitWebPage.
Default value: NULL
"load-status"
property"load-status" WebKitLoadStatus : Read
Determines the current status of the load.
Connect to "notify::load-status" to monitor loading.
Default value: WEBKIT_LOAD_FINISHED
"progress"
property "progress" gdouble : Read
Determines the current progress of the load.
Allowed values: [0,1]
Default value: 1
"settings"
property"settings" WebKitWebSettings* : Read / Write
An associated WebKitWebSettings instance.
"title"
property "title" gchar* : Read
Returns the @web_page's document title.
Default value: NULL
"uri"
property "uri" gchar* : Read
Returns the current URI of the contents displayed by the @web_page.
Default value: NULL
"use-fixed-layout"
property "use-fixed-layout" gboolean : Read / Write
An associated WebKitWebWindowFeatures instance.
Default value: FALSE
"web-inspector"
property"web-inspector" WebKitWebInspector* : Read
The associated WebKitWebInspector instance.
"web-view"
property"web-view" WebKitIWebView* : Read / Write / Construct Only
The associated WebKitIWebView instance.
"window-features"
property"window-features" WebKitWebWindowFeatures* : Read / Write
An associated WebKitWebWindowFeatures instance.
"console-message"
signalgboolean user_function (WebKitWebPage *webPage,
gchar *message,
gint line,
gchar *source_id,
gpointer user_data) : Run Last
A JavaScript console message was created.
|
the object on which the signal is emitted |
|
the message text |
|
the line where the error occured |
|
the source id |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop other handlers from being invoked for the
event. FALSE to propagate the event further. |
"create-window"
signalWebKitWebPage* user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
gpointer user_data) : Run Last
Emitted when the creation of a new window is requested. If this signal is handled the signal handler should return the newly created WebKitWebPage.
The new WebKitWebPage should not be displayed to the user until the "web-page-ready" signal is emitted.
The signal handlers should not try to deal with the reference count for the new WebKitWebPage. The page to which the page is added will handle that.
|
the object on which the signal is emitted |
|
the WebKitWebFrame |
|
user data set when the signal handler was connected. |
Returns : |
a newly allocated WebKitWebPage, or NULL . [transfer full]
|
"database-quota-exceeded"
signalvoid user_function (WebKitWebPage *web_page,
GObject *frame,
GObject *database,
gpointer user_data) : Action
The "database-quota-exceeded" signal will be emitted when a Web Database exceeds the quota of its security origin. This signal may be used to increase the size of the quota before the originating operation fails.
|
the object which received the signal |
|
the relevant frame |
|
the WebKitWebDatabase which exceeded the quota of its WebKitSecurityOrigin |
|
user data set when the signal handler was connected. |
"document-load-finished"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *web_frame,
gpointer user_data) : Action
Emitted when the DOM document object load is finished for the given frame.
|
the object which received the signal |
|
the WebKitWebFrame whose load dispatched this request |
|
user data set when the signal handler was connected. |
"download-requested"
signalgboolean user_function (WebKitWebPage *web_page,
GObject *download,
gpointer user_data) : Run Last
A new Download is being requested. By default, if the signal is
not handled, the download is cancelled. If you handle the download
and call webkit_download_set_destination_uri()
, it will be
started for you. If you need to set the destination asynchronously
you are responsible for starting or cancelling it yourself.
If you intend to handle downloads yourself rather than using
the WebKitDownload helper object you must handle this signal,
and return FALSE
.
Also, keep in mind that the default policy for WebKitGTK+ is to
ignore files with a MIME type that it does not know how to
handle, which means this signal won't be emitted in the default
setup. One way to trigger downloads is to connect to
WebKitWebPage::mime-type-policy-decision-requested and call
webkit_web_policy_decision_download()
on the
WebKitWebPolicyDecision in the parameter list for the kind of
files you want your application to download (a common solution
is to download anything that WebKit can't handle, which you can
figure out by using webkit_web_page_can_show_mime_type()
).
|
the object on which the signal is emitted |
|
a WebKitDownload object that lets you control the download process |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the download should be performed, FALSE to
cancel it |
"frame-created"
signalvoid user_function (WebKitWebPage *webkitwebpage,
WebKitWebFrame *arg1,
gpointer user_data) : Action
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"geolocation-policy-decision-cancelled"
signalvoid user_function (WebKitWebPage *webPage,
WebKitWebFrame *frame,
gpointer user_data) : Run Last
When a frame
wants to cancel geolocation permission it had requested
before.
|
the object on which the signal is emitted |
|
the frame that cancels geolocation request. |
|
user data set when the signal handler was connected. |
"geolocation-policy-decision-requested"
signalgboolean user_function (WebKitWebPage *webPage,
WebKitWebFrame *frame,
WebKitGeolocationPolicyDecision *policy_decision,
gpointer user_data) : Run Last
This signal is emitted when a frame
wants to obtain the user's
location. The decision can be made asynchronously, but you must
call g_object_ref()
on the policy_decision
, and return TRUE
if
you are going to handle the request. To actually make the
decision you need to call webkit_geolocation_policy_allow()
or
webkit_geolocation_policy_deny()
on policy_decision
.
|
the object on which the signal is emitted |
|
the frame that requests permission |
|
a WebKitGeolocationPolicyDecision |
|
user data set when the signal handler was connected. |
"hovering-over-link"
signalvoid user_function (WebKitWebPage *web_page,
gchar *title,
gchar *uri,
gpointer user_data) : Run Last
When the cursor is over a link, this signal is emitted.
|
the object on which the signal is emitted |
|
the link's title |
|
the URI the link points to |
|
user data set when the signal handler was connected. |
"icon-loaded"
signalvoid user_function (WebKitWebPage *web_page,
gchar *icon_uri,
gpointer user_data) : Run Last
This signal is emitted when the main frame has got a favicon.
|
the object on which the signal is emitted |
|
the URI for the icon |
|
user data set when the signal handler was connected. |
"input-method-state-set"
signalvoid user_function (WebKitWebPage *web_page,
WebKitDOMNode *element,
gboolean active,
gpointer user_data) : Run Last
This signal is emitted when an editable element has been focused.
|
the object on which the signal is emitted |
|
the focused WebKitDOMElement |
|
TRUE if editing |
|
user data set when the signal handler was connected. |
"inspection-requested"
signalWebKitWebPage* user_function (WebKitWebPage *webkitwebpage,
WebKitWebInspector *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"microfocus-changed"
signalvoid user_function (WebKitWebPage *web_page,
WebKitDOMNode *element,
gpointer user_data) : Run Last
This signal is emitted when the focus in the web page changes to another element.
|
the object on which the signal is emitted |
|
the focused WebKitDOMElement, or NULL |
|
user data set when the signal handler was connected. |
"mime-type-policy-decision-requested"
signalgboolean user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
WebKitNetworkRequest *request,
gchar *mimetype,
WebKitWebPolicyDecision *policy_decision,
gpointer user_data) : Run Last
Decide whether or not to display the given MIME type. If this signal is not handled, the default behavior is to show the content of the requested URI if WebKit can show this MIME type and the content disposition is not a download; if WebKit is not able to show the MIME type nothing happens.
Notice that if you return TRUE, meaning that you handled the
signal, you are expected to be aware of the "Content-Disposition"
header. A value of "attachment" usually indicates a download
regardless of the MIME type, see also
soup_message_headers_get_content_disposition()
. And you must call
webkit_web_policy_decision_ignore()
,
webkit_web_policy_decision_use()
, or
webkit_web_policy_decision_download()
on the policy_decision
object.
|
the object on which the signal is emitted |
|
the WebKitWebFrame that required the policy decision |
|
a WebKitNetworkRequest |
|
the MIME type attempted to load |
|
a WebKitWebPolicyDecision |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if a decision was made, FALSE to have the
default behavior apply |
"navigation-policy-decision-requested"
signalgboolean user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
WebKitNetworkRequest *request,
WebKitWebNavigationAction *navigation_action,
WebKitWebPolicyDecision *policy_decision,
gpointer user_data) : Run Last
Emitted when frame
requests a navigation to another page.
If this signal is not handled, the default behavior is to allow the
navigation.
Notice that if you return TRUE, meaning that you handled the
signal, you are expected to have decided what to do, by calling
webkit_web_policy_decision_ignore()
,
webkit_web_policy_decision_use()
, or
webkit_web_policy_decision_download()
on the policy_decision
object.
|
the object on which the signal is emitted |
|
the WebKitWebFrame that required the navigation |
|
a WebKitNetworkRequest |
|
a WebKitWebNavigationAction |
|
a WebKitWebPolicyDecision |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if a decision was made, FALSE to have the
default behavior apply |
"new-window-policy-decision-requested"
signalgboolean user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
WebKitNetworkRequest *request,
WebKitWebNavigationAction *navigation_action,
WebKitWebPolicyDecision *policy_decision,
gpointer user_data) : Run Last
Emitted when frame
requests opening a new window. With this
signal the browser can use the context of the request to decide
about the new window. If the request is not handled the default
behavior is to allow opening the new window to load the URI,
which will cause a create-window signal emission where the
browser handles the new window action but without information
of the context that caused the navigation. The following
navigation-policy-decision-requested emissions will load the
page after the creation of the new window just with the
information of this new navigation context, without any
information about the action that made this new window to be
opened.
Notice that if you return TRUE, meaning that you handled the
signal, you are expected to have decided what to do, by calling
webkit_web_policy_decision_ignore()
,
webkit_web_policy_decision_use()
, or
webkit_web_policy_decision_download()
on the policy_decision
object.
|
the object on which the signal is emitted |
|
the WebKitWebFrame that required the navigation |
|
a WebKitNetworkRequest |
|
a WebKitWebNavigationAction |
|
a WebKitWebPolicyDecision |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if a decision was made, FALSE to have the
default behavior apply |
"onload-event"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
gpointer user_data) : Run Last
When a WebKitWebFrame receives an onload event this signal is emitted.
|
the object on which the signal is emitted |
|
the frame |
|
user data set when the signal handler was connected. |
"resource-request-starting"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *web_frame,
WebKitWebResource *web_resource,
WebKitNetworkRequest *request,
WebKitNetworkResponse *response,
gpointer user_data) : Action
Emitted when a request is about to be sent. You can modify the
request while handling this signal. You can set the URI in the
WebKitNetworkRequest object itself, and add/remove/replace
headers using the SoupMessage object it carries, if it is
present. See webkit_network_request_get_message()
. Setting the
request URI to "about:blank" will effectively cause the request
to load nothing, and can be used to disable the loading of
specific resources.
Notice that information about an eventual redirect is available
in response
's SoupMessage, not in the SoupMessage carried by
the request
. If response
is NULL
, then this is not a
redirected request.
The WebKitWebResource object will be the same throughout all the lifetime of the resource, but the contents may change from inbetween signal emissions.
|
the object which received the signal |
|
the WebKitWebFrame whose load dispatched this request |
|
an empty WebKitWebResource object |
|
the WebKitNetworkRequest that will be dispatched |
|
the WebKitNetworkResponse representing the redirect response, if any |
|
user data set when the signal handler was connected. |
"script-alert"
signalgboolean user_function (WebKitWebPage *webPage,
WebKitWebFrame *frame,
gchar *message,
gpointer user_data) : Run Last
A JavaScript alert dialog was created.
|
the object on which the signal is emitted |
|
the relevant frame |
|
the message text |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop other handlers from being invoked for the
event. FALSE to propagate the event further. |
"script-confirm"
signalgboolean user_function (WebKitWebPage *webPage,
WebKitWebFrame *frame,
gchar *message,
gpointer confirmed,
gpointer user_data) : Run Last
A JavaScript confirm dialog was created, providing Yes and No buttons.
|
the object on which the signal is emitted |
|
the relevant frame |
|
the message text |
|
whether the dialog has been confirmed |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop other handlers from being invoked for the
event. FALSE to propagate the event further. |
"script-prompt"
signalgboolean user_function (WebKitWebPage *webPage,
WebKitWebFrame *frame,
gchar *message,
gchar *default,
gpointer text,
gpointer user_data) : Run Last
A JavaScript prompt dialog was created, providing an entry to input text.
|
the object on which the signal is emitted |
|
the relevant frame |
|
the message text |
|
the default value |
|
To be filled with the return value or NULL if the dialog was cancelled. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop other handlers from being invoked for the
event. FALSE to propagate the event further. |
"should-interrupt-script"
signalgboolean user_function (WebKitWebPage *web_page,
gpointer user_data) : Run Last
Notification that JavaScript code may be stuck or is using up too much
time. Return TRUE
if execution should be interrupted, FALSE
otherwise.
|
the object on which the signal is emitted |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if execution should be interrupted, FALSE otherwise |
"status-bar-text-changed"
signalvoid user_function (WebKitWebPage *webkitwebpage,
gchar *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"title-changed"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
gchar *title,
gpointer user_data) : Run Last
WebKitWebPage::title-changed
has been deprecated since version 1.1.4 and should not be used in newly-written code. Use "notify::title" instead.
When a WebKitWebFrame changes the document title this signal is emitted.
|
the object on which the signal is emitted |
|
the main frame |
|
the new title |
|
user data set when the signal handler was connected. |
"web-load-error"
signalgboolean user_function (WebKitWebPage *web_page,
WebKitWebFrame *web_frame,
gchar *uri,
gpointer web_error,
gpointer user_data) : Run Last
An error occurred while loading. By default, if the signal is not
handled, the web_page
will display a stock error page. You need to
handle the signal if you want to provide your own error page.
|
the object on which the signal is emitted |
|
the WebKitWebFrame |
|
the URI that triggered the error |
|
the GError that was triggered |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop other handlers from being invoked for the
event. FALSE to propagate the event further. |
"web-load-finished"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
gpointer user_data) : Run Last
|
the WebKitWebPage |
|
the WebKitWebFrame |
|
user data set when the signal handler was connected. |
"web-load-started"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
gpointer user_data) : Run Last
When a WebKitWebFrame begins to load this signal is emitted.
|
the object on which the signal is emitted |
|
the frame going to do the load |
|
user data set when the signal handler was connected. |
"web-page-ready"
signalgboolean user_function (WebKitWebPage *web_page,
gpointer user_data) : Run Last
Emitted after "create-window" when the new WebKitWebPage should be displayed to the user. When this signal is emitted all the information about how the window should look, including size, position, whether the location, status and scroll bars should be displayed, is already set on the WebKitWebWindowFeatures object contained by the WebKitWebPage.
Notice that some of that information may change during the life time of the window, so you may want to connect to the ::notify signal of the WebKitWebWindowFeatures object to handle those.
|
the object on which the signal is emitted |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop handlers from being invoked for the event or
FALSE to propagate the event furter |
"window-object-cleared"
signalvoid user_function (WebKitWebPage *web_page,
WebKitWebFrame *frame,
gpointer context,
gpointer window_object,
gpointer user_data) : Run Last
Emitted when the JavaScript window object in a WebKitWebFrame has been cleared in preparation for a new load. This is the preferred place to set custom properties on the window object using the JavaScriptCore API.
|
the object on which the signal is emitted |
|
the WebKitWebFrame to which window_object belongs |
|
the JSGlobalContextRef holding the global object and other
execution state; equivalent to the return value of
webkit_web_frame_get_global_context(frame ) |
|
the JSObjectRef representing the frame's JavaScript window object |
|
user data set when the signal handler was connected. |