gobject/org.gtkkn.bindings.gobject/Value

Value

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

An opaque structure used to hold different types of values.

The data within the structure has protected scope: it is accessible only to functions within a #GTypeValueTable structure, or implementations of the g_value_*() API. That is, code portions which implement new fundamental types.

#GValue users cannot make any assumptions about how data is stored within the 2 element @data union, and the @g_type member should only be accessed through the G_VALUE_TYPE() macro.

Skipped during bindings generation

method get_boxed: Return type gpointer is unsupported
method get_pointer: Return type gpointer is unsupported
method get_schar: Return type gint8 is unsupported
method get_uchar: Return type guint8 is unsupported
method peek_pointer: Return type gpointer is unsupported
parameter v_boxed: gpointer
parameter v_boxed: gpointer
parameter instance: gpointer
parameter v_pointer: gpointer
parameter v_char: gint8
parameter v_boxed: gpointer
method set_string_take_ownership: C function g_value_set_string_take_ownership is ignored
parameter v_uchar: guint8
parameter v_boxed: gpointer
method take_string: C function g_value_take_string is ignored
field g_type: Record field g_type is private
field data: Fields with arrays are not supported

Constructors

Value

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

Types

Companion

object Companion

Properties

gobjectValuePointer

val gobjectValuePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

copy

fun copy(destValue: Value)

Copies the value of @src_value into @dest_value.

dupObject

fun dupObject(): Object?

Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing its reference count. If the contents of the #GValue are null, then null will be returned.

dupString

fun dupString(): String?

Get a copy the contents of a %G_TYPE_STRING #GValue.

dupVariant

fun dupVariant(): <Error class: unknown class>?

Get the contents of a variant #GValue, increasing its refcount. The returned #GVariant is never floating.

fitsPointer

fun fitsPointer(): Boolean

Determines if @value will fit inside the size of a pointer value. This is an internal function introduced mainly for C marshallers.

getBoolean

fun getBoolean(): Boolean

Get the contents of a %G_TYPE_BOOLEAN #GValue.

getChar

fun getChar(): Char

Do not use this function; it is broken on platforms where the %char type is unsigned, such as ARM and PowerPC. See g_value_get_schar().

getDouble

fun getDouble(): Double

Get the contents of a %G_TYPE_DOUBLE #GValue.

getEnum

fun getEnum(): Int

Get the contents of a %G_TYPE_ENUM #GValue.

getFlags

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

Get the contents of a %G_TYPE_FLAGS #GValue.

getFloat

fun getFloat(): Float

Get the contents of a %G_TYPE_FLOAT #GValue.

getGtype

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

Get the contents of a %G_TYPE_GTYPE #GValue.

getInt

fun getInt(): Int

Get the contents of a %G_TYPE_INT #GValue.

getInt64

fun getInt64(): Long

Get the contents of a %G_TYPE_INT64 #GValue.

getLong

fun getLong(): Long

Get the contents of a %G_TYPE_LONG #GValue.

getObject

fun getObject(): Object?

Get the contents of a %G_TYPE_OBJECT derived #GValue.

getParam

fun getParam(): ParamSpec

Get the contents of a %G_TYPE_PARAM #GValue.

getString

fun getString(): String?

Get the contents of a %G_TYPE_STRING #GValue.

getUint

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

Get the contents of a %G_TYPE_UINT #GValue.

getUint64

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

Get the contents of a %G_TYPE_UINT64 #GValue.

getUlong

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

Get the contents of a %G_TYPE_ULONG #GValue.

getVariant

fun getVariant(): <Error class: unknown class>?

Get the contents of a variant #GValue.

init

fun init(gType: <Error class: unknown class>): Value

Initializes @value with the default value of @type.

initFromInstance

fun initFromInstance(instance: TypeInstance)

Initializes and sets @value from an instantiatable type via the value_table's collect_value() function.

reset

fun reset(): Value

Clears the current value in @value and resets it to the default value (as if the value had just been initialized).

setBoolean

fun setBoolean(vBoolean: Boolean)

Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean.

setChar

fun setChar(vChar: Char)

Set the contents of a %G_TYPE_CHAR #GValue to @v_char.

setDouble

fun setDouble(vDouble: Double)

Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double.

setEnum

fun setEnum(vEnum: Int)

Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.

setFlags

fun setFlags(vFlags: <Error class: unknown class>)

Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.

setFloat

fun setFloat(vFloat: Float)

Set the contents of a %G_TYPE_FLOAT #GValue to @v_float.

setGtype

fun setGtype(vGtype: <Error class: unknown class>)

Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.

setInt

fun setInt(vInt: Int)

Set the contents of a %G_TYPE_INT #GValue to @v_int.

setInt64

fun setInt64(vInt64: Long)

Set the contents of a %G_TYPE_INT64 #GValue to @v_int64.

setInternedString

fun setInternedString(vString: String? = null)

Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static and interned (canonical, for example from g_intern_string()), and is thus not duplicated when setting the #GValue.

setLong

fun setLong(vLong: Long)

Set the contents of a %G_TYPE_LONG #GValue to @v_long.

setObject

fun setObject(vObject: Object? = null)

Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.

setParam

fun setParam(param: ParamSpec? = null)

Set the contents of a %G_TYPE_PARAM #GValue to @param.

setStaticString

fun setStaticString(vString: String? = null)

Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static, and is thus not duplicated when setting the #GValue.

setString

fun setString(vString: String? = null)

Set the contents of a %G_TYPE_STRING #GValue to a copy of @v_string.

setUint

fun setUint(vUint: <Error class: unknown class>)

Set the contents of a %G_TYPE_UINT #GValue to @v_uint.

setUint64

fun setUint64(vUint64: <Error class: unknown class>)

Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64.

setUlong

fun setUlong(vUlong: <Error class: unknown class>)

Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong.

setVariant

fun setVariant(variant: <Error class: unknown class>? = null)

Set the contents of a variant #GValue to @variant. If the variant is floating, it is consumed.

takeVariant

fun takeVariant(variant: <Error class: unknown class>? = null)

Set the contents of a variant #GValue to @variant, and takes over the ownership of the caller's reference to @variant; the caller doesn't have to unref it any more (i.e. the reference count of the variant is not increased).

transform

fun transform(destValue: Value): Boolean

Tries to cast the contents of @src_value into a type appropriate to store in @dest_value, e.g. to transform a %G_TYPE_INT value into a %G_TYPE_FLOAT value. Performing transformations between value types might incur precision lossage. Especially transformations into strings might reveal seemingly arbitrary results and shouldn't be relied upon for production code (such as rcfile value or object property serialization).

unset

fun unset()

Clears the current value in @value (if any) and "unsets" the type, this releases all resources associated with this GValue. An unset value is the same as an uninitialized (zero-filled) #GValue structure.