WebKitWebFrame

WebKitWebFrame — The content of a WebKitWebView

Synopsis

enum                WebKitLoadStatus;
                    WebKitWebFrame;
WebKitWebFrame *    webkit_web_frame_find_frame         (WebKitWebFrame *frame,
                                                         const gchar *name);
JSGlobalContextRef  webkit_web_frame_get_global_context (WebKitWebFrame *frame);
WebKitLoadStatus    webkit_web_frame_get_load_status    (WebKitWebFrame *frame);
const gchar *       webkit_web_frame_get_name           (WebKitWebFrame *frame);
WebKitWebFrame *    webkit_web_frame_get_parent         (WebKitWebFrame *frame);
const gchar *       webkit_web_frame_get_title          (WebKitWebFrame *frame);
const gchar *       webkit_web_frame_get_uri            (WebKitWebFrame *frame);
WebKitWebView *     webkit_web_frame_get_web_view       (WebKitWebFrame *frame);
void                webkit_web_frame_load_alternate_string
                                                        (WebKitWebFrame *frame,
                                                         const gchar *content,
                                                         const gchar *base_url,
                                                         const gchar *unreachable_url);
void                webkit_web_frame_load_request       (WebKitWebFrame *frame,
                                                         WebKitNetworkRequest *request);
void                webkit_web_frame_load_string        (WebKitWebFrame *frame,
                                                         const gchar *content,
                                                         const gchar *mime_type,
                                                         const gchar *encoding,
                                                         const gchar *base_uri);
void                webkit_web_frame_load_uri           (WebKitWebFrame *frame,
                                                         const gchar *uri);
WebKitWebFrame *    webkit_web_frame_new                (WebKitWebView *web_view);
void                webkit_web_frame_print              (WebKitWebFrame *frame);
GtkPrintOperationResult  webkit_web_frame_print_full    (WebKitWebFrame *frame,
                                                         GtkPrintOperation *operation,
                                                         GtkPrintOperationAction action,
                                                         GError **error);
void                webkit_web_frame_reload             (WebKitWebFrame *frame);
void                webkit_web_frame_stop_loading       (WebKitWebFrame *frame);

Description

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

Details

enum WebKitLoadStatus

typedef enum {
    WEBKIT_LOAD_PROVISIONAL,
    WEBKIT_LOAD_COMMITTED,
    WEBKIT_LOAD_FINISHED,
    WEBKIT_LOAD_FIRST_VISUALLY_NON_EMPTY_LAYOUT
} WebKitLoadStatus;

WEBKIT_LOAD_PROVISIONAL

 No data has been received yet, empty structures have been allocated to perform the load; the load may still fail for transport issues such as not being able to resolve a name, or connect to a port.

WEBKIT_LOAD_COMMITTED

 The first data chunk has arrived, meaning that the necessary transport requirements are stabilished, and the load is being performed.

WEBKIT_LOAD_FINISHED

 This state means either that everything that was required to display the page has been loaded, or that an error has happened.

WEBKIT_LOAD_FIRST_VISUALLY_NON_EMPTY_LAYOUT

 The first layout with actual visible content happened; one or more layouts may have happened before that caused nothing to be visible on the screen, because the data available at the time was not significant enough.

WebKitWebFrame

typedef struct {
    GObject parent_instance;
} WebKitWebFrame;

webkit_web_frame_find_frame ()

WebKitWebFrame *    webkit_web_frame_find_frame         (WebKitWebFrame *frame,
                                                         const gchar *name);

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 name is either "_parent" or "_top". For other names, this function returns 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.

frame :

 a WebKitWebFrame

name :

 the name of the frame to be found

Returns :

 the found WebKitWebFrame or NULL in case none is found

webkit_web_frame_get_global_context ()

JSGlobalContextRef  webkit_web_frame_get_global_context (WebKitWebFrame *frame);

Gets the global JavaScript execution context. Use this function to bridge between the WebKit and JavaScriptCore APIs.

frame :

 a WebKitWebFrame

Returns :

 the global JavaScript context

webkit_web_frame_get_load_status ()

WebKitLoadStatus    webkit_web_frame_get_load_status    (WebKitWebFrame *frame);

Determines the current status of the load.

frame :

 a WebKitWebView

Returns :

Since 1.1.7

webkit_web_frame_get_name ()

const gchar *       webkit_web_frame_get_name           (WebKitWebFrame *frame);

Returns the frame's name

frame :

 a WebKitWebFrame

Returns :

 the name of frame

webkit_web_frame_get_parent ()

WebKitWebFrame *    webkit_web_frame_get_parent         (WebKitWebFrame *frame);

Returns the frame's parent frame, or NULL if it has none.

frame :

 a WebKitWebFrame

Returns :

 the parent WebKitWebFrame or NULL in case there is none

webkit_web_frame_get_title ()

const gchar *       webkit_web_frame_get_title          (WebKitWebFrame *frame);

Returns the frame's document title

frame :

 a WebKitWebFrame

Returns :

 the title of frame

webkit_web_frame_get_uri ()

const gchar *       webkit_web_frame_get_uri            (WebKitWebFrame *frame);

Returns the current URI of the contents displayed by the frame

frame :

 a WebKitWebFrame

Returns :

 the URI of frame

webkit_web_frame_get_web_view ()

WebKitWebView *     webkit_web_frame_get_web_view       (WebKitWebFrame *frame);

Returns the WebKitWebView that manages this WebKitWebFrame.

The WebKitWebView returned manages the entire hierarchy of WebKitWebFrame objects that contains frame.

frame :

 a WebKitWebFrame

Returns :

 the WebKitWebView that manages frame

webkit_web_frame_load_alternate_string ()

void                webkit_web_frame_load_alternate_string
                                                        (WebKitWebFrame *frame,
                                                         const gchar *content,
                                                         const gchar *base_url,
                                                         const gchar *unreachable_url);

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 base_url has to be an absolute URI.

frame :

 a WebKitWebFrame

content :

 the alternate content to display as the main page of the frame

base_url :

 the base URI for relative locations

unreachable_url :

 the URL for the alternate page content

Since 1.1.6

webkit_web_frame_load_request ()

void                webkit_web_frame_load_request       (WebKitWebFrame *frame,
                                                         WebKitNetworkRequest *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.

frame :

 a WebKitWebFrame

request :

 a WebKitNetworkRequest

webkit_web_frame_load_string ()

void                webkit_web_frame_load_string        (WebKitWebFrame *frame,
                                                         const gchar *content,
                                                         const gchar *mime_type,
                                                         const gchar *encoding,
                                                         const gchar *base_uri);

Requests loading of the given content with the specified mime_type, encoding and base_uri.

If mime_type is NULL, "text/html" is assumed.

If encoding is NULL, "UTF-8" is assumed.

frame :

 a WebKitWebFrame

content :

 an URI string

mime_type :

 the MIME type, or NULL

encoding :

 the encoding, or NULL

base_uri :

 the base URI for relative locations

Since 1.1.1

webkit_web_frame_load_uri ()

void                webkit_web_frame_load_uri           (WebKitWebFrame *frame,
                                                         const gchar *uri);

Requests loading of the specified URI string.

frame :

 a WebKitWebFrame

uri :

 an URI string

Since 1.1.1

webkit_web_frame_new ()

WebKitWebFrame *    webkit_web_frame_new                (WebKitWebView *web_view);

Warning

webkit_web_frame_new has been deprecated since version 1.0.2 and should not be used in newly-written code. WebKitWebFrame can only be used to inspect existing frames.

Creates a new WebKitWebFrame initialized with a controlling WebKitWebView.

web_view :

 the controlling WebKitWebView

Returns :

 a new WebKitWebFrame

webkit_web_frame_print ()

void                webkit_web_frame_print              (WebKitWebFrame *frame);

Prints the given WebKitFrame, by presenting a print dialog to the user. If you need more control over the printing process, see webkit_web_frame_print_full().

frame :

 a WebKitWebFrame

Since 1.1.5

webkit_web_frame_print_full ()

GtkPrintOperationResult  webkit_web_frame_print_full    (WebKitWebFrame *frame,
                                                         GtkPrintOperation *operation,
                                                         GtkPrintOperationAction action,
                                                         GError **error);

Prints the given WebKitFrame, using the given GtkPrintOperation and GtkPrintOperationAction. This function wraps a call to gtk_print_operation_run() for printing the contents of the WebKitWebFrame.

frame :

 a WebKitWebFrame to be printed

operation :

 the GtkPrintOperation to be carried

action :

 the GtkPrintOperationAction to be performed

error :

 GError for error return

Returns :

Since 1.1.5

webkit_web_frame_reload ()

void                webkit_web_frame_reload             (WebKitWebFrame *frame);

Reloads the initial request.

frame :

 a WebKitWebFrame

webkit_web_frame_stop_loading ()

void                webkit_web_frame_stop_loading       (WebKitWebFrame *frame);

Stops any pending loads on frame's data source, and those of its children.

frame :

 a WebKitWebFrame
Generated by GTK-Doc V1.11