GI.WebKit.Objects.WebFrame

A WebView contains a main WebFrame. A WebFrame 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 WebFrame. A WebFrame can have any number of children and one child can be found by using webkit_web_frame_find_frame.

<informalexample><programlisting> /<!-- -->* Get the frame from the WebView *<!-- -->/ 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)); </programlisting></informalexample>

Exported types

newtype WebFrame

Constructors

WebFrame (ManagedPtr WebFrame)

Instances

GObject WebFrame

Methods

gobjectType :: WebFrame -> IO GType

IsObject WebFrame

IsWebFrame WebFrame

class GObject o => IsWebFrame o

Instances

(GObject a, UnknownAncestorError Constraint WebFrame a) => IsWebFrame a

IsWebFrame WebFrame

toWebFrame :: (MonadIO m, IsWebFrame o) => o -> m WebFrame

noWebFrame :: Maybe WebFrame

Methods

findFrame

webFrameFindFrame

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> Text

name: the name of the frame to be found

-> m WebFrame

Returns: the found WebFrame or Nothing in case none is found

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 Nothing if no match is found.

getDataSource

webFrameGetDataSource

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m WebDataSource

Returns: the committed WebDataSource.

Returns the committed data source.

Since: 1.1.14

getDomDocument

webFrameGetDomDocument

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m DOMDocument

Returns: the DOMDocument currently loaded in the frame or Nothing if no document is loaded

No description available in the introspection data.

Since: 1.10

getGlobalContext

webFrameGetGlobalContext

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m GlobalContext

Returns: the global JavaScript context GlobalContext

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

getHorizontalScrollbarPolicy

webFrameGetHorizontalScrollbarPolicy :: (HasCallStack, MonadIO m, IsWebFrame a) => a -> m PolicyType

No description available in the introspection data.

getLoadStatus

webFrameGetLoadStatus

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebView

-> m LoadStatus

Returns: The LoadStatus specifying the status of the current load.

Determines the current status of the load.

Since: 1.1.7

getName

webFrameGetName

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m Text

Returns: the name of frame. This method will return NULL if the WebFrame is invalid or an empty string if it is not backed by a live WebCore frame.

Returns the frame's name

getNetworkResponse

webFrameGetNetworkResponse

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m NetworkResponse

Returns: a NetworkResponse object

Returns a NetworkResponse 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.

Since: 1.1.18

getParent

webFrameGetParent

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m WebFrame

Returns: the parent WebFrame or Nothing in case there is none

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

getProvisionalDataSource

webFrameGetProvisionalDataSource

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m WebDataSource

Returns: the provisional WebDataSource or Nothing if a load request is not in progress.

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.

Since: 1.1.14

getRangeForWordAroundCaret

webFrameGetRangeForWordAroundCaret

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m DOMRange

Returns: a DOMRange spanning the word where the caret currently is positioned. If there is no caret Nothing will be returned.

Returns a DOMRange for the word where the caret is currently positioned.

@since 1.5.1.

getSecurityOrigin

webFrameGetSecurityOrigin

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m SecurityOrigin

Returns: the security origin of frame

Returns the frame's security origin.

Since: 1.1.14

getTitle

webFrameGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m Text

Returns: the title of frame

Returns the frame's document title

getUri

webFrameGetUri

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m Text

Returns: the URI of frame

Returns the current URI of the contents displayed by the frame

getVerticalScrollbarPolicy

webFrameGetVerticalScrollbarPolicy :: (HasCallStack, MonadIO m, IsWebFrame a) => a -> m PolicyType

No description available in the introspection data.

getWebView

webFrameGetWebView

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m WebView

Returns: the WebView that manages frame

Returns the WebView that manages this WebFrame.

The WebView returned manages the entire hierarchy of WebFrame objects that contains frame.

loadAlternateString

webFrameLoadAlternateString

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> Text

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

-> Text

baseUrl: the base URI for relative locations

-> Text

unreachableUrl: the URL for the alternate page content

-> m ()

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

Since: 1.1.6

loadRequest

webFrameLoadRequest

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a, IsNetworkRequest b)

=> a

frame: a WebFrame

-> b

request: a NetworkRequest

-> m ()

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.

loadString

webFrameLoadString

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> Text

content: an URI string

-> Text

mimeType: the MIME type, or Nothing

-> Text

encoding: the encoding, or Nothing

-> Text

baseUri: the base URI for relative locations

-> m ()

Requests loading of the given content with the specified mimeType, encoding and baseUri.

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

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

Since: 1.1.1

loadUri

webFrameLoadUri

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> Text

uri: an URI string

-> m ()

Requests loading of the specified URI string.

Since: 1.1.1

new

webFrameNew

Arguments

:: (HasCallStack, MonadIO m, IsWebView a)

=> a

webView: the controlling WebView

-> m WebFrame

Returns: a new WebFrame

Deprecated: (Since version 1.0.2)WebFrame can only be used to inspect existingframes.

Creates a new WebFrame initialized with a controlling WebView.

print

webFramePrint

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m ()

Prints the given WebFrame, by presenting a print dialog to the user. If you need more control over the printing process, see webFramePrintFull.

Since: 1.1.5

printFull

webFramePrintFull

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a, IsPrintOperation b)

=> a

frame: a WebFrame to be printed

-> b

operation: the PrintOperation to be carried

-> PrintOperationAction

action: the PrintOperationAction to be performed

-> m PrintOperationResult

Returns: The PrintOperationResult specifying the result of this operation. (Can throw GError)

Prints the given WebFrame, using the given PrintOperation and PrintOperationAction. This function wraps a call to printOperationRun for printing the contents of the WebFrame.

Since: 1.1.5

reload

webFrameReload

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m ()

Reloads the initial request.

replaceSelection

webFrameReplaceSelection

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebKitWeFrame

-> Text

text: the text to insert in place of the current selection

-> m ()

Replaces the current selection in frame, if any, with text.

Since: 1.5.1

stopLoading

webFrameStopLoading

Arguments

:: (HasCallStack, MonadIO m, IsWebFrame a)

=> a

frame: a WebFrame

-> m ()

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

Properties

horizontalScrollbarPolicy

getWebFrameHorizontalScrollbarPolicy :: (MonadIO m, IsWebFrame o) => o -> m PolicyType

loadStatus

getWebFrameLoadStatus :: (MonadIO m, IsWebFrame o) => o -> m LoadStatus

name

getWebFrameName :: (MonadIO m, IsWebFrame o) => o -> m Text

title

getWebFrameTitle :: (MonadIO m, IsWebFrame o) => o -> m Text

uri

getWebFrameUri :: (MonadIO m, IsWebFrame o) => o -> m Text

verticalScrollbarPolicy

getWebFrameVerticalScrollbarPolicy :: (MonadIO m, IsWebFrame o) => o -> m PolicyType

Signals

cleared

type C_WebFrameClearedCallback = Ptr () -> Ptr () -> IO ()

type WebFrameClearedCallback = IO ()

afterWebFrameCleared :: (IsWebFrame a, MonadIO m) => a -> WebFrameClearedCallback -> m SignalHandlerId

genClosure_WebFrameCleared :: WebFrameClearedCallback -> IO Closure

mk_WebFrameClearedCallback :: C_WebFrameClearedCallback -> IO (FunPtr C_WebFrameClearedCallback)

noWebFrameClearedCallback :: Maybe WebFrameClearedCallback

onWebFrameCleared :: (IsWebFrame a, MonadIO m) => a -> WebFrameClearedCallback -> m SignalHandlerId

wrap_WebFrameClearedCallback :: WebFrameClearedCallback -> Ptr () -> Ptr () -> IO ()

hoveringOverLink

type C_WebFrameHoveringOverLinkCallback = Ptr () -> CString -> CString -> Ptr () -> IO ()

type WebFrameHoveringOverLinkCallback = Text -> Text -> IO ()

afterWebFrameHoveringOverLink :: (IsWebFrame a, MonadIO m) => a -> WebFrameHoveringOverLinkCallback -> m SignalHandlerId

genClosure_WebFrameHoveringOverLink :: WebFrameHoveringOverLinkCallback -> IO Closure

mk_WebFrameHoveringOverLinkCallback :: C_WebFrameHoveringOverLinkCallback -> IO (FunPtr C_WebFrameHoveringOverLinkCallback)

noWebFrameHoveringOverLinkCallback :: Maybe WebFrameHoveringOverLinkCallback

onWebFrameHoveringOverLink :: (IsWebFrame a, MonadIO m) => a -> WebFrameHoveringOverLinkCallback -> m SignalHandlerId

wrap_WebFrameHoveringOverLinkCallback :: WebFrameHoveringOverLinkCallback -> Ptr () -> CString -> CString -> Ptr () -> IO ()

insecureContentRun

type C_WebFrameInsecureContentRunCallback = Ptr () -> Ptr SecurityOrigin -> CString -> Ptr () -> IO ()

type WebFrameInsecureContentRunCallback = SecurityOrigin -> Text -> IO ()

afterWebFrameInsecureContentRun :: (IsWebFrame a, MonadIO m) => a -> WebFrameInsecureContentRunCallback -> m SignalHandlerId

genClosure_WebFrameInsecureContentRun :: WebFrameInsecureContentRunCallback -> IO Closure

mk_WebFrameInsecureContentRunCallback :: C_WebFrameInsecureContentRunCallback -> IO (FunPtr C_WebFrameInsecureContentRunCallback)

noWebFrameInsecureContentRunCallback :: Maybe WebFrameInsecureContentRunCallback

onWebFrameInsecureContentRun :: (IsWebFrame a, MonadIO m) => a -> WebFrameInsecureContentRunCallback -> m SignalHandlerId

wrap_WebFrameInsecureContentRunCallback :: WebFrameInsecureContentRunCallback -> Ptr () -> Ptr SecurityOrigin -> CString -> Ptr () -> IO ()

loadCommitted

type C_WebFrameLoadCommittedCallback = Ptr () -> Ptr () -> IO ()

type WebFrameLoadCommittedCallback = IO ()

Deprecated: Use the "load-status" property instead.

afterWebFrameLoadCommitted :: (IsWebFrame a, MonadIO m) => a -> WebFrameLoadCommittedCallback -> m SignalHandlerId

genClosure_WebFrameLoadCommitted :: WebFrameLoadCommittedCallback -> IO Closure

mk_WebFrameLoadCommittedCallback :: C_WebFrameLoadCommittedCallback -> IO (FunPtr C_WebFrameLoadCommittedCallback)

noWebFrameLoadCommittedCallback :: Maybe WebFrameLoadCommittedCallback

onWebFrameLoadCommitted :: (IsWebFrame a, MonadIO m) => a -> WebFrameLoadCommittedCallback -> m SignalHandlerId

wrap_WebFrameLoadCommittedCallback :: WebFrameLoadCommittedCallback -> Ptr () -> Ptr () -> IO ()

resourceContentLengthReceived

type C_WebFrameResourceContentLengthReceivedCallback = Ptr () -> Ptr WebResource -> Int32 -> Ptr () -> IO ()

type WebFrameResourceContentLengthReceivedCallback = WebResource -> Int32 -> IO ()

afterWebFrameResourceContentLengthReceived :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceContentLengthReceivedCallback -> m SignalHandlerId

genClosure_WebFrameResourceContentLengthReceived :: WebFrameResourceContentLengthReceivedCallback -> IO Closure

mk_WebFrameResourceContentLengthReceivedCallback :: C_WebFrameResourceContentLengthReceivedCallback -> IO (FunPtr C_WebFrameResourceContentLengthReceivedCallback)

noWebFrameResourceContentLengthReceivedCallback :: Maybe WebFrameResourceContentLengthReceivedCallback

onWebFrameResourceContentLengthReceived :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceContentLengthReceivedCallback -> m SignalHandlerId

wrap_WebFrameResourceContentLengthReceivedCallback :: WebFrameResourceContentLengthReceivedCallback -> Ptr () -> Ptr WebResource -> Int32 -> Ptr () -> IO ()

resourceLoadFailed

type C_WebFrameResourceLoadFailedCallback = Ptr () -> Ptr WebResource -> Ptr () -> Ptr () -> IO ()

type WebFrameResourceLoadFailedCallback = WebResource -> Ptr () -> IO ()

afterWebFrameResourceLoadFailed :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceLoadFailedCallback -> m SignalHandlerId

genClosure_WebFrameResourceLoadFailed :: WebFrameResourceLoadFailedCallback -> IO Closure

mk_WebFrameResourceLoadFailedCallback :: C_WebFrameResourceLoadFailedCallback -> IO (FunPtr C_WebFrameResourceLoadFailedCallback)

noWebFrameResourceLoadFailedCallback :: Maybe WebFrameResourceLoadFailedCallback

onWebFrameResourceLoadFailed :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceLoadFailedCallback -> m SignalHandlerId

wrap_WebFrameResourceLoadFailedCallback :: WebFrameResourceLoadFailedCallback -> Ptr () -> Ptr WebResource -> Ptr () -> Ptr () -> IO ()

resourceLoadFinished

type C_WebFrameResourceLoadFinishedCallback = Ptr () -> Ptr WebResource -> Ptr () -> IO ()

type WebFrameResourceLoadFinishedCallback = WebResource -> IO ()

afterWebFrameResourceLoadFinished :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceLoadFinishedCallback -> m SignalHandlerId

genClosure_WebFrameResourceLoadFinished :: WebFrameResourceLoadFinishedCallback -> IO Closure

mk_WebFrameResourceLoadFinishedCallback :: C_WebFrameResourceLoadFinishedCallback -> IO (FunPtr C_WebFrameResourceLoadFinishedCallback)

noWebFrameResourceLoadFinishedCallback :: Maybe WebFrameResourceLoadFinishedCallback

onWebFrameResourceLoadFinished :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceLoadFinishedCallback -> m SignalHandlerId

wrap_WebFrameResourceLoadFinishedCallback :: WebFrameResourceLoadFinishedCallback -> Ptr () -> Ptr WebResource -> Ptr () -> IO ()

resourceRequestStarting

type C_WebFrameResourceRequestStartingCallback = Ptr () -> Ptr WebResource -> Ptr NetworkRequest -> Ptr NetworkResponse -> Ptr () -> IO ()

type WebFrameResourceRequestStartingCallback = WebResource -> NetworkRequest -> NetworkResponse -> IO ()

afterWebFrameResourceRequestStarting :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceRequestStartingCallback -> m SignalHandlerId

genClosure_WebFrameResourceRequestStarting :: WebFrameResourceRequestStartingCallback -> IO Closure

mk_WebFrameResourceRequestStartingCallback :: C_WebFrameResourceRequestStartingCallback -> IO (FunPtr C_WebFrameResourceRequestStartingCallback)

noWebFrameResourceRequestStartingCallback :: Maybe WebFrameResourceRequestStartingCallback

onWebFrameResourceRequestStarting :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceRequestStartingCallback -> m SignalHandlerId

wrap_WebFrameResourceRequestStartingCallback :: WebFrameResourceRequestStartingCallback -> Ptr () -> Ptr WebResource -> Ptr NetworkRequest -> Ptr NetworkResponse -> Ptr () -> IO ()

resourceResponseReceived

type C_WebFrameResourceResponseReceivedCallback = Ptr () -> Ptr WebResource -> Ptr NetworkResponse -> Ptr () -> IO ()

type WebFrameResourceResponseReceivedCallback = WebResource -> NetworkResponse -> IO ()

afterWebFrameResourceResponseReceived :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceResponseReceivedCallback -> m SignalHandlerId

genClosure_WebFrameResourceResponseReceived :: WebFrameResourceResponseReceivedCallback -> IO Closure

mk_WebFrameResourceResponseReceivedCallback :: C_WebFrameResourceResponseReceivedCallback -> IO (FunPtr C_WebFrameResourceResponseReceivedCallback)

noWebFrameResourceResponseReceivedCallback :: Maybe WebFrameResourceResponseReceivedCallback

onWebFrameResourceResponseReceived :: (IsWebFrame a, MonadIO m) => a -> WebFrameResourceResponseReceivedCallback -> m SignalHandlerId

wrap_WebFrameResourceResponseReceivedCallback :: WebFrameResourceResponseReceivedCallback -> Ptr () -> Ptr WebResource -> Ptr NetworkResponse -> Ptr () -> IO ()

scrollbarsPolicyChanged

type C_WebFrameScrollbarsPolicyChangedCallback = Ptr () -> Ptr () -> IO CInt

type WebFrameScrollbarsPolicyChangedCallback = IO Bool

afterWebFrameScrollbarsPolicyChanged :: (IsWebFrame a, MonadIO m) => a -> WebFrameScrollbarsPolicyChangedCallback -> m SignalHandlerId

genClosure_WebFrameScrollbarsPolicyChanged :: WebFrameScrollbarsPolicyChangedCallback -> IO Closure

mk_WebFrameScrollbarsPolicyChangedCallback :: C_WebFrameScrollbarsPolicyChangedCallback -> IO (FunPtr C_WebFrameScrollbarsPolicyChangedCallback)

noWebFrameScrollbarsPolicyChangedCallback :: Maybe WebFrameScrollbarsPolicyChangedCallback

onWebFrameScrollbarsPolicyChanged :: (IsWebFrame a, MonadIO m) => a -> WebFrameScrollbarsPolicyChangedCallback -> m SignalHandlerId

wrap_WebFrameScrollbarsPolicyChangedCallback :: WebFrameScrollbarsPolicyChangedCallback -> Ptr () -> Ptr () -> IO CInt

titleChanged

type C_WebFrameTitleChangedCallback = Ptr () -> CString -> Ptr () -> IO ()

type WebFrameTitleChangedCallback = Text -> IO ()

Deprecated: (Since version 1.1.18)Use "notify::title" instead.

afterWebFrameTitleChanged :: (IsWebFrame a, MonadIO m) => a -> WebFrameTitleChangedCallback -> m SignalHandlerId

genClosure_WebFrameTitleChanged :: WebFrameTitleChangedCallback -> IO Closure

mk_WebFrameTitleChangedCallback :: C_WebFrameTitleChangedCallback -> IO (FunPtr C_WebFrameTitleChangedCallback)

noWebFrameTitleChangedCallback :: Maybe WebFrameTitleChangedCallback

onWebFrameTitleChanged :: (IsWebFrame a, MonadIO m) => a -> WebFrameTitleChangedCallback -> m SignalHandlerId

wrap_WebFrameTitleChangedCallback :: WebFrameTitleChangedCallback -> Ptr () -> CString -> Ptr () -> IO ()