// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from webkit-gir-files
// DO NOT EDIT

use crate::{ffi, BackForwardListItem};
use glib::translate::*;

glib::wrapper! {
    /// 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 #WebKitBackForwardListItem<!-- -->s
    /// 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.
    ///
    ///
    #[doc(alias = "WebKitBackForwardList")]
    pub struct BackForwardList(Object<ffi::WebKitBackForwardList, ffi::WebKitBackForwardListClass>);

    match fn {
        type_ => || ffi::webkit_back_forward_list_get_type(),
    }
}

impl BackForwardList {
    /// Returns the item that precedes the current item.
    ///
    /// # Returns
    ///
    /// the #WebKitBackForwardListItem
    ///    preceding the current item or [`None`].
    #[doc(alias = "webkit_back_forward_list_get_back_item")]
    #[doc(alias = "get_back_item")]
    pub fn back_item(&self) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_back_item(
                self.to_glib_none().0,
            ))
        }
    }

    /// Obtain the list of items preceding the current one.
    ///
    /// # Returns
    ///
    /// a #GList of
    ///    items preceding the current item.
    #[doc(alias = "webkit_back_forward_list_get_back_list")]
    #[doc(alias = "get_back_list")]
    pub fn back_list(&self) -> Vec<BackForwardListItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::webkit_back_forward_list_get_back_list(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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.
    #[doc(alias = "webkit_back_forward_list_get_back_list_with_limit")]
    #[doc(alias = "get_back_list_with_limit")]
    pub fn back_list_with_limit(&self, limit: u32) -> Vec<BackForwardListItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(
                ffi::webkit_back_forward_list_get_back_list_with_limit(
                    self.to_glib_none().0,
                    limit,
                ),
            )
        }
    }

    /// Returns the current item in @self.
    ///
    /// # Returns
    ///
    /// a #WebKitBackForwardListItem
    ///    or [`None`] if @self is empty.
    #[doc(alias = "webkit_back_forward_list_get_current_item")]
    #[doc(alias = "get_current_item")]
    pub fn current_item(&self) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_current_item(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns the item that follows the current item.
    ///
    /// # Returns
    ///
    /// the #WebKitBackForwardListItem
    ///    following the current item or [`None`].
    #[doc(alias = "webkit_back_forward_list_get_forward_item")]
    #[doc(alias = "get_forward_item")]
    pub fn forward_item(&self) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_forward_item(
                self.to_glib_none().0,
            ))
        }
    }

    /// Obtain the list of items following the current one.
    ///
    /// # Returns
    ///
    /// a #GList of
    ///    items following the current item.
    #[doc(alias = "webkit_back_forward_list_get_forward_list")]
    #[doc(alias = "get_forward_list")]
    pub fn forward_list(&self) -> Vec<BackForwardListItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(
                ffi::webkit_back_forward_list_get_forward_list(self.to_glib_none().0),
            )
        }
    }

    /// 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.
    #[doc(alias = "webkit_back_forward_list_get_forward_list_with_limit")]
    #[doc(alias = "get_forward_list_with_limit")]
    pub fn forward_list_with_limit(&self, limit: u32) -> Vec<BackForwardListItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(
                ffi::webkit_back_forward_list_get_forward_list_with_limit(
                    self.to_glib_none().0,
                    limit,
                ),
            )
        }
    }

    /// Obtain the amount of items in the list.
    ///
    /// # Returns
    ///
    /// the length of @self.
    #[doc(alias = "webkit_back_forward_list_get_length")]
    #[doc(alias = "get_length")]
    pub fn length(&self) -> u32 {
        unsafe { ffi::webkit_back_forward_list_get_length(self.to_glib_none().0) }
    }

    /// 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`].
    #[doc(alias = "webkit_back_forward_list_get_nth_item")]
    #[doc(alias = "get_nth_item")]
    pub fn nth_item(&self, index: i32) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_nth_item(
                self.to_glib_none().0,
                index,
            ))
        }
    }

    //#[doc(alias = "changed")]
    //pub fn connect_changed<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId {
    //    Unimplemented items_removed: *.Pointer
    //}
}