class Gtk::ListHeader

Overview

Used by list widgets to represent the headers they display.

Gtk::ListHeader objects are managed just like Gtk::ListItem objects via their factory, but provide a different set of properties suitable for managing the header instead of individual items.

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/list_header.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new #

Initialize a new ListHeader.


def self.new(*, child : Gtk::Widget | Nil = nil, end _end : UInt32 | Nil = nil, item : GObject::Object | Nil = nil, n_items : UInt32 | Nil = nil, start : UInt32 | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def child : Gtk::Widget | Nil #

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


def child=(child : Gtk::Widget | Nil) : Nil #

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.


def end : UInt32 #

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.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def item : GObject::Object | Nil #

Gets the model item at the start of the section. This is the item that occupies the list model at position Gtk::ListHeader#start.

If self is unbound, this function returns nil.


def n_items : UInt32 #

Gets the the number of items in the section.

If self is unbound, 0 is returned.


def start : UInt32 #

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.