Struct webkit6::BackForwardList

pub struct BackForwardList { /* private fields */ }

List of visited pages.

WebKitBackForwardList maintains a list of visited pages used to navigate to recent pages. Items are inserted in the list in the order they are visited.

WebKitBackForwardList also maintains the notion of the current item (which is always at index 0), the preceding item (which is at index -1), and the following item (which is at index 1). Methods webkit_web_view_go_back() and webkit_web_view_go_forward() move the current item backward or forward by one. Method webkit_web_view_go_to_back_forward_list_item() sets the current item to the specified item. All other methods returning #WebKitBackForwardListItems do not change the value of the current item, they just return the requested item or items.

Signals

changed

This signal is emitted when @back_forward_list changes. This happens when the current item is updated, a new item is added or one or more items are removed. Note that both @item_added and @items_removed can None when only the current item is updated. Items are only removed when the list is cleared or the maximum items limit is reached.

GLib type: GObject with reference counted clone semantics.

Implementations

impl BackForwardList

pub fn back_item(&self) -> Option<BackForwardListItem>

Returns the item that precedes the current item.

Returns

the #WebKitBackForwardListItem preceding the current item or None.

pub fn back_list(&self) -> Vec<BackForwardListItem>

Obtain the list of items preceding the current one.

Returns

a #GList of items preceding the current item.

pub fn back_list_with_limit(&self, limit: u32) -> Vec<BackForwardListItem>

Obtain a list up to some number of items preceding the current one.

limit

the number of items to retrieve

Returns

a #GList of items preceding the current item limited by @limit.

pub fn current_item(&self) -> Option<BackForwardListItem>

Returns the current item in @self.

Returns

a #WebKitBackForwardListItem or None if @self is empty.

pub fn forward_item(&self) -> Option<BackForwardListItem>

Returns the item that follows the current item.

Returns

the #WebKitBackForwardListItem following the current item or None.

pub fn forward_list(&self) -> Vec<BackForwardListItem>

Obtain the list of items following the current one.

Returns

a #GList of items following the current item.

pub fn forward_list_with_limit(&self, limit: u32) -> Vec<BackForwardListItem>

Obtain a list up to some number of items following the current one.

limit

the number of items to retrieve

Returns

a #GList of items following the current item limited by @limit.

pub fn length(&self) -> u32

Obtain the amount of items in the list.

Returns

the length of @self.

pub fn nth_item(&self, index: i32) -> Option<BackForwardListItem>

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

index

the index of the item

Returns

the #WebKitBackForwardListItem located at the specified index relative to the current item or None.

Trait Implementations

impl Clone for BackForwardList

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BackForwardList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for BackForwardList

type ParamSpec = ParamSpecObject

type SetValue = BackForwardList

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, BackForwardList>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for BackForwardList

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BackForwardList

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for BackForwardList

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for BackForwardList

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for BackForwardList

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for BackForwardList

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for BackForwardList