package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/Sorter/index.html

Module Wrappers.Sorter

type t = [ `sorter | `object_ ] Gobject.obj
val get_order : t -> Gtk_enums.sorterorder

Gets the order that @self conforms to.

See enum@Gtk.SorterOrder for details of the possible return values.

This function is intended to allow optimizations.

val compare : t -> [ `object_ ] Gobject.obj -> [ `object_ ] Gobject.obj -> Gtk_enums.ordering

Compares two given items according to the sort order implemented by the sorter.

Sorters implement a partial order:

* It is reflexive, ie a = a * It is antisymmetric, ie if a < b and b < a, then a = b * It is transitive, ie given any 3 items with a ≤ b and b ≤ c, then a ≤ c

The sorter may signal it conforms to additional constraints via the return value of method@Gtk.Sorter.get_order.

val changed : t -> Gtk_enums.sorterchange -> unit

Notifies all users of the sorter that it has changed.

This emits the signal@Gtk.Sorter::changed signal. Users of the sorter should then update the sort order via method@Gtk.Sorter.compare.

Depending on the @change parameter, it may be possible to update the sort order without a full resorting. Refer to the enum@Gtk.SorterChange documentation for details.

This function is intended for implementers of `GtkSorter` subclasses and should not be called from other functions.

val on_changed : ?after:bool -> t -> callback:(change:Gtk_enums.sorterchange -> unit) -> Gobject.Signal.handler_id