Gjsify LogoGjsify Logo

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.

record

Hierarchy

  • Value

Index

Constructors

Properties

name: string

Methods

  • copy(dest_value: any): void
  • Copies the value of src_value into dest_value.

    Parameters

    • dest_value: any

      An initialized #GValue structure of the same type as src_value.

    Returns void

  • dup_string(): string
  • fits_pointer(): boolean
  • Determines if value will fit inside the size of a pointer value. This is an internal function introduced mainly for C marshallers.

    Returns boolean

  • get_boolean(): boolean
  • get_boxed(): object
  • get_char(): number
  • 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().

    Get the contents of a %G_TYPE_CHAR #GValue.

    Returns number

  • get_double(): number
  • get_enum(): number
  • get_flags(): number
  • get_float(): number
  • get_gtype(): GType<unknown>
  • get_int(): number
  • get_int64(): number
  • get_long(): number
  • get_pointer(): object
  • get_schar(): number
  • get_string(): string
  • get_uchar(): number
  • get_uint(): number
  • get_uint64(): number
  • get_ulong(): number
  • init(g_type: GType<unknown>): any
  • Initializes and sets value from an instantiatable type via the value_table's collect_value() function.

    Note: The value will be initialised with the exact type of instance. If you wish to set the value's type to a different GType (such as a parent class GType), you need to manually call g_value_init() and g_value_set_instance().

    Parameters

    Returns void

  • peek_pointer(): object
  • Returns the value contents as pointer. This function asserts that g_value_fits_pointer() returned %TRUE for the passed in value. This is an internal function introduced mainly for C marshallers.

    Returns object

  • reset(): any
  • Clears the current value in value and resets it to the default value (as if the value had just been initialized).

    Returns any

  • set_boolean(v_boolean: boolean): void
  • Set the contents of a %G_TYPE_BOOLEAN #GValue to v_boolean.

    Parameters

    • v_boolean: boolean

      boolean value to be set

    Returns void

  • set_boxed(v_boxed: object): void
  • Set the contents of a %G_TYPE_BOXED derived #GValue to v_boxed.

    Parameters

    • v_boxed: object

      boxed value to be set

    Returns void

  • set_boxed_take_ownership(v_boxed: object): void
  • This is an internal function introduced mainly for C marshallers.

    Parameters

    • v_boxed: object

      duplicated unowned boxed value to be set

    Returns void

  • set_char(v_char: number): void
  • Set the contents of a %G_TYPE_CHAR #GValue to v_char.

    Parameters

    • v_char: number

      character value to be set

    Returns void

  • set_double(v_double: number): void
  • Set the contents of a %G_TYPE_DOUBLE #GValue to v_double.

    Parameters

    • v_double: number

      double value to be set

    Returns void

  • set_enum(v_enum: number): void
  • set_flags(v_flags: number): void
  • Set the contents of a %G_TYPE_FLAGS #GValue to v_flags.

    Parameters

    • v_flags: number

      flags value to be set

    Returns void

  • set_float(v_float: number): void
  • Set the contents of a %G_TYPE_FLOAT #GValue to v_float.

    Parameters

    • v_float: number

      float value to be set

    Returns void

  • set_gtype(v_gtype: GType<unknown>): void
  • set_instance(instance: object): void
  • Sets value from an instantiatable type via the value_table's collect_value() function.

    Parameters

    • instance: object

      the instance

    Returns void

  • set_int(v_int: number): void
  • set_int64(v_int64: number): void
  • Set the contents of a %G_TYPE_INT64 #GValue to v_int64.

    Parameters

    • v_int64: number

      64bit integer value to be set

    Returns void

  • set_interned_string(v_string: string): void
  • 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.

    Parameters

    • v_string: string

      static string to be set

    Returns void

  • set_long(v_long: number): void
  • Set the contents of a %G_TYPE_LONG #GValue to v_long.

    Parameters

    • v_long: number

      long integer value to be set

    Returns void

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

    g_value_set_object() increases the reference count of v_object (the #GValue holds a reference to v_object). If you do not wish to increase the reference count of the object (i.e. you wish to pass your current reference to the #GValue because you no longer need it), use g_value_take_object() instead.

    It is important that your #GValue holds a reference to v_object (either its own, or one it has taken) to ensure that the object won't be destroyed while the #GValue still exists).

    Parameters

    Returns void

  • set_pointer(v_pointer: object): void
  • Set the contents of a pointer #GValue to v_pointer.

    Parameters

    • v_pointer: object

      pointer value to be set

    Returns void

  • set_schar(v_char: number): void
  • Set the contents of a %G_TYPE_CHAR #GValue to v_char.

    Parameters

    • v_char: number

      signed 8 bit integer to be set

    Returns void

  • set_static_boxed(v_boxed: object): void
  • Set the contents of a %G_TYPE_BOXED derived #GValue to v_boxed.

    The boxed value is assumed to be static, and is thus not duplicated when setting the #GValue.

    Parameters

    • v_boxed: object

      static boxed value to be set

    Returns void

  • set_static_string(v_string: string): void
  • 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.

    If the the string is a canonical string, using g_value_set_interned_string() is more appropriate.

    Parameters

    • v_string: string

      static string to be set

    Returns void

  • set_string(v_string: string): void
  • Set the contents of a %G_TYPE_STRING #GValue to a copy of v_string.

    Parameters

    • v_string: string

      caller-owned string to be duplicated for the #GValue

    Returns void

  • set_string_take_ownership(v_string: string): void
  • This is an internal function introduced mainly for C marshallers.

    Parameters

    • v_string: string

      duplicated unowned string to be set

    Returns void

  • set_uchar(v_uchar: number): void
  • Set the contents of a %G_TYPE_UCHAR #GValue to v_uchar.

    Parameters

    • v_uchar: number

      unsigned character value to be set

    Returns void

  • set_uint(v_uint: number): void
  • Set the contents of a %G_TYPE_UINT #GValue to v_uint.

    Parameters

    • v_uint: number

      unsigned integer value to be set

    Returns void

  • set_uint64(v_uint64: number): void
  • Set the contents of a %G_TYPE_UINT64 #GValue to v_uint64.

    Parameters

    • v_uint64: number

      unsigned 64bit integer value to be set

    Returns void

  • set_ulong(v_ulong: number): void
  • Set the contents of a %G_TYPE_ULONG #GValue to v_ulong.

    Parameters

    • v_ulong: number

      unsigned long integer value to be set

    Returns void

  • take_boxed(v_boxed: object): void
  • Sets the contents of a %G_TYPE_BOXED derived #GValue to v_boxed and takes over the ownership of the caller’s reference to v_boxed; the caller doesn’t have to unref it any more.

    Parameters

    • v_boxed: object

      duplicated unowned boxed value to be set

    Returns void

  • take_string(v_string: string): void
  • Sets the contents of a %G_TYPE_STRING #GValue to v_string.

    Parameters

    • v_string: string

      string to take ownership of

    Returns void

  • 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).

    If variant was floating then its floating reference is converted to a hard reference.

    If you want the #GValue to hold its own reference to variant, use g_value_set_variant() instead.

    This is an internal function introduced mainly for C marshallers.

    Parameters

    Returns void

  • transform(dest_value: any): 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).

    Parameters

    • dest_value: any

      Target value.

    Returns boolean

  • unset(): void
  • 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.

    Returns void

  • type_compatible(src_type: GType<unknown>, dest_type: GType<unknown>): boolean
  • Returns whether a #GValue of type src_type can be copied into a #GValue of type dest_type.

    Parameters

    • src_type: GType<unknown>

      source type to be copied.

    • dest_type: GType<unknown>

      destination type for copying.

    Returns boolean

  • type_transformable(src_type: GType<unknown>, dest_type: GType<unknown>): boolean
  • Check whether g_value_transform() is able to transform values of type src_type into values of type dest_type. Note that for the types to be transformable, they must be compatible or a transformation function must be registered.

    Parameters

    • src_type: GType<unknown>

      Source type.

    • dest_type: GType<unknown>

      Target type.

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method