glib/org.gtkkn.bindings.glib/VariantBuilder

VariantBuilder

class VariantBuilder(val glibVariantBuilderPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

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.

Skipped during bindings generation

method add: Varargs parameter is not supported
method add_parsed: Varargs parameter is not supported
field x: Array parameter of type guintptr is not supported
field y: Array parameter of type guintptr is not supported

Constructors

constructor(type: VariantType)

Allocates and initialises a new #GVariantBuilder.

constructor()

Allocate a new VariantBuilder.

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

Allocate a new VariantBuilder using the provided AutofreeScope.

constructor(partialMagic: <Error class: unknown class>, type: VariantType?)

Allocate a new VariantBuilder.

constructor(partialMagic: <Error class: unknown class>, type: VariantType?, scope: <Error class: unknown class>)

Allocate a new VariantBuilder using the provided AutofreeScope.

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

Types

object Companion

Properties

glibVariantBuilderPointer

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

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

var partialMagic: <Error class: unknown class>

var type: VariantType?

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 addValue(value: Variant)

Adds @value to @builder.

fun clear()

Releases all memory associated with a #GVariantBuilder without freeing the #GVariantBuilder structure itself.

fun close()

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

fun end(): Variant

Ends the builder process and returns the constructed value.

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.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

open override fun hashCode(): Int

fun init(type: VariantType)

Initialises a #GVariantBuilder structure.

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.

fun ref(): VariantBuilder

Increases the reference count on @builder.

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

Removes a previously registered cleaner from this proxy object.

open override fun toString(): String

fun unref()

Decreases the reference count on @builder.