GI.WebKit2WebExtension.Objects.Frame

A web page frame.

Each WebKitWebPage has at least one main frame, and can have any number of subframes.

Since: 2.26

Exported types

newtype Frame

Memory-managed wrapper type.

Constructors

Frame (ManagedPtr Frame)

Instances

Eq Frame

Defined in GI.WebKit2WebExtension.Objects.Frame

Methods

(==) :: Frame -> Frame -> Bool

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

GObject Frame

Defined in GI.WebKit2WebExtension.Objects.Frame

ManagedPtrNewtype Frame

Defined in GI.WebKit2WebExtension.Objects.Frame

Methods

toManagedPtr :: Frame -> ManagedPtr Frame

TypedObject Frame

Defined in GI.WebKit2WebExtension.Objects.Frame

Methods

glibType :: IO GType

HasParentTypes Frame

Defined in GI.WebKit2WebExtension.Objects.Frame

IsGValue (Maybe Frame)

Convert Frame to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2WebExtension.Objects.Frame

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Frame -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Frame)

type ParentTypes Frame

Defined in GI.WebKit2WebExtension.Objects.Frame

type ParentTypes Frame = '[Object]

class (GObject o, IsDescendantOf Frame o) => IsFrame o

Type class for types which can be safely cast to Frame, for instance with toFrame.

Instances

(GObject o, IsDescendantOf Frame o) => IsFrame o

Defined in GI.WebKit2WebExtension.Objects.Frame

toFrame :: (MonadIO m, IsFrame o) => o -> m Frame

Cast to Frame, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, isMainFrame, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getId, getJsContext, getJsContextForScriptWorld, getJsValueForDomObject, getJsValueForDomObjectInScriptWorld, getProperty, getQdata, getUri.

Setters

setData, setDataFull, setProperty.

getId

frameGetId

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m Word64

Returns: the identifier of frame

Gets the process-unique identifier of this Frame. No other frame in the same web process will have the same ID; however, frames in other web processes may.

Since: 2.26

getJsContext

frameGetJsContext

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m Context

Returns: the Context for the JavaScript execution context of frame.

Get the JavaScript execution context of frame. Use this function to bridge between the WebKit and JavaScriptCore APIs.

Since: 2.22

getJsContextForScriptWorld

frameGetJsContextForScriptWorld

Arguments

:: (HasCallStack, MonadIO m, IsFrame a, IsScriptWorld b)

=> a

frame: a Frame

-> b

world: a ScriptWorld

-> m Context

Returns: the Context for the JavaScript execution context of frame for world.

Get the JavaScript execution context of frame for the given ScriptWorld.

Since: 2.22

getJsValueForDomObject

frameGetJsValueForDomObject

Arguments

:: (HasCallStack, MonadIO m, IsFrame a, IsDOMObject b)

=> a

frame: a Frame

-> b

domObject: a DOMObject

-> m Value

Returns: the Value referencing domObject.

Get a Value referencing the given DOM object. The value is created in the JavaScript execution context of frame.

Since: 2.22

getJsValueForDomObjectInScriptWorld

frameGetJsValueForDomObjectInScriptWorld

Arguments

:: (HasCallStack, MonadIO m, IsFrame a, IsDOMObject b, IsScriptWorld c)

=> a

frame: a Frame

-> b

domObject: a DOMObject

-> c

world: a ScriptWorld

-> m Value

Returns: the Value referencing domObject

Get a Value referencing the given DOM object. The value is created in the JavaScript execution context of frame for the given ScriptWorld.

Since: 2.22

getUri

frameGetUri

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m (Maybe Text)

Returns: the current active URI of frame or Nothing if nothing has been loaded yet.

Gets the current active URI of frame.

Since: 2.2

isMainFrame

frameIsMainFrame

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m Bool

Returns: True if frame is a main frame or False otherwise

Gets whether frame is the main frame of a WebPage

Since: 2.2