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

use crate::Widget;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    /// [`ListHeader`][crate::ListHeader] is used by list widgets to represent the headers they
    /// display.
    ///
    /// [`ListHeader`][crate::ListHeader] objects are managed just like [`ListItem`][crate::ListItem]
    /// objects via their factory, but provide a different set of properties suitable
    /// for managing the header instead of individual items.
    ///
    /// ## Properties
    ///
    ///
    /// #### `child`
    ///  Widget used for display.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `end`
    ///  The first position no longer part of this section.
    ///
    /// Readable
    ///
    ///
    /// #### `item`
    ///  The item at the start of the section.
    ///
    /// Readable
    ///
    ///
    /// #### `n-items`
    ///  Number of items in this section.
    ///
    /// Readable
    ///
    ///
    /// #### `start`
    ///  First position of items in this section.
    ///
    /// Readable
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkListHeader")]
    pub struct ListHeader(Object<ffi::GtkListHeader, ffi::GtkListHeaderClass>);

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

impl ListHeader {
    /// Gets the child previously set via gtk_list_header_set_child() or
    /// [`None`] if none was set.
    ///
    /// # Returns
    ///
    /// The child
    #[doc(alias = "gtk_list_header_get_child")]
    #[doc(alias = "get_child")]
    pub fn child(&self) -> Option<Widget> {
        unsafe { from_glib_none(ffi::gtk_list_header_get_child(self.to_glib_none().0)) }
    }

    /// Gets the end position in the model of the section that @self is
    /// currently the header for.
    ///
    /// If @self is unbound, `GTK_INVALID_LIST_POSITION` is returned.
    ///
    /// # Returns
    ///
    /// The end position of the section
    #[doc(alias = "gtk_list_header_get_end")]
    #[doc(alias = "get_end")]
    pub fn end(&self) -> u32 {
        unsafe { ffi::gtk_list_header_get_end(self.to_glib_none().0) }
    }

    /// Gets the model item at the start of the section.
    /// This is the item that occupies the list model at position
    /// [`start`][struct@crate::ListHeader#start].
    ///
    /// If @self is unbound, this function returns [`None`].
    ///
    /// # Returns
    ///
    /// The item displayed
    #[doc(alias = "gtk_list_header_get_item")]
    #[doc(alias = "get_item")]
    pub fn item(&self) -> Option<glib::Object> {
        unsafe { from_glib_none(ffi::gtk_list_header_get_item(self.to_glib_none().0)) }
    }

    /// Gets the the number of items in the section.
    ///
    /// If @self is unbound, 0 is returned.
    ///
    /// # Returns
    ///
    /// The number of items in the section
    #[doc(alias = "gtk_list_header_get_n_items")]
    #[doc(alias = "get_n_items")]
    pub fn n_items(&self) -> u32 {
        unsafe { ffi::gtk_list_header_get_n_items(self.to_glib_none().0) }
    }

    /// Gets the start position in the model of the section that @self is
    /// currently the header for.
    ///
    /// If @self is unbound, `GTK_INVALID_LIST_POSITION` is returned.
    ///
    /// # Returns
    ///
    /// The start position of the section
    #[doc(alias = "gtk_list_header_get_start")]
    #[doc(alias = "get_start")]
    pub fn start(&self) -> u32 {
        unsafe { ffi::gtk_list_header_get_start(self.to_glib_none().0) }
    }

    /// Sets the child to be used for this listitem.
    ///
    /// This function is typically called by applications when
    /// setting up a header so that the widget can be reused when
    /// binding it multiple times.
    /// ## `child`
    /// The list item's child or [`None`] to unset
    #[doc(alias = "gtk_list_header_set_child")]
    pub fn set_child(&self, child: Option<&impl IsA<Widget>>) {
        unsafe {
            ffi::gtk_list_header_set_child(
                self.to_glib_none().0,
                child.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "child")]
    pub fn connect_child_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_child_trampoline<F: Fn(&ListHeader) + 'static>(
            this: *mut ffi::GtkListHeader,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::child\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_child_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "end")]
    pub fn connect_end_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_end_trampoline<F: Fn(&ListHeader) + 'static>(
            this: *mut ffi::GtkListHeader,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::end\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_end_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "item")]
    pub fn connect_item_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_item_trampoline<F: Fn(&ListHeader) + 'static>(
            this: *mut ffi::GtkListHeader,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::item\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_item_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "n-items")]
    pub fn connect_n_items_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_n_items_trampoline<F: Fn(&ListHeader) + 'static>(
            this: *mut ffi::GtkListHeader,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::n-items\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_n_items_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "start")]
    pub fn connect_start_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_start_trampoline<F: Fn(&ListHeader) + 'static>(
            this: *mut ffi::GtkListHeader,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::start\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_start_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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