Gtk.Bitset_Iter

Description

Iterates over the elements of a [structGtk.Bitset].

`GtkBitSetIter is an opaque, stack-allocated struct.

Before a GtkBitsetIter can be used, it needs to be initialized with [funcGtk.BitsetIter.init_first], [funcGtk.BitsetIter.init_last] or [funcGtk.BitsetIter.init_at].

From_Object_Free

function From_Object_Free
  (B : not null access Gtk_Bitset_Iter) return Gtk_Bitset_Iter

Return the underlying object and free the pointer. This is meant to be used internally by GtkAda, and should not in general be called by user code.

Parameters

B

Return Value

Get_Type

function Get_Type return Glib.GType

Return Value

Get_Value

function Get_Value (Self : access Gtk_Bitset_Iter) return Guint

Gets the current value that Iter points to. If Iter is not valid and [methodGtk.BitsetIter.is_valid] returns False, this function returns 0.

Parameters

Self

Return Value

The current value pointer to by Iter

Gtk_Bitset_Iter

type Gtk_Bitset_Iter is private;

Iterates over the elements of a [structGtk.Bitset].

`GtkBitSetIter is an opaque, stack-allocated struct.

Before a GtkBitsetIter can be used, it needs to be initialized with [funcGtk.BitsetIter.init_first], [funcGtk.BitsetIter.init_last] or [funcGtk.BitsetIter.init_at].

Init_At

function Init_At
   (Iter   : out Gtk_Bitset_Iter;
    Set    : Gtk.Bitset.Gtk_Bitset;
    Target : Guint;
    Value  : access Guint := null) return Boolean

Initializes Iter to point to Target. If Target is not found, finds the next value after it. If no value >= Target exists in Set, this function returns False.

Parameters

Iter

a pointer to an uninitialized GtkBitsetIter

Set

a GtkBitset

Target

target value to start iterating at

Value

Set to the found value in Set

Return Value

True if a value was found.

Init_First

function Init_First
   (Iter  : out Gtk_Bitset_Iter;
    Set   : Gtk.Bitset.Gtk_Bitset;
    Value : access Guint := null) return Boolean

Initializes an iterator for Set and points it to the first value in Set. If Set is empty, False is returned and Value is set to G_MAXUINT.

Parameters

Iter

a pointer to an uninitialized GtkBitsetIter

Set

a GtkBitset

Value

Set to the first value in Set

Return Value

True if Set isn't empty.

Init_Last

function Init_Last
   (Iter  : out Gtk_Bitset_Iter;
    Set   : Gtk.Bitset.Gtk_Bitset;
    Value : access Guint := null) return Boolean

Initializes an iterator for Set and points it to the last value in Set. If Set is empty, False is returned.

Parameters

Iter

a pointer to an uninitialized GtkBitsetIter

Set

a GtkBitset

Value

Set to the last value in Set

Return Value

True if Set isn't empty.

Is_Valid

function Is_Valid (Self : access Gtk_Bitset_Iter) return Boolean

Checks if Iter points to a valid value.

Parameters

Self

Return Value

True if Iter points to a valid value

Next

function Next
   (Self  : access Gtk_Bitset_Iter;
    Value : access Guint := null) return Boolean

Moves Iter to the next value in the set. If it was already pointing to the last value in the set, False is returned and Iter is invalidated.

Parameters

Self

Value

Set to the next value

Return Value

True if a next value existed

Previous

function Previous
   (Self  : access Gtk_Bitset_Iter;
    Value : access Guint := null) return Boolean

Moves Iter to the previous value in the set. If it was already pointing to the first value in the set, False is returned and Iter is invalidated.

Parameters

Self

Value

Set to the previous value

Return Value

True if a previous value existed