Struct gtk4::ListHeader

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

Available on crate feature v4_12 only.

ListHeader is used by list widgets to represent the headers they display.

ListHeader objects are managed just like 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

glib::ObjectExt

Implementations

impl ListHeader

pub fn child(&self) -> Option<Widget>

Gets the child previously set via gtk_list_header_set_child() or None if none was set.

Returns

The child

pub fn end(&self) -> u32

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

pub fn item(&self) -> Option<Object>

Gets the model item at the start of the section. This is the item that occupies the list model at position start.

If @self is unbound, this function returns None.

Returns

The item displayed

pub fn n_items(&self) -> u32

Gets the the number of items in the section.

If @self is unbound, 0 is returned.

Returns

The number of items in the section

pub fn start(&self) -> u32

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

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

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

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

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

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

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

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

Trait Implementations

impl Clone for ListHeader

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 ListHeader

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

Formats the value using the given formatter.

impl Display for ListHeader

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

Formats the value using the given formatter.

impl HasParamSpec for ListHeader

type ParamSpec = ParamSpecObject

type SetValue = ListHeader

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ListHeader

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 ListHeader

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 ListHeader

type Parent = Object

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

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 ListHeader

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 ListHeader

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ListHeader