Basics
Guides
API Reference
Basics
Guides
API Reference
[20:7] extends: object
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].
GtkBitset (Handle = null)
Creates a new empty bitset.
Handle is an optional native handle or wrapper whose handle to adopt; when the native constructor is called.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.add (int value)
Adds @value to @self if it wasn't part of it before.
value is value to add.%TRUE if @value was not part of @self and @self was changed.add_range (int start, int n_items)
Adds all values from @start (inclusive) to @start + @n_items (exclusive) in @self.
start is first value to add.n_items is number of consecutive values to add.None.add_range_closed (int first, int last)
Adds the closed range [@first, @last], so @first, @last and all values in between. @first must be smaller than @last.
first is first value to add.last is last value to add.None.add_rectangle (int start, int width, int height, int stride)
Interprets the values as a 2-dimensional boolean grid with the given
and inside that grid, adds a rectangle with the given @width andstart is first value to add.width is width of the rectangle.height is height of the rectangle.stride is row stride of the grid.None.contains (int value)
Checks if the given @value has been added to @self
value is the value to check.%TRUE if @self contains @value.copy ()
Creates a copy of @self.
A new bitset that contains the same values as @self.difference (object other)
Sets @self to be the symmetric difference of @self and @other. The symmetric difference is set @self to contain all values that were either contained in @self or in @other, but not in both. This operation is also called an XOR. It is allowed for @self and @other to be the same bitset. The bitset will be emptied in that case.
other is the GtkBitset to compute the difference from.None.equals (object other)
Returns %TRUE if @self and @other contain the same values.
other is another GtkBitset.%TRUE if @self and @other contain the same values.get_maximum ()
Returns the largest value in @self. If @self is empty, 0 is returned.
The largest value in @self.get_minimum ()
Returns the smallest value in @self. If @self is empty,
G_MAXUINTis returned.
The smallest value in @self.get_nth (int nth)
Returns the value of the @nth item in self. If @nth is >= the size of
0 is returned.nth is index of the item to get.the value of the @nth item in @self.get_size ()
Gets the number of values that were added to the set. For example, if the set is empty, 0 is returned. Note that this function returns a
guint64, because when all values are set, the return value isG_MAXUINT + 1. Unless you are sure this cannot happen (it can't withGListModel), be sure to use a 64bit type.
The number of values in the set..get_size_in_range (int first, int last)
Gets the number of values that are part of the set from @first to @last (inclusive). Note that this function returns a
guint64, because when all values are set, the return value isG_MAXUINT + 1. Unless you are sure this cannot happen (it can't withGListModel), be sure to use a 64bit type.
first is the first element to include.last is the last element to include.The number of values in the set from @first to @last..intersect (object other)
Sets @self to be the intersection of @self and @other. In other words, remove all values from @self that are not part of @other. It is allowed for @self and @other to be the same bitset. Nothing will happen in that case.
other is the GtkBitset to intersect with.None.is_empty ()
Check if no value is contained in bitset.
%TRUE if @self is empty.ref ()
Acquires a reference on the given
GtkBitset.
the GtkBitset with an additional reference.remove (int value)
Removes @value from @self if it was part of it before.
value is value to remove.%TRUE if @value was part of @self and @self was changed.remove_all ()
Removes all values from the bitset so that it is empty again.
None.remove_range (int start, int n_items)
Removes all values from @start (inclusive) to @start + @n_items (exclusive) in @self.
start is first value to remove.n_items is number of consecutive values to remove.None.remove_range_closed (int first, int last)
Removes the closed range [@first, @last], so @first, @last and all values in between. @first must be smaller than @last.
first is first value to remove.last is last value to remove.None.remove_rectangle (int start, int width, int height, int stride)
Interprets the values as a 2-dimensional boolean grid with the given
and inside that grid, removes a rectangle with the given @width and @height.start is first value to remove.width is width of the rectangle.height is height of the rectangle.stride is row stride of the grid.None.shift_left (int amount)
Shifts all values in @self to the left by @amount. Values smaller than
are discarded.amount is amount to shift all values to the left.None.shift_right (int amount)
Shifts all values in @self to the right by @amount. Values that end up too large to be held in a #guint are discarded.
amount is amount to shift all values to the right.None.splice (int position, int removed, int added)
This is a support function for
GListModelhandling, by mirroring theGlistModel::items-changedsignal. First, it "cuts" the values from
to @removed from the bitset. That is, it removes all those values and shifts all larger values to the left by @removed places. Then, it "pastes" new room into the bitset by shifting all values larger thanby @added spaces to the right. This frees up space that can then be filled.position is position at which to slice.removed is number of values to remove.added is number of values to add.None.subtract (object other)
Sets @self to be the subtraction of @other from @self. In other words, remove all values from @self that are part of @other. It is allowed for
and @other to be the same bitset. The bitset will be emptied in that case.other is the GtkBitset to subtract.None.union (object other)
Sets @self to be the union of @self and @other. That is, add all values from @other into @self that weren't part of it. It is allowed for @self and @other to be the same bitset. Nothing will happen in that case.
other is the GtkBitset to union with.None.unref ()
Releases a reference on the given
GtkBitset. If the reference was the last, the resources associated to the @self are freed.
None.[430:14] static extends: object
Alternate constructors for GtkBitset. Usage:
GtkBitsetCtors.<name>(...). The primary constructor lives
directly on GtkBitset.
newRange (int start, int n_items)
Creates a bitset with the given range set.
start is first value to add.n_items is number of consecutive values to add.A new GtkBitset.
Aussom
Write once. Embed everywhere.
Copyright 2026 Austin Lehman. All rights reserved.