Struct gtk4::SignalListItemFactory

#[repr(transparent)]
pub struct SignalListItemFactory { /* private fields */ }

SignalListItemFactory is a 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 ListItems 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, 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], glib::ObjectExt

Implementations

impl SignalListItemFactory

pub fn new() -> SignalListItemFactory

Creates a new SignalListItemFactory.

You need to connect signal handlers before you use it.

Returns

a new SignalListItemFactory

pub fn connect_bind<F: Fn(&Self, &Object) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Available on crate feature v4_8 only.

Emitted when an object has been bound, for example when a new property::ListItem::item has been set on a ListItem and should be bound for use.

After this signal was emitted, the object might be shown in a 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

pub fn connect_setup<F: Fn(&Self, &Object) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Available on crate feature v4_8 only.

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

pub fn connect_teardown<F: Fn(&Self, &Object) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Available on crate feature v4_8 only.

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

pub fn connect_unbind<F: Fn(&Self, &Object) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Available on crate feature v4_8 only.

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

Trait Implementations

impl Clone for SignalListItemFactory

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignalListItemFactory

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

Formats the value using the given formatter.

impl Default for SignalListItemFactory

fn default() -> Self

Returns the “default value” for a type.

impl Display for SignalListItemFactory

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

Formats the value using the given formatter.

impl Hash for SignalListItemFactory

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

Feeds this value into the given Hasher.

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 SignalListItemFactory

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for SignalListItemFactory

type Parent = ListItemFactory

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

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

This method tests for self and other values to be equal, and is used by ==.

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 SignalListItemFactory

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

This method returns an ordering between self and other values if one exists.

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 SignalListItemFactory

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SignalListItemFactory

impl IsA<ListItemFactory> for SignalListItemFactory