Back to Seed Clases

WebKit

Classes

Interfaces

DOMEventTarget

Structs

Unions

Enums

GObject.Object
parent-child marker WebKit.WebFrame

Class WebKit.WebFrame

Import line:	WebKit = imports.gi.WebKit;
GIR File:	WebKit-3.0.gir
C documentation:	WebKitWebFrame
Class :	WebFrame
Extends:	GObject.Object

A WebKitWebView contains a main WebKitWebFrame. A WebKitWebFrame
contains the content of one URI. The URI and name of the frame can
be retrieved, the load status and progress can be observed using the
signals and can be controlled using the methods of the WebKitWebFrame.
A WebKitWebFrame can have any number of children and one child can
be found by using webkit_web_frame_find_frame.

/* Get the frame from the WebKitWebView */
WebKitWebFrame *frame = webkit_web_view_get_main_frame (WEBKIT_WEB_VIEW(my_view));
g_print("The URI of this frame is 's'", webkit_web_frame_get_uri (frame));

Properties
Properties		Defined By
	horizontal_scrollbar_policy : Gtk.PolicyType read only Determines the current policy for the horizontal scrollbar of the frame. Determines the current policy for the horizontal scrollbar of the frame. For the main frame, make sure to set the same policy on the scrollable widget containing the WebKitWebView, unless you know what you are doing.	WebKit.WebFrame
	load_status : WebKit.LoadStatus read only Determines the current status of the load. Determines the current status of the load.	WebKit.WebFrame
	name : String read only	WebKit.WebFrame
	parent_instance : GObject.Object read only	WebKit.WebFrame
	priv : WebKit.WebFramePrivate read only	WebKit.WebFrame
	title : String read only	WebKit.WebFrame
	uri : String read only	WebKit.WebFrame
	vertical_scrollbar_policy : Gtk.PolicyType read only Determines the current policy for the vertical scrollbar of the frame. Determines the current policy for the vertical scrollbar of the frame. For the main frame, make sure to set the same policy on the scrollable widget containing the WebKitWebView, unless you know what you are doing.	WebKit.WebFrame

Methods / Constructors
Method / Constructor		Defined By
	new WebKit.WebFrame (Object *properties) Create a new WebKit.WebFrame Create a new WebKit.WebFrame Parameters: Object properties*
	new WebKit.WebFrame.c_new (WebView *web_view) : WebKit.WebFrame Create a new WebKit.WebFrame Create a new WebKit.WebFrame Parameters: WebKit.WebView web_view* Required (not null) the controlling WebKitWebView Returns: WebKit.WebFrame a new WebKitWebFrame
	find_frame (String *name) : WebKit.WebFrame For pre-defined names, returns frame* if name is "_self" or "_current", returns frame's parent frame if name is "_parent", and returns the main frame if name is "_top". For pre-defined names, returns frame if name is "_self" or "_current", returns frame's parent frame if name is "_parent", and returns the main frame if name is "_top". Also returns frame if it is the main frame and the first frame that matches name. This function searches frame and its descendents first, then frame's parent and its children moving up the hierarchy until a match is found. If no match is found in frame's hierarchy, this function will search for a matching frame in other main frame hierarchies. Returns NULL if no match is found. Parameters: String name Required (not null) the name of the frame to be found Returns: WebKit.WebFrame the found WebKitWebFrame or NULL in case none is found	WebKit.WebFrame
	get_data_source () : WebKit.WebDataSource Returns the committed data source. Returns the committed data source. Returns: WebKit.WebDataSource the committed WebKitWebDataSource.	WebKit.WebFrame
	get_horizontal_scrollbar_policy () : Gtk.PolicyType Returns: Gtk.PolicyType	WebKit.WebFrame
	get_load_status () : WebKit.LoadStatus Determines the current status of the load. Determines the current status of the load. Returns: WebKit.LoadStatus	WebKit.WebFrame
	get_name () : String Returns the frame's name the WebKitWebFrame is invalid or an empty string if it is not backed by a live WebCore frame. Returns the frame's name the WebKitWebFrame is invalid or an empty string if it is not backed by a live WebCore frame. Returns: String the name of frame. This method will return NULL if	WebKit.WebFrame
	get_network_response () : WebKit.NetworkResponse Returns a WebKitNetworkResponse object representing the response that was given to the request for the given frame, or NULL if the frame was not created by a load. Returns a WebKitNetworkResponse object representing the response that was given to the request for the given frame, or NULL if the frame was not created by a load. You must unref the object when you are done with it. Returns: WebKit.NetworkResponse a WebKitNetworkResponse object	WebKit.WebFrame
	get_parent () : WebKit.WebFrame Returns the frame's parent frame, or NULL if it has none. Returns the frame's parent frame, or NULL if it has none. Returns: WebKit.WebFrame the parent WebKitWebFrame or NULL in case there is none	WebKit.WebFrame
	get_provisional_data_source () : WebKit.WebDataSource You use the webkit_web_frame_load_request method to initiate a request that creates a provisional data source. You use the webkit_web_frame_load_request method to initiate a request that creates a provisional data source. The provisional data source will transition to a committed data source once any data has been received. Use webkit_web_frame_get_data_source to get the committed data source. request is not in progress. Returns: WebKit.WebDataSource the provisional WebKitWebDataSource or NULL if a load	WebKit.WebFrame
	get_security_origin () : WebKit.SecurityOrigin Returns the frame's security origin. Returns the frame's security origin. Returns: WebKit.SecurityOrigin the security origin of frame	WebKit.WebFrame
	get_title () : String Returns the frame's document title Returns the frame's document title Returns: String the title of frame	WebKit.WebFrame
	get_uri () : String Returns the current URI of the contents displayed by the frame Returns the current URI of the contents displayed by the frame Returns: String the URI of frame	WebKit.WebFrame
	get_vertical_scrollbar_policy () : Gtk.PolicyType Returns: Gtk.PolicyType	WebKit.WebFrame
	get_web_view () : WebKit.WebView Returns the WebKitWebView that manages this WebKitWebFrame. Returns the WebKitWebView that manages this WebKitWebFrame. The WebKitWebView returned manages the entire hierarchy of WebKitWebFrame objects that contains frame. Returns: WebKit.WebView the WebKitWebView that manages frame	WebKit.WebFrame
	load_alternate_string (String *content, String base_url, String unreachable_url) : none Request loading of an alternate content for a URL that is unreachable. Request loading of an alternate content for a URL that is unreachable. Using this method will preserve the back-forward list. The URI passed in Parameters: String content* Required (not null) the alternate content to display as the main page of the frame String base_url Required (not null) the base URI for relative locations String unreachable_url Required (not null) the URL for the alternate page content Returns: none	WebKit.WebFrame
	load_request (NetworkRequest *request) : none Connects to a given URI by initiating an asynchronous client request. Connects to a given URI by initiating an 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_frame_stop_loading() to stop the load. This function is typically invoked on the main frame. Parameters: WebKit.NetworkRequest request* Required (not null) a WebKitNetworkRequest Returns: none	WebKit.WebFrame
	load_string (String *content, String mime_type, String encoding, String base_uri) : none Requests loading of the given content* with the specified mime_type, If mime_type is NULL, "text/html" is assumed. Requests loading of the given content with the specified mime_type, If mime_type is NULL, "text/html" is assumed. If encoding is NULL, "UTF-8" is assumed. Parameters: String content Required (not null) an URI string String mime_type Required (not null) the MIME type, or NULL String encoding Required (not null) the encoding, or NULL String base_uri Required (not null) the base URI for relative locations Returns: none	WebKit.WebFrame
	load_uri (String *uri) : none Requests loading of the specified URI string. Requests loading of the specified URI string. Parameters: String uri* Required (not null) an URI string Returns: none	WebKit.WebFrame
	print () : none Prints the given WebKitWebFrame, by presenting a print dialog to the user. Prints the given WebKitWebFrame, by presenting a print dialog to the user. If you need more control over the printing process, see webkit_web_frame_print_full(). Returns: none	WebKit.WebFrame
	print_full (PrintOperation *operation, PrintOperationAction action) : Gtk.PrintOperationResult Prints the given WebKitWebFrame, using the given GtkPrintOperation* and GtkPrintOperationAction. Prints the given WebKitWebFrame, using the given GtkPrintOperation and GtkPrintOperationAction. This function wraps a call to gtk_print_operation_run() for printing the contents of the WebKitWebFrame. Parameters: Gtk.PrintOperation operation Required (not null) the GtkPrintOperation to be carried Gtk.PrintOperationAction action Required (not null) the GtkPrintOperationAction to be performed Returns: Gtk.PrintOperationResult	WebKit.WebFrame
	reload () : none Reloads the initial request. Reloads the initial request. Returns: none	WebKit.WebFrame
	stop_loading () : none Stops any pending loads on frame's data source, and those of its children. Stops any pending loads on frame's data source, and those of its children. Returns: none	WebKit.WebFrame

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	cleared (WebFrame *self) : none Parameters: WebKit.WebFrame self* Returns: {none}	WebKit.WebFrame
	hovering_over_link (WebFrame *self, String object, String p0) : none Parameters: WebKit.WebFrame self* String object String p0 Returns: {none}	WebKit.WebFrame
	load_committed (WebFrame *self) : none Parameters: WebKit.WebFrame self* Returns: {none}	WebKit.WebFrame
	load_done (WebFrame *self, gboolean deprecated) : none Emitted when frame loading is done. Emitted when frame loading is done. WebKitWebView::load-error to be notified of load errors Parameters: WebKit.WebFrame self* gboolean deprecated Returns: {none}	WebKit.WebFrame
	scrollbars_policy_changed (WebFrame *self) : gboolean Signal emitted when policy for one or both of the scrollbars of the view has changed. Signal emitted when policy for one or both of the scrollbars of the view has changed. The default handler will apply the new policy to the container that holds the WebKitWebFrame* if it is a GtkScrolledWindow and the frame is the main frame. If you do not want this to be handled automatically, you need to handle this signal. The exception to this rule is that policies to disable the scrollbars are applied as GTK_POLICY_AUTOMATIC instead, since the size request of the widget would force browser windows to not be resizable. You can obtain the new policies from the WebKitWebFrame:horizontal-scrollbar-policy and WebKitWebFrame:vertical-scrollbar-policy properties. event. FALSE to propagate the event further. Parameters: WebKit.WebFrame self Returns: {gboolean}	WebKit.WebFrame
	title_changed (WebFrame *self, String title) : none When a WebKitWebFrame* changes the document title this signal is emitted. When a WebKitWebFrame changes the document title this signal is emitted. Parameters: WebKit.WebFrame self String title Returns: {none}	WebKit.WebFrame

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
WebKit.IconDatabase Signal	icon_loaded (IconDatabase *self, WebFrame frame, String frame_uri*) : none This signal is emitted when a favicon is available for a page, or a child frame.
WebKit.WebDataSource Method	get_web_frame () : WebKit.WebFrame Returns the WebKitWebFrame that represents this data source the data_source.
WebKit.WebView Signal	create_web_view (WebView *self, WebFrame frame*) : WebKit.WebView Emitted when the creation of a new window is requested.
WebKit.WebView Signal	document_load_finished (WebView *self, WebFrame object*) : none
WebKit.WebView Signal	frame_created (WebView *self, WebFrame object*) : none
WebKit.WebView Signal	geolocation_policy_decision_cancelled (WebView *self, WebFrame frame) : none When a frame* wants to cancel geolocation permission it had requested before.
WebKit.WebView Signal	geolocation_policy_decision_requested (WebView *self, WebFrame frame, GeolocationPolicyDecision policy_decision) : gboolean This signal is emitted when a frame* wants to obtain the user's location.
WebKit.WebView Signal	load_committed (WebView *self, WebFrame frame) : none When a WebKitWebFrame* loaded the first data this signal is emitted.
WebKit.WebView Signal	load_error (WebView *self, WebFrame web_frame, String uri, void *web_error*) : gboolean An error occurred while loading.
WebKit.WebView Signal	load_finished (WebView *self, WebFrame frame*) : none
WebKit.WebView Signal	load_started (WebView *self, WebFrame frame) : none When a WebKitWebFrame* begins to load this signal is emitted.
WebKit.WebView Signal	mime_type_policy_decision_requested (WebView *self, WebFrame frame, NetworkRequest request, String mimetype, WebPolicyDecision policy_decision*) : gboolean Decide whether or not to display the given MIME type.
WebKit.WebView Signal	navigation_policy_decision_requested (WebView *self, WebFrame frame, NetworkRequest request, WebNavigationAction navigation_action, WebPolicyDecision policy_decision) : gboolean Emitted when frame* requests a navigation to another page.
WebKit.WebView Signal	navigation_requested (WebView *self, WebFrame frame, NetworkRequest request) : WebKit.NavigationResponse Emitted when frame* requests a navigation to another page.
WebKit.WebView Signal	new_window_policy_decision_requested (WebView *self, WebFrame frame, NetworkRequest request, WebNavigationAction navigation_action, WebPolicyDecision policy_decision) : gboolean Emitted when frame* requests opening a new window.
WebKit.WebView Signal	onload_event (WebView *self, WebFrame frame) : none When a WebKitWebFrame* receives an onload event this signal is emitted.
WebKit.WebView Signal	print_requested (WebView *self, WebFrame web_frame*) : gboolean Emitted when printing is requested by the frame, usually because of a javascript call.
WebKit.WebView Signal	resource_request_starting (WebView *self, WebFrame web_frame, WebResource web_resource, NetworkRequest request, NetworkResponse response*) : none Emitted when a request is about to be sent.
WebKit.WebView Signal	script_alert (WebView *self, WebFrame frame, String message*) : gboolean A JavaScript alert dialog was created.
WebKit.WebView Signal	script_confirm (WebView *self, WebFrame frame, String message, void *confirmed*) : gboolean A JavaScript confirm dialog was created, providing Yes and No buttons.
WebKit.WebView Signal	script_prompt (WebView *self, WebFrame frame, String message, String default, void *text*) : gboolean A JavaScript prompt dialog was created, providing an entry to input text.
WebKit.WebView Signal	title_changed (WebView *self, WebFrame frame, String title) : none When a WebKitWebFrame* changes the document title this signal is emitted.
WebKit.WebView Signal	window_object_cleared (WebView *self, WebFrame frame, void *context, void *window_object) : none Emitted when the JavaScript window object in a WebKitWebFrame* has been cleared in preparation for a new load.
WebKit.WebView Method	get_focused_frame () : WebKit.WebFrame Returns the frame that has focus or an active text selection.
WebKit.WebView Method	get_main_frame () : WebKit.WebFrame Returns the main frame for the webView.