Graphics.UI.Gtk.WebKit.WebFrame

The content of a WebView

Note: Functon webkit_web_frame_get_global_context can't binding now, Because it need JSGlobalContextRef exist in JavaScriptCore.

Function webkit_web_frame_print_full can't binding now, Because library GtkPrintOperation haven't binding.

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 webFrameFindFrame.

Types

data WebFrame

Instances

Eq WebFrame

Methods

(==) :: WebFrame -> WebFrame -> Bool

(/=) :: WebFrame -> WebFrame -> Bool

Ord WebFrame

Methods

compare :: WebFrame -> WebFrame -> Ordering

(<) :: WebFrame -> WebFrame -> Bool

(<=) :: WebFrame -> WebFrame -> Bool

(>) :: WebFrame -> WebFrame -> Bool

(>=) :: WebFrame -> WebFrame -> Bool

max :: WebFrame -> WebFrame -> WebFrame

min :: WebFrame -> WebFrame -> WebFrame

GObjectClass WebFrame

Methods

toGObject :: WebFrame -> GObject

unsafeCastGObject :: GObject -> WebFrame

WebFrameClass WebFrame

class GObjectClass o => WebFrameClass o

Instances

WebFrameClass WebFrame

data LoadStatus

Instances

Enum LoadStatus

Methods

succ :: LoadStatus -> LoadStatus

pred :: LoadStatus -> LoadStatus

toEnum :: Int -> LoadStatus

fromEnum :: LoadStatus -> Int

enumFrom :: LoadStatus -> [LoadStatus]

enumFromThen :: LoadStatus -> LoadStatus -> [LoadStatus]

enumFromTo :: LoadStatus -> LoadStatus -> [LoadStatus]

enumFromThenTo :: LoadStatus -> LoadStatus -> LoadStatus -> [LoadStatus]

Constructors

webFrameNew

Arguments

:: WebViewClass webview

=> webview

webview - the given webview

-> IO WebFrame

Create a new WebFrame instance with the given webview.

A WebFrame contains the content of one URI.

Methods

webFrameGetWebView :: WebFrameClass self => self -> IO WebView

Return the WebView that manages the given WebFrame.

webFrameGetName

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> IO (Maybe string)

the name string or Nothing in case failed.

Return the name of the given WebFrame.

webFrameGetNetworkResponse :: WebFrameClass self => self -> IO (Maybe NetworkResponse)

Returns a WebKitNetworkResponse object representing the response that was given to the request for the given frame, or Nothing if the frame was not created by a load.

• Since 1.1.18

webFrameGetTitle

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> IO (Maybe string)

the title string or Nothing in case failed.

Return the title of the given WebFrame.

webFrameGetUri

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> IO (Maybe string)

the URI string or Nothing in case failed.

Return the URI of the given WebFrame.

webFrameGetParent

Arguments

:: WebFrameClass self

=> self

-> IO (Maybe WebFrame)

a WebFrame or Nothing in case failed.

Return the WebFrame's parent frame if it has one, Otherwise return Nothing.

webFrameGetLoadStatus :: WebFrameClass self => self -> IO LoadStatus

Determines the current status of the load.

frame : a WebKitWebView

• Since 1.1.7

webFrameLoadUri

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> string

uri - an URI string.

-> IO ()

Request loading of the specified URI string.

webFrameLoadString

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> string

content - the content string to be loaded.

-> Maybe string

mime_type - the MIME type or Nothing.

-> string

base_uri - the base URI for relative locations.

-> IO ()

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

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

If want control over the encoding use webFrameLoadByteString

webFrameLoadAlternateString

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> string

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

-> string

base_uri - the base URI for relative locations.

-> string

unreachable_url - the URL for the alternate page content.

-> IO ()

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

webFrameLoadRequest :: (WebFrameClass self, NetworkRequestClass requ) => self -> requ -> IO ()

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 webFrameStopLoading to stop the load. This function is typically invoked on the main frame.

webFrameStopLoading :: WebFrameClass self => self -> IO ()

Stops and pending loads on the given data source and those of its children.

webFrameReload :: WebFrameClass self => self -> IO ()

Reloads the initial request.

webFrameFindFrame

Arguments

:: (WebFrameClass self, GlibString string)

=> self

-> string

name - the name of the frame to be found.

-> IO (Maybe WebFrame)

Return the WebFrame associated with the given name or Nothing in case none if found

For pre-defined names, return the given webframe if name is

webFrameGetDataSource :: WebFrameClass self => self -> IO WebDataSource

Returns the committed data source.

webFrameGetHorizontalScrollbarPolicy :: WebFrameClass self => self -> IO PolicyType

Return the policy of horizontal scrollbar.

webFrameGetVerticalScrollbarPolicy :: WebFrameClass self => self -> IO PolicyType

Return the policy of vertical scrollbar.

webFrameGetProvisionalDataSource :: WebFrameClass self => self -> IO WebDataSource

You use the webFrameLoadRequest 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 webFrameGetDataSource to get the committed data source.

webFrameGetSecurityOrigin :: WebFrameClass self => self -> IO SecurityOrigin

Returns the frame's security origin.

webFramePrint :: WebFrameClass self => self -> IO ()

Prints the given WebFrame.

by presenting a print dialog to the user.