GI.WebKit.Objects.WebBackForwardList

<informalexample><programlisting> /<!-- -->* Get the WebKitWebBackForwardList from the WebKitWebView *<!-- -->/ WebKitWebBackForwardList *back_forward_list = webkit_web_view_get_back_forward_list (my_web_view); WebKitWebHistoryItem *item = webkit_web_back_forward_list_get_current_item (back_forward_list);

/<!-- -->* Do something with a WebKitWebHistoryItem *<!-- -->/ g_print("p", item);

/<!-- -->* Control some parameters *<!-- -->/ WebKitWebBackForwardList *back_forward_list = webkit_web_view_get_back_forward_list (my_web_view); webkit_web_back_forward_list_set_limit (back_forward_list, 30); </programlisting></informalexample>

Exported types

newtype WebBackForwardList

Constructors

WebBackForwardList (ManagedPtr WebBackForwardList)

Instances

GObject WebBackForwardList

Methods

gobjectType :: WebBackForwardList -> IO GType

IsObject WebBackForwardList

IsWebBackForwardList WebBackForwardList

class GObject o => IsWebBackForwardList o

Instances

(GObject a, UnknownAncestorError Constraint WebBackForwardList a) => IsWebBackForwardList a

IsWebBackForwardList WebBackForwardList

toWebBackForwardList :: (MonadIO m, IsWebBackForwardList o) => o -> m WebBackForwardList

noWebBackForwardList :: Maybe WebBackForwardList

Methods

addItem

webBackForwardListAddItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a, IsWebHistoryItem b)

=> a

webBackForwardList: a WebBackForwardList

-> b

historyItem: the WebHistoryItem to add

-> m ()

Adds the item to the WebBackForwardList.

The webBackForwardList will add a reference to the webHistoryItem, so you don't need to keep a reference once you've added it to the list.

Since: 1.1.1

clear

webBackForwardListClear

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: the WebBackForwardList to be cleared

-> m ()

Clears the webBackForwardList by removing all its elements. Note that not even the current page is kept in list when cleared so you would have to add it later. This method also clears the list of visited links which means that all links will appear unvisited.

Since: 1.3.1

containsItem

webBackForwardListContainsItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a, IsWebHistoryItem b)

=> a

webBackForwardList: a WebBackForwardList

-> b

historyItem: the WebHistoryItem to check

-> m Bool

Returns: True if webHistoryItem is in the back forward list, False if it doesn't

Checks if webHistoryItem is in the back forward list

getBackItem

webBackForwardListGetBackItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m WebHistoryItem

Returns: the WebHistoryItem preceding the current item

Returns the item that precedes the current item

getBackLength

webBackForwardListGetBackLength

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m Int32

Returns: a gint corresponding to the number of items preceding the current item

Returns the number of items that preced the current item.

getBackListWithLimit

webBackForwardListGetBackListWithLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> Int32

limit: the number of items to retrieve

-> m [WebHistoryItem]

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

Returns a list of items that precede the current item, limited by limit

getCurrentItem

webBackForwardListGetCurrentItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m WebHistoryItem

Returns: a WebHistoryItem

Returns the current item.

Returns a NULL value if the back forward list is empty

getForwardItem

webBackForwardListGetForwardItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m WebHistoryItem

Returns: a WebHistoryItem

Returns the item that succeeds the current item.

Returns a NULL value if there nothing that succeeds the current item

getForwardLength

webBackForwardListGetForwardLength

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m Int32

Returns: a gint corresponding to the nuber of items succeeding the current item

Returns the number of items that succeed the current item.

getForwardListWithLimit

webBackForwardListGetForwardListWithLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> Int32

limit: the number of items to retrieve

-> m [WebHistoryItem]

Returns: a List of items succeeding the current item, limited by limit

Returns a list of items that succeed the current item, limited by limit

getLimit

webBackForwardListGetLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m Int32

Returns: a gint indicating the number of WebHistoryItem the back forward list can hold

Returns the maximum limit of the back forward list.

getNthItem

webBackForwardListGetNthItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> Int32

index: the index of the item

-> m WebHistoryItem

Returns: the WebHistoryItem located at the specified index relative to the current item

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

goBack

webBackForwardListGoBack

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m ()

Steps backward in the back forward list

goForward

webBackForwardListGoForward

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> m ()

Steps forward in the back forward list

goToItem

webBackForwardListGoToItem

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a, IsWebHistoryItem b)

=> a

webBackForwardList: a WebBackForwardList

-> b

historyItem: the WebHistoryItem to go to

-> m ()

Go to the specified webHistoryItem in the back forward list

setLimit

webBackForwardListSetLimit

Arguments

:: (HasCallStack, MonadIO m, IsWebBackForwardList a)

=> a

webBackForwardList: a WebBackForwardList

-> Int32

limit: the limit to set the back forward list to

-> m ()

Sets the maximum limit of the back forward list. If the back forward list exceeds its capacity, items will be removed everytime a new item has been added.