glib/org.gtkkn.bindings.glib/VariantBuilder

VariantBuilder

class VariantBuilder(pointer: <Error class: unknown class><<Error class: unknown class>>) : Record

A utility type for constructing container-type #GVariant instances.

This is an opaque structure and may only be accessed using the following functions.

#GVariantBuilder is not threadsafe in any way. Do not attempt to access it from more than one thread.

Constructors

VariantBuilder

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

Types

Companion

object Companion : RecordCompanion<VariantBuilder, <Error class: unknown class>>

Properties

glibVariantBuilderPointer

val glibVariantBuilderPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

addValue

fun addValue(value: Variant)

Adds @value to @builder.

fun close()

Closes the subcontainer inside the given @builder that was opened by the most recent call to g_variant_builder_open().

end

fun end(): Variant

Ends the builder process and returns the constructed value.

open

fun open(type: VariantType)

Opens a subcontainer inside the given @builder. When done adding items to the subcontainer, g_variant_builder_close() must be called. @type is the type of the container: so to build a tuple of several values, @type must include the tuple itself.

ref

fun ref(): VariantBuilder

Increases the reference count on @builder.

unref

fun unref()

Decreases the reference count on @builder.