Struct MapListModel

pub struct MapListModel { /* private fields */ }

A MapListModel maps the items in a list model to different items.

MapListModel uses a `callback::Gtk::MapListModelMapFunc.

Example: Create a list of GtkEventControllers ⚠️ The following code is in c ⚠️

static gpointer
map_to_controllers (gpointer widget,
                    gpointer data)
{
  gpointer result = gtk_widget_observe_controllers (widget);
  g_object_unref (widget);
  return result;
}

widgets = gtk_widget_observe_children (widget);

controllers = gtk_map_list_model_new (widgets,
                                      map_to_controllers,
                                      NULL, NULL);

model = gtk_flatten_list_model_new (GTK_TYPE_EVENT_CONTROLLER,
                                    controllers);

MapListModel will attempt to discard the mapped objects as soon as they are no longer needed and recreate them if necessary.

MapListModel passes through sections from the underlying model.

Properties

has-map

If a map is set for this model

Readable

item-type

The type of items. See [ListModelExtManual::item_type()][crate::gio::prelude::ListModelExtManual::item_type()].

Readable

model

The model being mapped.

Readable | Writeable | Construct Only

n-items

The number of items. See [ListModelExtManual::n_items()][crate::gio::prelude::ListModelExtManual::n_items()].

Readable

Implements

[trait@glib::ObjectExt], gio::prelude::ListModelExt, SectionModelExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl MapListModel

pub fn new<P: Fn(&Object) -> Object + 'static>( model: Option<impl IsA<ListModel>>, map_func: P, ) -> MapListModel

Creates a new MapListModel for the given arguments.

model

The model to map

map_func

map function

Returns

a new MapListModel

pub fn model(&self) -> Option<ListModel>

Gets the model that is currently being mapped or None if none.

Returns

The model that gets mapped

pub fn has_map(&self) -> bool

Checks if a map function is currently set on @self.

Returns

true if a map function is set

pub fn set_map_func<P: Fn(&Object) -> Object + 'static>(&self, map_func: P)

Sets the function used to map items.

The function will be called whenever an item needs to be mapped and must return the item to use for the given input item.

Note that MapListModel may call this function multiple times on the same item, because it may delete items it doesn’t need anymore.

GTK makes no effort to ensure that @map_func conforms to the item type of @self. It assumes that the caller knows what they are doing and the map function returns items of the appropriate type.

map_func

map function

pub fn set_model(&self, model: Option<&impl IsA<ListModel>>)

Sets the model to be mapped.

GTK makes no effort to ensure that @model conforms to the item type expected by the map function. It assumes that the caller knows what they are doing and have set up an appropriate map function.

model

The model to be mapped

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

impl MapListModel

pub fn without_map_func(model: Option<&impl IsA<ListModel>>) -> Self

pub fn unset_map_func(&self)

Trait Implementations

impl Clone for MapListModel

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for MapListModel

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

Formats the value using the given formatter.

impl HasParamSpec for MapListModel

type ParamSpec = ParamSpecObject

type SetValue = MapListModel

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, MapListModel>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MapListModel

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

where H: Hasher,

Hashes the memory address of this object.

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 MapListModel

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for MapListModel

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for MapListModel

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MapListModel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MapListModel

impl IsA<ListModel> for MapListModel

impl IsA<SectionModel> for MapListModel