glib/org.gtkkn.bindings.glib/VariantIter

VariantIter

class VariantIter(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null) : ProxyInstance

#GVariantIter is an opaque data structure and can only be accessed using the following functions.

Skipped during bindings generation

  • method loop: Varargs parameter is not supported

  • method next: Varargs parameter is not supported

Constructors

Link copied to clipboard
constructor()

Allocate a new VariantIter.

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

Allocate a new VariantIter using the provided AutofreeScope.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

Properties

Link copied to clipboard
val glibVariantIterPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val handle: <Error class: unknown class>?

Functions

Link copied to clipboard
fun copy(): VariantIter

Creates a new heap-allocated #GVariantIter to iterate over the container that was being iterated over by @iter. Iteration begins on the new iterator from the current position of the old iterator but the two copies are independent past that point.

Link copied to clipboard
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.

Link copied to clipboard
fun free()

Frees a heap-allocated #GVariantIter. Only call this function on iterators that were returned by g_variant_iter_new() or g_variant_iter_copy().

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun init(value: Variant): <Error class: unknown class>

Initialises (without allocating) a #GVariantIter. @iter may be completely uninitialised prior to this call; its old value is ignored.

Link copied to clipboard
fun nChildren(): <Error class: unknown class>

Queries the number of child items in the container that we are iterating over. This is the total number of items -- not the number of items remaining.

Link copied to clipboard
fun nextValue(): Variant?

Gets the next item in the container. If no more items remain then null is returned.