Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GValueArray

[23:7] extends: object

A GValueArray is a container structure to hold an array of generic values. The prime purpose of a GValueArray is for it to be used as an object property that holds an array of values. A GValueArray wraps an array of GValue elements in order for it to be used as a boxed type through G_TYPE_VALUE_ARRAY. GValueArray is deprecated in favour of GArray since GLib 2.32. It is possible to create a GArray that behaves like a GValueArray by using the size of GValue as the element size, and by setting [method@GObject.Value.unset] as the clear function using [func@GLib.Array.set_clear_func], for instance, the following code: c GValueArray *array = g_value_array_new (10); can be replaced by: c GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10); g_array_set_clear_func (array, (GDestroyNotify) g_value_unset);

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • GValueArray (n_prealloced = null)

    Allocate and initialize a new #GValueArray, optionally preserve space for

    • @n_prealloced elements. New arrays always contain 0 elements, regardless of the value of @n_prealloced.
    • @p n_prealloced is number of values to preallocate space for.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • append (object value)

    Insert a copy of @value as last element of @value_array. If @value is %NULL, an uninitialized value is appended.

    • @p value is #GValue to copy into #GValueArray, or %NULL.
    • @r the #GValueArray passed in as @value_array.
  • copy ()

    Construct an exact copy of a #GValueArray by duplicating all its contents.

    • @r Newly allocated copy of #GValueArray.
  • free ()

    Free a #GValueArray including its contents.

    • @r None.
  • get_nth (int index_)

    Return a pointer to the value at @index_ contained in @value_array.

    • @p index_ is index of the value of interest.
    • @r pointer to a value at @index_ in @value_array.
  • insert (int index_, object value)

    Insert a copy of @value at specified position into @value_array. If

    • @value is %NULL, an uninitialized value is inserted.
    • @p index_ is insertion position, must be <= value_array->;n_values.
    • @p value is #GValue to copy into #GValueArray, or %NULL.
    • @r the #GValueArray passed in as @value_array.
  • prepend (object value)

    Insert a copy of @value as first element of @value_array. If @value is %NULL, an uninitialized value is prepended.

    • @p value is #GValue to copy into #GValueArray, or %NULL.
    • @r the #GValueArray passed in as @value_array.
  • remove (int index_)

    Remove the value at position @index_ from @value_array.

    • @p index_ is position of value to remove, which must be less than
    • @value_array->n_values. ``
    • @r the #GValueArray passed in as @value_array.
  • sort (object compare_func)

    Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareFunc. The current implementation uses the same sorting algorithm as standard C qsort() function.

    • @p compare_func is function to compare elements.
    • @r the #GValueArray passed in as @value_array.
  • sort_with_data (user_data)

    Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareDataFunc. The current implementation uses the same sorting algorithm as standard C qsort() function.

    • @p compare_func is function to compare elements.
    • @p user_data is extra data argument provided for @compare_func.
    • @r the #GValueArray passed in as @value_array.