GI.Gtk.Structs.BitsetIter

An opaque, stack-allocated struct for iterating over the elements of a Bitset. Before a GtkBitsetIter can be used, it needs to be initialized with bitsetIterInitFirst, bitsetIterInitLast or bitsetIterInitAt.

Exported types

newtype BitsetIter

Memory-managed wrapper type.

Constructors

BitsetIter (ManagedPtr BitsetIter)

Instances

Eq BitsetIter

Defined in GI.Gtk.Structs.BitsetIter

Methods

(==) :: BitsetIter -> BitsetIter -> Bool

(/=) :: BitsetIter -> BitsetIter -> Bool

BoxedPtr BitsetIter

Defined in GI.Gtk.Structs.BitsetIter

Methods

boxedPtrCopy :: BitsetIter -> IO BitsetIter

boxedPtrFree :: BitsetIter -> IO ()

CallocPtr BitsetIter

Defined in GI.Gtk.Structs.BitsetIter

Methods

boxedPtrCalloc :: IO (Ptr BitsetIter)

ManagedPtrNewtype BitsetIter

Defined in GI.Gtk.Structs.BitsetIter

Methods

toManagedPtr :: BitsetIter -> ManagedPtr BitsetIter

tag ~ 'AttrSet => Constructible BitsetIter tag

Defined in GI.Gtk.Structs.BitsetIter

Methods

new :: MonadIO m => (ManagedPtr BitsetIter -> BitsetIter) -> [AttrOp BitsetIter tag] -> m BitsetIter

newZeroBitsetIter :: MonadIO m => m BitsetIter

Construct a BitsetIter struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

isValid, next, previous.

Getters

getValue.

Setters

None.

getValue

bitsetIterGetValue

Arguments

:: (HasCallStack, MonadIO m)

=> BitsetIter

iter: a BitsetIter

-> m Word32

Returns: The current value pointer to by iter

Gets the current value that iter points to.

If iter is not valid and bitsetIterIsValid returns False, this function returns 0.

initAt

bitsetIterInitAt

Arguments

:: (HasCallStack, MonadIO m)

=> Bitset

set: a Bitset

-> Word32

target: target value to start iterating at

-> m (Bool, BitsetIter, Word32)

Returns: True if a value was found.

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.

initFirst

bitsetIterInitFirst

Arguments

:: (HasCallStack, MonadIO m)

=> Bitset

set: a Bitset

-> m (Bool, BitsetIter, Word32)

Returns: True if set isn't empty.

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.

initLast

bitsetIterInitLast

Arguments

:: (HasCallStack, MonadIO m)

=> Bitset

set: a Bitset

-> m (Bool, BitsetIter, Word32)

Returns: True if set isn't empty.

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

isValid

bitsetIterIsValid

Arguments

:: (HasCallStack, MonadIO m)

=> BitsetIter

iter: a BitsetIter

-> m Bool

Returns: True if iter points to a valid value

Checks if iter points to a valid value.

next

bitsetIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> BitsetIter

iter: a pointer to a valid BitsetIter

-> m (Bool, Word32)

Returns: True if a next value existed

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.

previous

bitsetIterPrevious

Arguments

:: (HasCallStack, MonadIO m)

=> BitsetIter

iter: a pointer to a valid BitsetIter

-> m (Bool, Word32)

Returns: True if a previous value existed

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.