Struct gtk4::SectionModel

pub struct SectionModel { /* private fields */ }

Available on crate feature v4_12 only.

SectionModel is an interface that adds support for sections to list models.

A SectionModel groups successive items into so-called sections. List widgets like ListView and GridView then allow displaying section headers for these sections by installing a header factory.

Many GTK list models support sections inherently, or they pass through the sections of a model they are wrapping.

When the section groupings of a model change, the model will emit the sections-changed signal by calling the SectionModelExt::sections_changed() function. All sections in the given range then need to be queried again. The items-changed signal has the same effect, all sections in that range are invalidated, too.

Signals

sections-changed

Emitted when the start-of-section state of some of the items in @model changes.

Note that this signal does not specify the new section state of the items, they need to be queried manually. It is also not necessary for a model to change the section state of any of the items in the section model, though it would be rather useless to emit such a signal.

The items-changed implies the effect of the sections-changed signal for all the items it covers.

ListModel

items-changed

This signal is emitted whenever items were added to or removed from @list. At @position, @removed items were removed and @added items were added in their place.

Note: If removed != added, the positions of all later items in the model change.

Implements

SectionModelExt, gio::prelude::ListModelExt

Implementations

impl SectionModel

pub const NONE: Option<&'static SectionModel> = None

Trait Implementations

impl Clone for SectionModel

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 SectionModel

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

Formats the value using the given formatter.

impl HasParamSpec for SectionModel

type ParamSpec = ParamSpecObject

type SetValue = SectionModel

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SectionModel

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<T: SectionModelImpl> IsImplementable<T> for SectionModel

fn interface_init(iface: &mut Interface<Self>)

Override the virtual methods of this interface for the given subclass and do other interface initialization.

fn instance_init(_instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for SectionModel

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

This method returns an Ordering between self and other.

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 + PartialOrd,

Restrict a value to a certain interval.

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

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 SectionModel

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 SectionModel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SectionModel

impl IsA<ListModel> for SectionModel

impl IsA<SectionModel> for FilterListModel

impl IsA<SectionModel> for FlattenListModel

impl IsA<SectionModel> for MapListModel

impl IsA<SectionModel> for MultiSelection

impl IsA<SectionModel> for NoSelection

impl IsA<SectionModel> for SingleSelection

impl IsA<SectionModel> for SliceListModel

impl IsA<SectionModel> for SortListModel