glib/org.gtkkn.bindings.glib/SequenceIter

SequenceIter

class SequenceIter(val glibSequenceIterPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

The #GSequenceIter struct is an opaque data type representing an iterator pointing into a #GSequence.

Constructors

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

Properties

glibSequenceIterPointer

val glibSequenceIterPointer: <Error class: unknown class><<Error class: unknown class>>

open override val handle: <Error class: unknown class>

Functions

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

fun compare(b: SequenceIter): <Error class: unknown class>

Returns a negative number if @a comes before @b, 0 if they are equal, and a positive number if @a comes after @b.

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

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

Returns the position of @iter

fun getSequence(): Sequence

Returns the #GSequence that @iter points into.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

open override fun hashCode(): Int

fun isBegin(): Boolean

Returns whether @iter is the begin iterator

fun isEnd(): Boolean

Returns whether @iter is the end iterator

fun move(delta: <Error class: unknown class>): SequenceIter

Returns the #GSequenceIter which is @delta positions away from @iter. If @iter is closer than -@delta positions to the beginning of the sequence, the begin iterator is returned. If @iter is closer than @delta positions to the end of the sequence, the end iterator is returned.

fun next(): SequenceIter

Returns an iterator pointing to the next position after @iter. If @iter is the end iterator, the end iterator is returned.

fun prev(): SequenceIter

Returns an iterator pointing to the previous position before @iter. If @iter is the begin iterator, the begin iterator is returned.

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.