Value

Value

Object Hierarchy:

Description:

public struct Value

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. Value 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 type macro.

Namespace: GLib

Package: gobject-2.0

Content:

Static methods:

public static bool type_compatible (Type src_type, Type dest_type)
Returns whether a Value of type src_type can be copied into a Value of type dest_type.
public static bool type_transformable (Type src_type, Type dest_type)
Check whether transform is able to transform values of type src_type into values of type dest_type.
public static void register_transform_func (Type src_type, Type dest_type, ValueTransform transform)
Registers a value transformation function for use in transform. A previously registered transformation function for src_type and dest_type will be replaced.

Creation methods:

public Value (Type g_type)
Initializes value with the default value of type.

Methods:

public bool holds (Type type)
public Type type ()
public unowned string type_name ()
public void copy (ref Value dest_value)
Copies the value of src_value into dest_value.
public unowned Value? reset ()
Clears the current value in value and resets it to the default value (as if the value had just been initialized).
public void init (Type g_type)
public void unset ()
Clears the current value in value and "unsets" the type, this releases all resources associated with this GValue. An unset value is the same as an uninitialized (zero-filled) Value structure.
public void set_instance (void* instance)
Sets value from an instantiatable type via the value_table's collect_value function.
public bool fits_pointer ()
Determines if value will fit inside the size of a pointer value. This is an internal function introduced mainly for C marshallers.
public void* peek_pointer ()
function asserts that fits_pointer returned true for the passed in value. This is an internal function introduced mainly for C marshallers.
public bool transform (ref Value dest_value)
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).
public string strdup_contents ()
Return a newly allocated string, which describes the contents of a Value. The main purpose of this function is to describe Value contents for debugging output, the way in which the contents are described may change between different GLib versions.
public void set_boolean (bool v_boolean)
Set the contents of a G_TYPE_BOOLEAN Value to v_boolean.
public bool get_boolean ()
Get the contents of a G_TYPE_BOOLEAN Value.
public void set_char (char v_char)
Set the contents of a G_TYPE_CHAR Value to v_char.
public char get_char ()
Get the contents of a G_TYPE_CHAR Value.
public void set_uchar (uchar v_uchar)
Set the contents of a G_TYPE_UCHAR Value to v_uchar.
public uchar get_uchar ()
Get the contents of a G_TYPE_UCHAR Value.
public void set_int (int v_int)
Set the contents of a G_TYPE_INT Value to v_int.
public int get_int ()
Get the contents of a G_TYPE_INT Value.
public void set_uint (uint v_uint)
Set the contents of a G_TYPE_UINT Value to v_uint.
public uint get_uint ()
Get the contents of a G_TYPE_UINT Value.
public void set_long (long v_long)
Set the contents of a G_TYPE_LONG Value to v_long.
public long get_long ()
Get the contents of a G_TYPE_LONG Value.
public void set_ulong (ulong v_ulong)
Set the contents of a G_TYPE_ULONG Value to v_ulong.
public ulong get_ulong ()
Get the contents of a G_TYPE_ULONG Value.
public void set_int64 (int64 v_int64)
Set the contents of a G_TYPE_INT64 Value to v_int64.
public int64 get_int64 ()
Get the contents of a G_TYPE_INT64 Value.
public void set_uint64 (uint64 v_uint64)
Set the contents of a G_TYPE_UINT64 Value to v_uint64.
public uint64 get_uint64 ()
Get the contents of a G_TYPE_UINT64 Value.
public void set_float (float v_float)
Set the contents of a G_TYPE_FLOAT Value to v_float.
public float get_float ()
Get the contents of a G_TYPE_FLOAT Value.
public void set_double (double v_double)
Set the contents of a G_TYPE_DOUBLE Value to v_double.
public double get_double ()
Get the contents of a G_TYPE_DOUBLE Value.
public void set_enum (int v_enum)
Set the contents of a ENUM Value to v_enum.
public int get_enum ()
Get the contents of a ENUM Value.
public void set_flags (uint v_flags)
Set the contents of a FLAGS Value to v_flags.
public uint get_flags ()
Get the contents of a FLAGS Value.
public void set_string (string v_string)
Set the contents of a typeof (BusName) Value to v_string.
public void set_static_string (string v_string)
Set the contents of a typeof (BusName) Value to v_string. The string is assumed to be static, and is thus not duplicated when setting the Value.
public void take_string (owned string v_string)
Sets the contents of a typeof (BusName) Value to v_string.
public unowned string get_string ()
Get the contents of a typeof (BusName) Value.
public string dup_string ()
Get a copy the contents of a typeof (BusName) Value.
public void set_pointer (void* v_pointer)
Set the contents of a pointer Value to v_pointer.
public void* get_pointer ()
Get the contents of a pointer Value.
public void set_boxed (void* v_boxed)
Set the contents of a BOXED derived Value to v_boxed.
public void* get_boxed ()
Get the contents of a BOXED derived Value.
public void* dup_boxed ()
Get the contents of a BOXED derived Value. Upon getting, the boxed value is duplicated and needs to be later freed with g_boxed_free, e.g. like: g_boxed_free (G_VALUE_TYPE (@value), return_value);
public void set_object (Object v_object)
Set the contents of a typeof (Object) derived Value to v_object.
public void take_object (owned Object v_object)
Sets the contents of a typeof (Object) derived Value to v_object and takes over the ownership of the callers reference to v_object; the caller doesn't have to unref it any more (i.e. the reference count of the object is not increased).
public weak Object get_object ()
Get the contents of a typeof (Object) derived Value.
public Object dup_object ()
Get the contents of a typeof (Object) derived Value, increasing its reference count. If the contents of the Value are null, then null will be returned.
public void set_gtype (Type v_gtype)
Set the contents of a G_TYPE_GTYPE Value to v_gtype.
public Type get_gtype ()
Get the contents of a G_TYPE_GTYPE Value.
public void set_param (ParamSpec param)
Set the contents of a typeof (ParamSpec) Value to param.
public ParamSpec get_param ()
Get the contents of a typeof (ParamSpec) Value.
public void take_param (out ParamSpec param)
Sets the contents of a typeof (ParamSpec) Value to param and takes over the ownership of the callers reference to param; the caller doesn't have to unref it any more.
public void param_take_ownership (out ParamSpec param)