// 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::ListItemFactory;
use glib::object::Cast;
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
use glib::object::ObjectType as ObjectType_;
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
use glib::signal::connect_raw;
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
use glib::signal::SignalHandlerId;
use glib::translate::*;
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
use std::boxed::Box as Box_;
use std::fmt;
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
use std::mem::transmute;

glib::wrapper! {
    /// [`SignalListItemFactory`][crate::SignalListItemFactory] is a [`ListItemFactory`][crate::ListItemFactory] that emits signals
    /// to to manage listitems.
    ///
    /// Signals are emitted for every listitem in the same order:
    ///
    ///  1. `signal::SignalListItemFactory::setup` is emitted to set up permanent
    ///  things on the listitem. This usually means constructing the widgets used in
    ///  the row and adding them to the listitem.
    ///
    ///  2. `signal::SignalListItemFactory::bind` is emitted to bind the item passed
    ///  via `property::ListItem::item` to the widgets that have been created in
    ///  step 1 or to add item-specific widgets. Signals are connected to listen to
    ///  changes - both to changes in the item to update the widgets or to changes
    ///  in the widgets to update the item. After this signal has been called, the
    ///  listitem may be shown in a list widget.
    ///
    ///  3. `signal::SignalListItemFactory::unbind` is emitted to undo everything
    ///  done in step 2. Usually this means disconnecting signal handlers. Once this
    ///  signal has been called, the listitem will no longer be used in a list
    ///  widget.
    ///
    ///  4. `signal::SignalListItemFactory::bind` and
    ///  `signal::SignalListItemFactory::unbind` may be emitted multiple times
    ///  again to bind the listitem for use with new items. By reusing listitems,
    ///  potentially costly setup can be avoided. However, it means code needs to
    ///  make sure to properly clean up the listitem in step 3 so that no information
    ///  from the previous use leaks into the next use.
    ///
    /// 5. `signal::SignalListItemFactory::teardown` is emitted to allow undoing
    /// the effects of `signal::SignalListItemFactory::setup`. After this signal
    /// was emitted on a listitem, the listitem will be destroyed and not be used again.
    ///
    /// Note that during the signal emissions, changing properties on the
    /// [`ListItem`][crate::ListItem]s passed will not trigger notify signals as the listitem's
    /// notifications are frozen. See g_object_freeze_notify() for details.
    ///
    /// For tracking changes in other properties in the [`ListItem`][crate::ListItem], the
    /// ::notify signal is recommended. The signal can be connected in the
    /// `signal::SignalListItemFactory::setup` signal and removed again during
    /// `signal::SignalListItemFactory::teardown`.
    ///
    /// # Implements
    ///
    /// [`ListItemFactoryExt`][trait@crate::prelude::ListItemFactoryExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSignalListItemFactory")]
    pub struct SignalListItemFactory(Object<ffi::GtkSignalListItemFactory, ffi::GtkSignalListItemFactoryClass>) @extends ListItemFactory;

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

impl SignalListItemFactory {
    /// Creates a new [`SignalListItemFactory`][crate::SignalListItemFactory].
    ///
    /// You need to connect signal handlers before you use it.
    ///
    /// # Returns
    ///
    /// a new [`SignalListItemFactory`][crate::SignalListItemFactory]
    #[doc(alias = "gtk_signal_list_item_factory_new")]
    pub fn new() -> SignalListItemFactory {
        assert_initialized_main_thread!();
        unsafe {
            ListItemFactory::from_glib_full(ffi::gtk_signal_list_item_factory_new()).unsafe_cast()
        }
    }

    /// Emitted when an object has been bound, for example when a
    /// new `property::ListItem::item` has been set on a
    /// [`ListItem`][crate::ListItem] and should be bound for use.
    ///
    /// After this signal was emitted, the object might be shown in
    /// a [`ListView`][crate::ListView] or other widget.
    ///
    /// The `signal::SignalListItemFactory::unbind` signal is the
    /// opposite of this signal and can be used to undo everything done
    /// in this signal.
    /// ## `object`
    /// The `GObject` to bind
    #[cfg(any(feature = "v4_8", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
    #[doc(alias = "bind")]
    pub fn connect_bind<F: Fn(&Self, &glib::Object) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn bind_trampoline<
            F: Fn(&SignalListItemFactory, &glib::Object) + 'static,
        >(
            this: *mut ffi::GtkSignalListItemFactory,
            object: *mut glib::gobject_ffi::GObject,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(object))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"bind\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    bind_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a new listitem has been created and needs to be setup for use.
    ///
    /// It is the first signal emitted for every listitem.
    ///
    /// The `signal::SignalListItemFactory::teardown` signal is the opposite
    /// of this signal and can be used to undo everything done in this signal.
    /// ## `object`
    /// The `GObject` to set up
    #[cfg(any(feature = "v4_8", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
    #[doc(alias = "setup")]
    pub fn connect_setup<F: Fn(&Self, &glib::Object) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn setup_trampoline<
            F: Fn(&SignalListItemFactory, &glib::Object) + 'static,
        >(
            this: *mut ffi::GtkSignalListItemFactory,
            object: *mut glib::gobject_ffi::GObject,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(object))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"setup\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    setup_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when an object is about to be destroyed.
    ///
    /// It is the last signal ever emitted for this @object.
    ///
    /// This signal is the opposite of the `signal::SignalListItemFactory::setup`
    /// signal and should be used to undo everything done in that signal.
    /// ## `object`
    /// The `GObject` to tear down
    #[cfg(any(feature = "v4_8", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
    #[doc(alias = "teardown")]
    pub fn connect_teardown<F: Fn(&Self, &glib::Object) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn teardown_trampoline<
            F: Fn(&SignalListItemFactory, &glib::Object) + 'static,
        >(
            this: *mut ffi::GtkSignalListItemFactory,
            object: *mut glib::gobject_ffi::GObject,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(object))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"teardown\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    teardown_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when a object has been unbound from its item, for example when
    /// a listitem was removed from use in a list widget
    /// and its new `property::ListItem::item` is about to be unset.
    ///
    /// This signal is the opposite of the `signal::SignalListItemFactory::bind`
    /// signal and should be used to undo everything done in that signal.
    /// ## `object`
    /// The `GObject` to unbind
    #[cfg(any(feature = "v4_8", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
    #[doc(alias = "unbind")]
    pub fn connect_unbind<F: Fn(&Self, &glib::Object) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn unbind_trampoline<
            F: Fn(&SignalListItemFactory, &glib::Object) + 'static,
        >(
            this: *mut ffi::GtkSignalListItemFactory,
            object: *mut glib::gobject_ffi::GObject,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(object))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"unbind\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    unbind_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for SignalListItemFactory {
    fn default() -> Self {
        Self::new()
    }
}

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