Package org.gnome.gtk

Class ListHeader

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ListHeader

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class ListHeader
extends GObject

Used by list widgets to represent the headers they display.

GtkListHeader 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.

Since:

4.12

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListHeader.Builder<B extends ListHeader.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ListHeader.ListHeaderClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
ListHeader()	Creates a new ListHeader.
ListHeader(MemorySegment address)	Create a ListHeader proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ListHeader	asParent()	Returns this instance as if it were its parent type.
static ListHeader.Builder<? extends ListHeader.Builder>	builder()	A ListHeader.Builder object constructs a ListHeader with the specified properties.
@Nullable Widget	getChild()	Gets the child previously set via gtk_list_header_set_child() or null if none was set.
int	getEnd()	Gets the end position in the model of the section that this ListHeader is currently the header for.
@Nullable GObject	getItem()	Gets the model item at the start of the section.
int	getNItems()	Gets the the number of items in the section.
int	getStart()	Gets the start position in the model of the section that this ListHeader is currently the header for.
static @Nullable Type	getType()	Get the GType of the ListHeader class
void	setChild(@Nullable Widget child)	Sets the child to be used for this listitem.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListHeader

public ListHeader(MemorySegment address)

Create a ListHeader proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ListHeader

public ListHeader()

Creates a new ListHeader.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ListHeader class

Returns:

the GType

asParent

protected ListHeader asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getChild

public @Nullable Widget getChild()

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

Returns:

The child

Since:

4.12

getEnd

public int getEnd()

Gets the end position in the model of the section that this ListHeader is currently the header for.

If this ListHeader is unbound, GTK_INVALID_LIST_POSITION is returned.

Returns:

The end position of the section

Since:

4.12

getItem

public @Nullable GObject getItem()

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 this ListHeader is unbound, this function returns null.

Returns:

The item displayed

Since:

4.12

getNItems

public int getNItems()

Gets the the number of items in the section.

If this ListHeader is unbound, 0 is returned.

Returns:

The number of items in the section

Since:

4.12

getStart

public int getStart()

Gets the start position in the model of the section that this ListHeader is currently the header for.

If this ListHeader is unbound, GTK_INVALID_LIST_POSITION is returned.

Returns:

The start position of the section

Since:

4.12

setChild

public void setChild(@Nullable Widget child)

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.

Parameters:

child - The list item's child or null to unset

Since:

4.12

builder

public static ListHeader.Builder<? extends ListHeader.Builder> builder()

A ListHeader.Builder object constructs a ListHeader with the specified properties. Use the various set...() methods to set properties, and finish construction with ListHeader.Builder.build().

Returns:

the builder object