gtk4/org.gtkkn.bindings.gtk/Bitset

Bitset

class Bitset(pointer: <Error class: unknown class><<Error class: unknown class>>)

A GtkBitset represents a set of unsigned integers.

Another name for this data structure is "bitmap".

The current implementation is based on roaring bitmaps.

A bitset allows adding a set of integers and provides support for set operations like unions, intersections and checks for equality or if a value is contained in the set. GtkBitset also contains various functions to query metadata about the bitset, such as the minimum or maximum values or its size.

The fastest way to iterate values in a bitset is struct@Gtk.BitsetIter.

The main use case for GtkBitset is implementing complex selections for iface@Gtk.SelectionModel.

Constructors

Bitset

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gtkBitsetPointer

val gtkBitsetPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

add

fun add(value: <Error class: unknown class>): Boolean

Adds @value to @self if it wasn't part of it before.

addRange

fun addRange(start: <Error class: unknown class>, nItems: <Error class: unknown class>)

Adds all values from @start (inclusive) to @start + @n_items (exclusive) in @self.

addRangeClosed

fun addRangeClosed(first: <Error class: unknown class>, last: <Error class: unknown class>)

Adds the closed range @first, @last, so @first, @last and all values in between. @first must be smaller than @last.

addRectangle

fun addRectangle(start: <Error class: unknown class>, width: <Error class: unknown class>, height: <Error class: unknown class>, stride: <Error class: unknown class>)

Interprets the values as a 2-dimensional boolean grid with the given @stride and inside that grid, adds a rectangle with the given @width and @height.

contains

fun contains(value: <Error class: unknown class>): Boolean

Checks if the given @value has been added to @self

copy

fun copy(): Bitset

Creates a copy of @self.

difference

fun difference(other: Bitset)

Sets @self to be the symmetric difference of @self and @other.

equals

fun equals(other: Bitset): Boolean

Returns true if @self and @other contain the same values.

getMaximum

fun getMaximum(): <Error class: unknown class>

Returns the largest value in @self.

getMinimum

fun getMinimum(): <Error class: unknown class>

Returns the smallest value in @self.

getNth

fun getNth(nth: <Error class: unknown class>): <Error class: unknown class>

Returns the value of the @nth item in self.

getSize

fun getSize(): <Error class: unknown class>

Gets the number of values that were added to the set.

getSizeInRange

fun getSizeInRange(first: <Error class: unknown class>, last: <Error class: unknown class>): <Error class: unknown class>

Gets the number of values that are part of the set from @first to @last (inclusive).

intersect

fun intersect(other: Bitset)

Sets @self to be the intersection of @self and @other.

isEmpty

fun isEmpty(): Boolean

Check if no value is contained in bitset.

ref

fun ref(): Bitset

Acquires a reference on the given GtkBitset.

remove

fun remove(value: <Error class: unknown class>): Boolean

Removes @value from @self if it was part of it before.

removeAll

fun removeAll()

Removes all values from the bitset so that it is empty again.

removeRange

fun removeRange(start: <Error class: unknown class>, nItems: <Error class: unknown class>)

Removes all values from @start (inclusive) to @start + @n_items (exclusive) in @self.

removeRangeClosed

fun removeRangeClosed(first: <Error class: unknown class>, last: <Error class: unknown class>)

Removes the closed range @first, @last, so @first, @last and all values in between. @first must be smaller than @last.

removeRectangle

fun removeRectangle(start: <Error class: unknown class>, width: <Error class: unknown class>, height: <Error class: unknown class>, stride: <Error class: unknown class>)

Interprets the values as a 2-dimensional boolean grid with the given @stride and inside that grid, removes a rectangle with the given @width and @height.

shiftLeft

fun shiftLeft(amount: <Error class: unknown class>)

Shifts all values in @self to the left by @amount.

shiftRight

fun shiftRight(amount: <Error class: unknown class>)

Shifts all values in @self to the right by @amount.

splice