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

use crate::BackForwardListItem;
use glib::object::IsA;
use glib::translate::*;
use std::fmt;

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 [`WebViewExt::go_back()`][crate::prelude::WebViewExt::go_back()] and [`WebViewExt::go_forward()`][crate::prelude::WebViewExt::go_forward()] move
    /// the current item backward or forward by one. Method
    /// [`WebViewExt::go_to_back_forward_list_item()`][crate::prelude::WebViewExt::go_to_back_forward_list_item()] sets the current item to the
    /// specified item. All other methods returning [`BackForwardListItem`][crate::BackForwardListItem]<!-- -->s
    /// do not change the value of the current item, they just return the requested
    /// item or items.
    ///
    /// # Implements
    ///
    /// [`BackForwardListExt`][trait@crate::prelude::BackForwardListExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "WebKitBackForwardList")]
    pub struct BackForwardList(Object<ffi::WebKitBackForwardList, ffi::WebKitBackForwardListClass>);

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

impl BackForwardList {
    pub const NONE: Option<&'static BackForwardList> = None;
}

/// Trait containing all [`struct@BackForwardList`] methods.
///
/// # Implementors
///
/// [`BackForwardList`][struct@crate::BackForwardList]
pub trait BackForwardListExt: 'static {
    /// Returns the item that precedes the current item.
    ///
    /// # Returns
    ///
    /// the [`BackForwardListItem`][crate::BackForwardListItem]
    ///  preceding the current item or [`None`].
    #[doc(alias = "webkit_back_forward_list_get_back_item")]
    #[doc(alias = "get_back_item")]
    fn back_item(&self) -> Option<BackForwardListItem>;

    /// 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")]
    fn back_list(&self) -> 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`.
    #[doc(alias = "webkit_back_forward_list_get_back_list_with_limit")]
    #[doc(alias = "get_back_list_with_limit")]
    fn back_list_with_limit(&self, limit: u32) -> Vec<BackForwardListItem>;

    /// Returns the current item in `self`.
    ///
    /// # Returns
    ///
    /// a [`BackForwardListItem`][crate::BackForwardListItem]
    ///  or [`None`] if `self` is empty.
    #[doc(alias = "webkit_back_forward_list_get_current_item")]
    #[doc(alias = "get_current_item")]
    fn current_item(&self) -> Option<BackForwardListItem>;

    /// Returns the item that follows the current item.
    ///
    /// # Returns
    ///
    /// the [`BackForwardListItem`][crate::BackForwardListItem]
    ///  following the current item or [`None`].
    #[doc(alias = "webkit_back_forward_list_get_forward_item")]
    #[doc(alias = "get_forward_item")]
    fn forward_item(&self) -> Option<BackForwardListItem>;

    /// 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")]
    fn forward_list(&self) -> 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`.
    #[doc(alias = "webkit_back_forward_list_get_forward_list_with_limit")]
    #[doc(alias = "get_forward_list_with_limit")]
    fn forward_list_with_limit(&self, limit: u32) -> Vec<BackForwardListItem>;

    /// 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")]
    fn length(&self) -> u32;

    /// Returns the item at a given index relative to the current item.
    /// ## `index`
    /// the index of the item
    ///
    /// # Returns
    ///
    /// the [`BackForwardListItem`][crate::BackForwardListItem]
    ///  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")]
    fn nth_item(&self, index: i32) -> Option<BackForwardListItem>;

    //#[doc(alias = "changed")]
    //fn connect_changed<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<BackForwardList>> BackForwardListExt for O {
    fn back_item(&self) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_back_item(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn back_list(&self) -> Vec<BackForwardListItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::webkit_back_forward_list_get_back_list(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    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.as_ref().to_glib_none().0,
                    limit,
                ),
            )
        }
    }

    fn current_item(&self) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_current_item(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn forward_item(&self) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_forward_item(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn forward_list(&self) -> Vec<BackForwardListItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(
                ffi::webkit_back_forward_list_get_forward_list(self.as_ref().to_glib_none().0),
            )
        }
    }

    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.as_ref().to_glib_none().0,
                    limit,
                ),
            )
        }
    }

    fn length(&self) -> u32 {
        unsafe { ffi::webkit_back_forward_list_get_length(self.as_ref().to_glib_none().0) }
    }

    fn nth_item(&self, index: i32) -> Option<BackForwardListItem> {
        unsafe {
            from_glib_none(ffi::webkit_back_forward_list_get_nth_item(
                self.as_ref().to_glib_none().0,
                index,
            ))
        }
    }

    //fn connect_changed<Unsupported or ignored types>(&self, f: F) -> SignalHandlerId {
    //    Unimplemented items_removed: *.Pointer
    //}
}

impl fmt::Display for BackForwardList {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("BackForwardList")
    }
}