Package org.gnome.gtk

Interface TreeIterCompareFunc

All Superinterfaces:

FunctionPointer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Generated("io.github.jwharm.JavaGI")
public interface TreeIterCompareFunc
extends FunctionPointer

Functional interface declaration of the TreeIterCompareFunc callback.

See Also:

• run(org.gnome.gtk.TreeModel, org.gnome.gtk.TreeIter, org.gnome.gtk.TreeIter)

Method Summary

Modifier and Type	Method	Description
int	run(TreeModel model, TreeIter a, TreeIter b)	A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive integer if a sorts before b, a sorts with b, or a sorts after b respectively.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.
default int	upcall(MemorySegment model, MemorySegment a, MemorySegment b, MemorySegment userData)	The upcall method is called from native code.

Method Details

run

int run(TreeModel model,
 TreeIter a,
 TreeIter b)

A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive integer if a sorts before b, a sorts with b, or a sorts after b respectively.

If two iters compare as equal, their order in the sorted model is undefined. In order to ensure that the GtkTreeSortable behaves as expected, the GtkTreeIterCompareFunc must define a partial order on the model, i.e. it must be reflexive, antisymmetric and transitive.

For example, if model is a product catalogue, then a compare function for the “price” column could be one which returns price_of(@a) - price_of(@b).

upcall

default int upcall(MemorySegment model,
 MemorySegment a,
 MemorySegment b,
 MemorySegment userData)

The upcall method is called from native code. The parameters are marshaled and run(org.gnome.gtk.TreeModel, org.gnome.gtk.TreeIter, org.gnome.gtk.TreeIter) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the function pointer will be allocated in this arena

Returns:

the native function pointer