GI.WebKit2.Objects.BackForwardList

No description available in the introspection data.

Exported types

newtype BackForwardList

Memory-managed wrapper type.

Constructors

BackForwardList (ManagedPtr BackForwardList)

Instances

GObject BackForwardList

Defined in GI.WebKit2.Objects.BackForwardList

Methods

gobjectType :: IO GType

HasParentTypes BackForwardList

Defined in GI.WebKit2.Objects.BackForwardList

type ParentTypes BackForwardList

Defined in GI.WebKit2.Objects.BackForwardList

type ParentTypes BackForwardList = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf BackForwardList o) => IsBackForwardList o

Type class for types which can be safely cast to BackForwardList, for instance with toBackForwardList.

Instances

(GObject o, IsDescendantOf BackForwardList o) => IsBackForwardList o

Defined in GI.WebKit2.Objects.BackForwardList

toBackForwardList :: (MonadIO m, IsBackForwardList o) => o -> m BackForwardList

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

noBackForwardList :: Maybe BackForwardList

A convenience alias for Nothing :: Maybe BackForwardList.

Methods

getBackItem

backForwardListGetBackItem

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> m (Maybe BackForwardListItem)

Returns: the BackForwardListItem preceding the current item or Nothing.

Returns the item that precedes the current item.

getBackList

backForwardListGetBackList

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> m [BackForwardListItem]

Returns: a List of items preceding the current item.

No description available in the introspection data.

getBackListWithLimit

backForwardListGetBackListWithLimit

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> Word32

limit: the number of items to retrieve

-> m [BackForwardListItem]

Returns: a List of items preceding the current item limited by limit.

No description available in the introspection data.

getCurrentItem

backForwardListGetCurrentItem

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> m (Maybe BackForwardListItem)

Returns: a BackForwardListItem or Nothing if backForwardList is empty.

Returns the current item in backForwardList.

getForwardItem

backForwardListGetForwardItem

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> m (Maybe BackForwardListItem)

Returns: the BackForwardListItem following the current item or Nothing.

Returns the item that follows the current item.

getForwardList

backForwardListGetForwardList

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> m [BackForwardListItem]

Returns: a List of items following the current item.

No description available in the introspection data.

getForwardListWithLimit

backForwardListGetForwardListWithLimit

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> Word32

limit: the number of items to retrieve

-> m [BackForwardListItem]

Returns: a List of items following the current item limited by limit.

No description available in the introspection data.

getLength

backForwardListGetLength

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> m Word32

Returns: the length of backForwardList.

No description available in the introspection data.

getNthItem

backForwardListGetNthItem

Arguments

:: (HasCallStack, MonadIO m, IsBackForwardList a)

=> a

backForwardList: a BackForwardList

-> Int32

index: the index of the item

-> m (Maybe BackForwardListItem)

Returns: the BackForwardListItem located at the specified index relative to the current item or Nothing.

Returns the item at a given index relative to the current item.

Signals

changed

type BackForwardListChangedCallback

Arguments

 = Maybe BackForwardListItem

itemAdded: the BackForwardListItem added or Nothing

-> Ptr ()

itemsRemoved: a List of BackForwardListItem<!-- -->s

-> IO ()

This signal is emitted when backForwardList changes. This happens when the current item is updated, a new item is added or one or more items are removed. Note that both itemAdded and itemsRemoved can Nothing when only the current item is updated. Items are only removed when the list is cleared or the maximum items limit is reached.

type C_BackForwardListChangedCallback = Ptr () -> Ptr BackForwardListItem -> Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterBackForwardListChanged :: (IsBackForwardList a, MonadIO m) => a -> BackForwardListChangedCallback -> m SignalHandlerId

Connect a signal handler for the “changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after backForwardList #changed callback

genClosure_BackForwardListChanged :: MonadIO m => BackForwardListChangedCallback -> m (GClosure C_BackForwardListChangedCallback)

Wrap the callback into a GClosure.

mk_BackForwardListChangedCallback :: C_BackForwardListChangedCallback -> IO (FunPtr C_BackForwardListChangedCallback)

Generate a function pointer callable from C code, from a C_BackForwardListChangedCallback.

noBackForwardListChangedCallback :: Maybe BackForwardListChangedCallback

A convenience synonym for Nothing :: Maybe BackForwardListChangedCallback.

onBackForwardListChanged :: (IsBackForwardList a, MonadIO m) => a -> BackForwardListChangedCallback -> m SignalHandlerId

Connect a signal handler for the “changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on backForwardList #changed callback

wrap_BackForwardListChangedCallback :: BackForwardListChangedCallback -> C_BackForwardListChangedCallback

Wrap a BackForwardListChangedCallback into a C_BackForwardListChangedCallback.