gi-webkit-3.0.12: WebKit bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.WebKit.Objects.WebView

Contents

Description

WebView is the central class of the WebKitGTK+ API. It is a Widget implementing the scrolling interface which means you can embed in a ScrolledWindow. It is responsible for managing the drawing of the content, forwarding of events. You can load any URI into the WebView or any kind of data string. With WebSettings you can control various aspects of the rendering and loading of the content. Each WebView has exactly one WebFrame as main frame. A WebFrame can have n children.

<programlisting> /<!-- -->* Create the widgets *<!-- -->/ GtkWidget *main_window = gtk_window_new (GTK_WINDOW_TOPLEVEL); GtkWidget *scrolled_window = gtk_scrolled_window_new (NULL, NULL); GtkWidget *web_view = webkit_web_view_new ();

/<!-- -->* Place the WebKitWebView in the GtkScrolledWindow *<!-- -->/ gtk_container_add (GTK_CONTAINER (scrolled_window), web_view); gtk_container_add (GTK_CONTAINER (main_window), scrolled_window);

/<!-- -->* Open a webpage *<!-- -->/ webkit_web_view_load_uri (WEBKIT_WEB_VIEW (web_view), "http://www.gnome.org");

/<!-- -->* Show the result *<!-- -->/ gtk_window_set_default_size (GTK_WINDOW (main_window), 800, 600); gtk_widget_show_all (main_window); </programlisting>

Synopsis

Exported types

Methods

canCopyClipboard

webViewCanCopyClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if a selection can be copied, False if not

Determines whether or not it is currently possible to copy to the clipboard.

canCutClipboard

webViewCanCutClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if a selection can be cut, False if not

Determines whether or not it is currently possible to cut to the clipboard.

canGoBack

webViewCanGoBack Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if able to move back, False otherwise

Determines whether web_view has a previous history item.

canGoBackOrForward

webViewCanGoBackOrForward Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Int32

steps: the number of steps

-> m Bool

Returns: True if able to move back or forward the given number of steps, False otherwise

Determines whether web_view has a history item of steps. Negative values represent steps backward while positive values represent steps forward.

canGoForward

webViewCanGoForward Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if able to move forward, False otherwise

Determines whether web_view has a next history item.

canPasteClipboard

webViewCanPasteClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if a selection can be pasted, False if not

Determines whether or not it is currently possible to paste from the clipboard.

canRedo

data WebViewCanRedoMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsWebView a) => MethodInfo * WebViewCanRedoMethodInfo a signature Source # 

webViewCanRedo Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if a redo can be done, False if not

Determines whether or not it is currently possible to redo the last editing command in the view.

Since: 1.1.14

canShowMimeType

webViewCanShowMimeType Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

mimeType: a MIME type

-> m Bool

Returns: a Bool indicating if the MIME type can be displayed

This functions returns whether or not a MIME type can be displayed using this view.

Since: 1.0.3

canUndo

data WebViewCanUndoMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsWebView a) => MethodInfo * WebViewCanUndoMethodInfo a signature Source # 

webViewCanUndo Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if a undo can be done, False if not

Determines whether or not it is currently possible to undo the last editing command in the view.

Since: 1.1.14

copyClipboard

webViewCopyClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Copies the current selection inside the webView to the clipboard.

cutClipboard

webViewCutClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Cuts the current selection inside the webView to the clipboard.

deleteSelection

webViewDeleteSelection Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Deletes the current selection inside the webView.

executeScript

webViewExecuteScript :: (HasCallStack, MonadIO m, IsWebView a) => a -> Text -> m () Source #

No description available in the introspection data.

getBackForwardList

webViewGetBackForwardList Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m WebBackForwardList

Returns: the WebBackForwardList

Obtains the WebBackForwardList associated with the given WebView. The WebBackForwardList is owned by the WebView.

getCopyTargetList

webViewGetCopyTargetList Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m TargetList

Returns: the TargetList

This function returns the list of targets this WebView can provide for clipboard copying and as DND source. The targets in the list are added with values from the WebViewTargetInfo enum, using targetListAdd and targetListAddTextTargets.

getCustomEncoding

webViewGetCustomEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Text

Returns: a string containing the current custom encoding for webView, or Nothing if there's none set.

Returns the current encoding of the WebView, not the default-encoding of WebKitWebSettings.

Since: 1.1.1

getDomDocument

webViewGetDomDocument Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m DOMDocument

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

No description available in the introspection data.

Since: 1.3.1

getEditable

webViewGetEditable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: a Bool indicating the editable state

Returns whether the user is allowed to edit the document.

Returns True if webView allows the user to edit the HTML document, False if it doesn't. You can change webView's document programmatically regardless of this setting.

getEncoding

webViewGetEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Text

Returns: the default encoding

Returns the default encoding of the WebView.

Since: 1.1.1

getFocusedFrame

webViewGetFocusedFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m WebFrame

Returns: The focused WebFrame or Nothing if no frame is focused

Returns the frame that has focus or an active text selection.

getFullContentZoom

webViewGetFullContentZoom Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: False if only text should be scaled (the default), True if the full content of the view should be scaled.

Returns whether the zoom level affects only text or all elements.

Since: 1.0.1

getHitTestResult

webViewGetHitTestResult Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> EventButton

event: a EventButton

-> m HitTestResult

Returns: a newly created HitTestResult with the context of the specified position.

Does a 'hit test' in the coordinates specified by event to figure out context information about that position in the webView.

Since: 1.1.15

getIconPixbuf

webViewGetIconPixbuf Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: the WebView object

-> m Pixbuf

Returns: a new reference to a Pixbuf, or Nothing

Deprecated: (Since version 1.8)Use webViewTryGetFaviconPixbuf instead.

Obtains a Pixbuf of the favicon for the given WebView, or a default icon if there is no icon for the given page. Use webViewGetIconUri if you need to distinguish these cases. Usually you want to connect to WebKitWebView::icon-loaded and call this method in the callback.

The pixbuf will have the largest size provided by the server and should be resized before it is displayed. See also iconDatabaseGetIconPixbuf.

Since: 1.3.13

getIconUri

webViewGetIconUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: the WebView object

-> m Text

Returns: the URI for the favicon, or Nothing

Obtains the URI for the favicon for the given WebView, or Nothing if there is none.

Since: 1.1.18

getInspector

webViewGetInspector Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m WebInspector

Returns: the WebInspector instance.

Obtains the WebInspector associated with the WebView. Every WebView object has a WebInspector object attached to it as soon as it is created, so this function will only return NULL if the argument is not a valid WebView.

Since: 1.0.3

getLoadStatus

webViewGetLoadStatus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m LoadStatus

Returns: a LoadStatus specifying the status of the current load

Determines the current status of the load.

Since: 1.1.7

getMainFrame

webViewGetMainFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m WebFrame

Returns: the main WebFrame for webView

Returns the main frame for the webView.

getPasteTargetList

webViewGetPasteTargetList Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m TargetList

Returns: the TargetList

This function returns the list of targets this WebView can provide for clipboard pasting and as DND destination. The targets in the list are added with values from the WebViewTargetInfo enum, using targetListAdd and targetListAddTextTargets.

getProgress

webViewGetProgress Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Double

Returns: a gdouble representing the status of the current load. This value will be in the range [0, 1].

Determines the current progress of the load.

Since: 1.1.7

getSettings

webViewGetSettings Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m WebSettings

Returns: the WebSettings instance

Obtains the WebSettings associated with the WebView. The WebView always has an associated instance of WebSettings. The reference that is returned by this call is owned by the WebView. You may need to increase its reference count if you intend to keep it alive for longer than the WebView.

getSnapshot

webViewGetSnapshot Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Surface

Returns: a cairoSurfaceT

Retrieves a snapshot with the visible contents of webview.

Since: 1.10

getTitle

data WebViewGetTitleMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsWebView a) => MethodInfo * WebViewGetTitleMethodInfo a signature Source # 

webViewGetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Text

Returns: the title of webView

Returns the webView's document title

Since: 1.1.4

getTransparent

webViewGetTransparent Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: False when the WebView draws a solid background (the default), otherwise True.

Returns whether the WebView has a transparent background.

getUri

data WebViewGetUriMethodInfo Source #

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsWebView a) => MethodInfo * WebViewGetUriMethodInfo a signature Source # 

webViewGetUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m (Maybe Text)

Returns: the URI of webView

Returns the current URI of the contents displayed by the webView

Since: 1.1.4

getViewMode

webViewGetViewMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: the WebView to obtain the view mode from

-> m WebViewViewMode

Returns: the WebKitWebViewViewMode currently set for the WebView.

Gets the value of the view-mode property of the WebView. Check the property's documentation for more information.

Since: 1.3.4

getViewSourceMode

webViewGetViewSourceMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if webView is in view source mode, False otherwise.

No description available in the introspection data.

Since: 1.1.14

getViewportAttributes

webViewGetViewportAttributes Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m ViewportAttributes

Returns: the ViewportAttributes instance.

Obtains the ViewportAttributes associated with the WebView. Every WebView object has a ViewportAttributes object attached to it as soon as it is created, so this function will only return NULL if the argument is not a valid WebView. Do note however that the viewport attributes object only contains valid information when the current page has a viewport meta tag. You can check whether the data should be used by checking the ViewportAttributes:valid property.

Since: 1.3.8

getWindowFeatures

webViewGetWindowFeatures Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m WebWindowFeatures

Returns: the instance of WebWindowFeatures held by the given WebView.

No description available in the introspection data.

Since: 1.0.3

getZoomLevel

webViewGetZoomLevel Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Float

Returns: the zoom level of webView

Returns the zoom level of webView, i.e. the factor by which elements in the page are scaled with respect to their original size. If the "full-content-zoom" property is set to False (the default) the zoom level changes the text size, or if True, scales all elements in the page.

Since: 1.0.1

goBack

data WebViewGoBackMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewGoBackMethodInfo a signature Source # 

webViewGoBack Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Loads the previous history item.

goBackOrForward

webViewGoBackOrForward Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Int32

steps: the number of steps

-> m () 

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.

goForward

data WebViewGoForwardMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewGoForwardMethodInfo a signature Source # 

webViewGoForward Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Loads the next history item.

goToBackForwardItem

webViewGoToBackForwardItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a, IsWebHistoryItem b) 
=> a

webView: a WebView

-> b

item: a WebHistoryItem*

-> m Bool

Returns: True if loading of item is successful, False if not

Go to the specified WebHistoryItem

hasSelection

webViewHasSelection Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m Bool

Returns: True if there is selected text, False if not

Determines whether text was selected.

loadHtmlString

webViewLoadHtmlString Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

content: an URI string

-> Text

baseUri: the base URI for relative locations

-> m () 

Deprecated: (Since version 1.1.1)Use webViewLoadString instead.

Requests loading of the given content with the specified baseUri.

loadRequest

webViewLoadRequest Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a, IsNetworkRequest b) 
=> a

webView: a WebView

-> b

request: a NetworkRequest

-> m () 

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 webViewStopLoading to stop the load.

Since: 1.1.1

loadString

data WebViewLoadStringMethodInfo Source #

Instances

((~) * signature (Text -> Text -> Text -> Text -> m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewLoadStringMethodInfo a signature Source # 

webViewLoadString Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

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

loadUri

data WebViewLoadUriMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewLoadUriMethodInfo a signature Source # 

webViewLoadUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

uri: an URI string

-> m () 

Requests loading of the specified URI string.

Since: 1.1.1

markTextMatches

webViewMarkTextMatches Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

string: a string to look for

-> Bool

caseSensitive: whether to respect the case of text

-> Word32

limit: the maximum number of strings to look for or 0 for all

-> m Word32

Returns: the number of strings highlighted

Attempts to highlight all occurances of string inside web_view.

moveCursor

webViewMoveCursor Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> MovementStep

step: a MovementStep

-> Int32

count: integer describing the direction of the movement. 1 for forward, -1 for backwards.

-> m () 

Move the cursor in view as described by step and count.

Since: 1.1.4

new

webViewNew :: (HasCallStack, MonadIO m) => m WebView Source #

No description available in the introspection data.

open

data WebViewOpenMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewOpenMethodInfo a signature Source # 

Methods

overloadedMethod :: MethodProxy WebViewOpenMethodInfo a -> signature -> s #

webViewOpen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

uri: an URI

-> m () 

Deprecated: (Since version 1.1.1)Use webViewLoadUri instead.

Requests loading of the specified URI string.

pasteClipboard

webViewPasteClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Pastes the current contents of the clipboard to the webView.

redo

data WebViewRedoMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewRedoMethodInfo a signature Source # 

Methods

overloadedMethod :: MethodProxy WebViewRedoMethodInfo a -> signature -> s #

webViewRedo Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Redoes the last editing command in the view, if possible.

Since: 1.1.14

reload

data WebViewReloadMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewReloadMethodInfo a signature Source # 

webViewReload :: (HasCallStack, MonadIO m, IsWebView a) => a -> m () Source #

No description available in the introspection data.

reloadBypassCache

webViewReloadBypassCache Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Reloads the webView without using any cached data.

Since: 1.0.3

searchText

data WebViewSearchTextMethodInfo Source #

Instances

((~) * signature (Text -> Bool -> Bool -> Bool -> m Bool), MonadIO m, IsWebView a) => MethodInfo * WebViewSearchTextMethodInfo a signature Source # 

webViewSearchText Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

text: a string to look for

-> Bool

caseSensitive: whether to respect the case of text

-> Bool

forward: whether to find forward or not

-> Bool

wrap: whether to continue looking at the beginning after reaching the end

-> m Bool

Returns: True on success or False on failure

Looks for a specified string inside web_view.

selectAll

data WebViewSelectAllMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewSelectAllMethodInfo a signature Source # 

webViewSelectAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Attempts to select everything inside the webView.

setCustomEncoding

webViewSetCustomEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Text

encoding: the new encoding, or Nothing to restore the default encoding

-> m () 

Sets the current WebView encoding, without modifying the default one, and reloads the page.

Since: 1.1.1

setEditable

data WebViewSetEditableMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewSetEditableMethodInfo a signature Source # 

webViewSetEditable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Bool

flag: a Bool indicating the editable state

-> m () 

Sets whether webView allows the user to edit its HTML document.

If flag is True, webView allows the user to edit the document. If flag is False, an element in webView'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 webView's document programmatically regardless of this setting. By default a WebView 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 WebView editable without altering the document or DOM structure.

setFullContentZoom

webViewSetFullContentZoom Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Bool

fullContentZoom: False if only text should be scaled (the default), True if the full content of the view should be scaled.

-> m () 

Sets whether the zoom level affects only text or all elements.

Since: 1.0.1

setHighlightTextMatches

webViewSetHighlightTextMatches Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Bool

highlight: whether to highlight text matches

-> m () 

Highlights text matches previously marked by webkit_web_view_mark_text_matches.

setMaintainsBackForwardList

webViewSetMaintainsBackForwardList Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Bool

flag: to tell the view to maintain a back or forward list

-> m () 

Set the view to maintain a back or forward list of history items.

setSettings

data WebViewSetSettingsMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsWebView a, IsWebSettings b) => MethodInfo * WebViewSetSettingsMethodInfo a signature Source # 

webViewSetSettings Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a, IsWebSettings b) 
=> a

webView: a WebView

-> b

settings: the WebSettings to be set

-> m () 

Replaces the WebSettings instance that is currently attached to webView with settings. The reference held by the webView on the old WebSettings instance is dropped, and the reference count of settings is inscreased.

The settings are automatically applied to webView.

setTransparent

webViewSetTransparent Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Bool

flag: whether or not webView should be transparent

-> m () 

Sets whether the WebView has a transparent background.

Pass False to have the WebView draw a solid background (the default), otherwise True.

setViewMode

webViewSetViewMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: the WebView that will have its view mode set

-> WebViewViewMode

mode: the WebKitWebViewViewMode to be set

-> m () 

Sets the view-mode property of the WebView. Check the property's documentation for more information.

Since: 1.3.4

setViewSourceMode

webViewSetViewSourceMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Bool

viewSourceMode: the mode to turn on or off view source mode

-> m () 

Set whether the view should be in view source mode. Setting this mode to True before loading a URI will display the source of the web page in a nice and readable format.

Since: 1.1.14

setZoomLevel

webViewSetZoomLevel Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> Float

zoomLevel: the new zoom level

-> m () 

Sets the zoom level of webView, i.e. the factor by which elements in the page are scaled with respect to their original size. If the "full-content-zoom" property is set to False (the default) the zoom level changes the text size, or if True, scales all elements in the page.

Since: 1.0.1

stopLoading

data WebViewStopLoadingMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewStopLoadingMethodInfo a signature Source # 

webViewStopLoading Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Stops any ongoing load in the webView.

tryGetFaviconPixbuf

webViewTryGetFaviconPixbuf Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: the WebView object

-> Word32

width: the desired width for the icon

-> Word32

height: the desired height for the icon

-> m Pixbuf

Returns: a new reference to a Pixbuf, or Nothing

Obtains a Pixbuf of the favicon for the given WebView. This will return Nothing is there is no icon for the current WebView or if the icon is in the database but not available at the moment of this call. Use webViewGetIconUri if you need to distinguish these cases. Usually you want to connect to WebKitWebView::icon-loaded and call this method in the callback.

See also faviconDatabaseTryGetFaviconPixbuf. Contrary to this function the icon database one returns the URL of the page containing the icon.

Since: 1.8

undo

data WebViewUndoMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewUndoMethodInfo a signature Source # 

Methods

overloadedMethod :: MethodProxy WebViewUndoMethodInfo a -> signature -> s #

webViewUndo Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Undoes the last editing command in the view, if possible.

Since: 1.1.14

unmarkTextMatches

webViewUnmarkTextMatches Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Removes highlighting previously set by webkit_web_view_mark_text_matches.

zoomIn

data WebViewZoomInMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewZoomInMethodInfo a signature Source # 

webViewZoomIn Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Increases the zoom level of webView. The current zoom level is incremented by the value of the "zoom-step" property of the WebSettings associated with webView.

Since: 1.0.1

zoomOut

data WebViewZoomOutMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsWebView a) => MethodInfo * WebViewZoomOutMethodInfo a signature Source # 

webViewZoomOut Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebView a) 
=> a

webView: a WebView

-> m () 

Decreases the zoom level of webView. The current zoom level is decremented by the value of the "zoom-step" property of the WebSettings associated with webView.

Since: 1.0.1

Properties

copyTargetList

data WebViewCopyTargetListPropertyInfo Source #

Instances

AttrInfo WebViewCopyTargetListPropertyInfo Source # 
type AttrOrigin WebViewCopyTargetListPropertyInfo Source # 
type AttrLabel WebViewCopyTargetListPropertyInfo Source # 
type AttrGetType WebViewCopyTargetListPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewCopyTargetListPropertyInfo Source # 
type AttrSetTypeConstraint WebViewCopyTargetListPropertyInfo Source # 
type AttrAllowedOps WebViewCopyTargetListPropertyInfo Source # 

customEncoding

data WebViewCustomEncodingPropertyInfo Source #

Instances

AttrInfo WebViewCustomEncodingPropertyInfo Source # 
type AttrOrigin WebViewCustomEncodingPropertyInfo Source # 
type AttrLabel WebViewCustomEncodingPropertyInfo Source # 
type AttrGetType WebViewCustomEncodingPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewCustomEncodingPropertyInfo Source # 
type AttrSetTypeConstraint WebViewCustomEncodingPropertyInfo Source # 
type AttrAllowedOps WebViewCustomEncodingPropertyInfo Source # 

editable

data WebViewEditablePropertyInfo Source #

Instances

AttrInfo WebViewEditablePropertyInfo Source # 
type AttrOrigin WebViewEditablePropertyInfo Source # 
type AttrLabel WebViewEditablePropertyInfo Source # 
type AttrGetType WebViewEditablePropertyInfo Source # 
type AttrBaseTypeConstraint WebViewEditablePropertyInfo Source # 
type AttrSetTypeConstraint WebViewEditablePropertyInfo Source # 
type AttrAllowedOps WebViewEditablePropertyInfo Source # 

setWebViewEditable :: (MonadIO m, IsWebView o) => o -> Bool -> m () Source #

encoding

data WebViewEncodingPropertyInfo Source #

Instances

AttrInfo WebViewEncodingPropertyInfo Source # 
type AttrOrigin WebViewEncodingPropertyInfo Source # 
type AttrLabel WebViewEncodingPropertyInfo Source # 
type AttrGetType WebViewEncodingPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewEncodingPropertyInfo Source # 
type AttrSetTypeConstraint WebViewEncodingPropertyInfo Source # 
type AttrAllowedOps WebViewEncodingPropertyInfo Source # 

fullContentZoom

data WebViewFullContentZoomPropertyInfo Source #

Instances

AttrInfo WebViewFullContentZoomPropertyInfo Source # 
type AttrOrigin WebViewFullContentZoomPropertyInfo Source # 
type AttrLabel WebViewFullContentZoomPropertyInfo Source # 
type AttrGetType WebViewFullContentZoomPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewFullContentZoomPropertyInfo Source # 
type AttrSetTypeConstraint WebViewFullContentZoomPropertyInfo Source # 
type AttrAllowedOps WebViewFullContentZoomPropertyInfo Source # 

iconUri

data WebViewIconUriPropertyInfo Source #

Instances

AttrInfo WebViewIconUriPropertyInfo Source # 
type AttrOrigin WebViewIconUriPropertyInfo Source # 
type AttrLabel WebViewIconUriPropertyInfo Source # 
type AttrGetType WebViewIconUriPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewIconUriPropertyInfo Source # 
type AttrSetTypeConstraint WebViewIconUriPropertyInfo Source # 
type AttrAllowedOps WebViewIconUriPropertyInfo Source # 

imContext

data WebViewImContextPropertyInfo Source #

Instances

AttrInfo WebViewImContextPropertyInfo Source # 
type AttrOrigin WebViewImContextPropertyInfo Source # 
type AttrLabel WebViewImContextPropertyInfo Source # 
type AttrGetType WebViewImContextPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewImContextPropertyInfo Source # 
type AttrSetTypeConstraint WebViewImContextPropertyInfo Source # 
type AttrAllowedOps WebViewImContextPropertyInfo Source # 

loadStatus

data WebViewLoadStatusPropertyInfo Source #

Instances

AttrInfo WebViewLoadStatusPropertyInfo Source # 
type AttrOrigin WebViewLoadStatusPropertyInfo Source # 
type AttrLabel WebViewLoadStatusPropertyInfo Source # 
type AttrGetType WebViewLoadStatusPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewLoadStatusPropertyInfo Source # 
type AttrSetTypeConstraint WebViewLoadStatusPropertyInfo Source # 
type AttrAllowedOps WebViewLoadStatusPropertyInfo Source # 

pasteTargetList

data WebViewPasteTargetListPropertyInfo Source #

Instances

AttrInfo WebViewPasteTargetListPropertyInfo Source # 
type AttrOrigin WebViewPasteTargetListPropertyInfo Source # 
type AttrLabel WebViewPasteTargetListPropertyInfo Source # 
type AttrGetType WebViewPasteTargetListPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewPasteTargetListPropertyInfo Source # 
type AttrSetTypeConstraint WebViewPasteTargetListPropertyInfo Source # 
type AttrAllowedOps WebViewPasteTargetListPropertyInfo Source # 

progress

data WebViewProgressPropertyInfo Source #

Instances

AttrInfo WebViewProgressPropertyInfo Source # 
type AttrOrigin WebViewProgressPropertyInfo Source # 
type AttrLabel WebViewProgressPropertyInfo Source # 
type AttrGetType WebViewProgressPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewProgressPropertyInfo Source # 
type AttrSetTypeConstraint WebViewProgressPropertyInfo Source # 
type AttrAllowedOps WebViewProgressPropertyInfo Source # 

selfScrolling

data WebViewSelfScrollingPropertyInfo Source #

Instances

AttrInfo WebViewSelfScrollingPropertyInfo Source # 
type AttrOrigin WebViewSelfScrollingPropertyInfo Source # 
type AttrLabel WebViewSelfScrollingPropertyInfo Source # 
type AttrGetType WebViewSelfScrollingPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewSelfScrollingPropertyInfo Source # 
type AttrSetTypeConstraint WebViewSelfScrollingPropertyInfo Source # 
type AttrAllowedOps WebViewSelfScrollingPropertyInfo Source # 

settings

data WebViewSettingsPropertyInfo Source #

Instances

AttrInfo WebViewSettingsPropertyInfo Source # 
type AttrOrigin WebViewSettingsPropertyInfo Source # 
type AttrLabel WebViewSettingsPropertyInfo Source # 
type AttrGetType WebViewSettingsPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewSettingsPropertyInfo Source # 
type AttrSetTypeConstraint WebViewSettingsPropertyInfo Source # 
type AttrAllowedOps WebViewSettingsPropertyInfo Source # 

setWebViewSettings :: (MonadIO m, IsWebView o, IsWebSettings a) => o -> a -> m () Source #

title

data WebViewTitlePropertyInfo Source #

Instances

AttrInfo WebViewTitlePropertyInfo Source # 
type AttrOrigin WebViewTitlePropertyInfo Source # 
type AttrLabel WebViewTitlePropertyInfo Source # 
type AttrGetType WebViewTitlePropertyInfo Source # 
type AttrBaseTypeConstraint WebViewTitlePropertyInfo Source # 
type AttrSetTypeConstraint WebViewTitlePropertyInfo Source # 
type AttrAllowedOps WebViewTitlePropertyInfo Source # 

transparent

data WebViewTransparentPropertyInfo Source #

Instances

AttrInfo WebViewTransparentPropertyInfo Source # 
type AttrOrigin WebViewTransparentPropertyInfo Source # 
type AttrLabel WebViewTransparentPropertyInfo Source # 
type AttrGetType WebViewTransparentPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewTransparentPropertyInfo Source # 
type AttrSetTypeConstraint WebViewTransparentPropertyInfo Source # 
type AttrAllowedOps WebViewTransparentPropertyInfo Source # 

uri

data WebViewUriPropertyInfo Source #

Instances

AttrInfo WebViewUriPropertyInfo Source # 
type AttrOrigin WebViewUriPropertyInfo Source # 
type AttrLabel WebViewUriPropertyInfo Source # 
type AttrGetType WebViewUriPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewUriPropertyInfo Source # 
type AttrSetTypeConstraint WebViewUriPropertyInfo Source # 
type AttrAllowedOps WebViewUriPropertyInfo Source # 

viewMode

data WebViewViewModePropertyInfo Source #

Instances

AttrInfo WebViewViewModePropertyInfo Source # 
type AttrOrigin WebViewViewModePropertyInfo Source # 
type AttrLabel WebViewViewModePropertyInfo Source # 
type AttrGetType WebViewViewModePropertyInfo Source # 
type AttrBaseTypeConstraint WebViewViewModePropertyInfo Source # 
type AttrSetTypeConstraint WebViewViewModePropertyInfo Source # 
type AttrAllowedOps WebViewViewModePropertyInfo Source # 

viewportAttributes

data WebViewViewportAttributesPropertyInfo Source #

Instances

AttrInfo WebViewViewportAttributesPropertyInfo Source # 
type AttrOrigin WebViewViewportAttributesPropertyInfo Source # 
type AttrLabel WebViewViewportAttributesPropertyInfo Source # 
type AttrGetType WebViewViewportAttributesPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewViewportAttributesPropertyInfo Source # 
type AttrSetTypeConstraint WebViewViewportAttributesPropertyInfo Source # 
type AttrAllowedOps WebViewViewportAttributesPropertyInfo Source # 

webInspector

data WebViewWebInspectorPropertyInfo Source #

Instances

AttrInfo WebViewWebInspectorPropertyInfo Source # 
type AttrOrigin WebViewWebInspectorPropertyInfo Source # 
type AttrLabel WebViewWebInspectorPropertyInfo Source # 
type AttrGetType WebViewWebInspectorPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewWebInspectorPropertyInfo Source # 
type AttrSetTypeConstraint WebViewWebInspectorPropertyInfo Source # 
type AttrAllowedOps WebViewWebInspectorPropertyInfo Source # 

windowFeatures

data WebViewWindowFeaturesPropertyInfo Source #

Instances

AttrInfo WebViewWindowFeaturesPropertyInfo Source # 
type AttrOrigin WebViewWindowFeaturesPropertyInfo Source # 
type AttrLabel WebViewWindowFeaturesPropertyInfo Source # 
type AttrGetType WebViewWindowFeaturesPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewWindowFeaturesPropertyInfo Source # 
type AttrSetTypeConstraint WebViewWindowFeaturesPropertyInfo Source # 
type AttrAllowedOps WebViewWindowFeaturesPropertyInfo Source # 

zoomLevel

data WebViewZoomLevelPropertyInfo Source #

Instances

AttrInfo WebViewZoomLevelPropertyInfo Source # 
type AttrOrigin WebViewZoomLevelPropertyInfo Source # 
type AttrLabel WebViewZoomLevelPropertyInfo Source # 
type AttrGetType WebViewZoomLevelPropertyInfo Source # 
type AttrBaseTypeConstraint WebViewZoomLevelPropertyInfo Source # 
type AttrSetTypeConstraint WebViewZoomLevelPropertyInfo Source # 
type AttrAllowedOps WebViewZoomLevelPropertyInfo Source # 

Signals

closeWebView

consoleMessage

contextMenu

copyClipboard

createPluginWidget

createWebView

cutClipboard

databaseQuotaExceeded

documentLoadFinished

downloadRequested

editingBegan

editingEnded

enteringFullscreen

frameCreated

geolocationPolicyDecisionCancelled

geolocationPolicyDecisionRequested

hoveringOverLink

iconLoaded

leavingFullscreen

loadCommitted

type WebViewLoadCommittedCallback = WebFrame -> IO () Source #

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

loadError

loadFinished

type WebViewLoadFinishedCallback = WebFrame -> IO () Source #

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

loadProgressChanged

type WebViewLoadProgressChangedCallback = Int32 -> IO () Source #

Deprecated: Use the "progress" property instead.

loadStarted

type WebViewLoadStartedCallback = WebFrame -> IO () Source #

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

mimeTypePolicyDecisionRequested

moveCursor

navigationPolicyDecisionRequested

navigationRequested

type WebViewNavigationRequestedCallback = WebFrame -> NetworkRequest -> IO NavigationResponse Source #

Deprecated: Use WebKitWebView::navigation-policy-decision-requestedinstead

newWindowPolicyDecisionRequested

onloadEvent

pasteClipboard

populatePopup

type WebViewPopulatePopupCallback = Menu -> IO () Source #

Deprecated: (Since version 1.10)Use WebView::context-menu signal instead.

printRequested

redo

type C_WebViewRedoCallback = Ptr () -> Ptr () -> IO () Source #

resourceContentLengthReceived

resourceLoadFailed

resourceLoadFinished

resourceRequestStarting

resourceResponseReceived

runFileChooser

scriptAlert

scriptConfirm

scriptPrompt

selectAll

selectionChanged

shouldApplyStyle

shouldBeginEditing

shouldChangeSelectedRange

shouldDeleteRange

shouldEndEditing

shouldInsertNode

shouldInsertText

shouldShowDeleteInterfaceForElement

statusBarTextChanged

titleChanged

type WebViewTitleChangedCallback = WebFrame -> Text -> IO () Source #

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

undo

type C_WebViewUndoCallback = Ptr () -> Ptr () -> IO () Source #

userChangedContents

viewportAttributesChanged

viewportAttributesRecomputeRequested

webViewReady

windowObjectCleared

type C_WebViewWindowObjectClearedCallback = Ptr () -> Ptr WebFrame -> Ptr () -> Ptr () -> Ptr () -> IO () Source #