Blame docs/reference/gobject/html/gobject-Value-arrays.html

Packit 84794d
Packit 84794d
<html>
Packit 84794d
<head>
Packit 84794d
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 84794d
<title>Value arrays: GObject Reference Manual</title>
Packit 84794d
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 84794d
<link rel="home" href="index.html" title="GObject Reference Manual">
Packit 84794d
<link rel="up" href="rn01.html" title="API Reference">
Packit 84794d
<link rel="prev" href="gobject-Closures.html" title="Closures">
Packit 84794d
<link rel="next" href="GBinding.html" title="GBinding">
Packit 84794d
<meta name="generator" content="GTK-Doc V1.29.1 (XML mode)">
Packit 84794d
<link rel="stylesheet" href="style.css" type="text/css">
Packit 84794d
</head>
Packit 84794d
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 84794d
Packit 84794d
Packit 84794d
Top  | 
Packit 84794d
                  Description
Packit 84794d
Packit 84794d
Home
Packit 84794d
Up
Packit 84794d
Prev
Packit 84794d
Next
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Value arrays

Packit 84794d

Value arrays — A container structure to maintain an array of

Packit 84794d
    generic values

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Functions

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValue *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_get_nth ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_new ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_copy ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
void
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_free ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_append ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_prepend ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_insert ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_remove ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_sort ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
GValueArray *
Packit 84794d
Packit 84794d
Packit 84794d
g_value_array_sort_with_data ()
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Types and Values

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
struct
Packit 84794d
GValueArray
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Includes

Packit 84794d
#include <glib-object.h>
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Description

Packit 84794d

The prime purpose of a GValueArray is for it to be used as an

Packit 84794d
object property that holds an array of values. A GValueArray wraps
Packit 84794d
an array of GValue elements in order for it to be used as a boxed
Packit 84794d
type through G_TYPE_VALUE_ARRAY.

Packit 84794d

GValueArray is deprecated in favour of GArray since GLib 2.32. It

Packit 84794d
is possible to create a GArray that behaves like a GValueArray by
Packit 84794d
using the size of GValue as the element size, and by setting
Packit 84794d
g_value_unset() as the clear function using g_array_set_clear_func(),
Packit 84794d
for instance, the following code:

Packit 84794d
Packit 84794d
  
Packit 84794d
    
Packit 84794d
      
Packit 84794d
        
1
Packit 84794d
        
GValueArray *array = g_value_array_new (10);
Packit 84794d
      
Packit 84794d
    
Packit 84794d
  
Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d

can be replaced by:

Packit 84794d
Packit 84794d
  
Packit 84794d
    
Packit 84794d
      
Packit 84794d
        
1
Packit 84794d
2
Packit 84794d
        
GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10);
Packit 84794d
g_array_set_clear_func (array, (GDestroyNotify) g_value_unset);
Packit 84794d
      
Packit 84794d
    
Packit 84794d
  
Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d
Packit 84794d

Functions

Packit 84794d
Packit 84794d

g_value_array_get_nth ()

Packit 84794d
GValue *
Packit 84794d
g_value_array_get_nth (GValueArray *value_array,
Packit 84794d
                       guint index_);
Packit 84794d
Packit 84794d

g_value_array_get_nth has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use g_array_index() instead.

Packit 84794d
Packit 84794d

Return a pointer to the value at index_

Packit 84794d
 containd in value_array
Packit 84794d
.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to get a value from

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

index_

Packit 84794d

index of the value of interest

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

pointer to a value at index_

Packit 84794d
in value_array
Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_new ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_new (guint n_prealloced);
Packit 84794d
Packit 84794d

g_value_array_new has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_sized_new() instead.

Packit 84794d
Packit 84794d

Allocate and initialize a new GValueArray, optionally preserve space

Packit 84794d
for n_prealloced
Packit 84794d
 elements. New arrays always contain 0 elements,
Packit 84794d
regardless of the value of n_prealloced
Packit 84794d
.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

n_prealloced

Packit 84794d

number of values to preallocate space for

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

a newly allocated GValueArray with 0 values

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_copy ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_copy (const GValueArray *value_array);
Packit 84794d
Packit 84794d

g_value_array_copy has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_ref() instead.

Packit 84794d
Packit 84794d

Construct an exact copy of a GValueArray by duplicating all its

Packit 84794d
contents.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to copy

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

Newly allocated copy of GValueArray.

Packit 84794d

[transfer full]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_free ()

Packit 84794d
void
Packit 84794d
g_value_array_free (GValueArray *value_array);
Packit 84794d
Packit 84794d

g_value_array_free has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_unref() instead.

Packit 84794d
Packit 84794d

Free a GValueArray including its contents.

Packit 84794d

[skip]

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to free

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_append ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_append (GValueArray *value_array,
Packit 84794d
                      const GValue *value);
Packit 84794d
Packit 84794d

g_value_array_append has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_append_val() instead.

Packit 84794d
Packit 84794d

Insert a copy of value

Packit 84794d
 as last element of value_array
Packit 84794d
. If value
Packit 84794d
 is
Packit 84794d
NULL, an uninitialized value is appended.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to add an element to

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

value

Packit 84794d

GValue to copy into GValueArray, or NULL.

Packit 84794d
[nullable]
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

the GValueArray passed in as value_array

Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_prepend ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_prepend (GValueArray *value_array,
Packit 84794d
                       const GValue *value);
Packit 84794d
Packit 84794d

g_value_array_prepend has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_prepend_val() instead.

Packit 84794d
Packit 84794d

Insert a copy of value

Packit 84794d
 as first element of value_array
Packit 84794d
. If value
Packit 84794d
 is
Packit 84794d
NULL, an uninitialized value is prepended.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to add an element to

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

value

Packit 84794d

GValue to copy into GValueArray, or NULL.

Packit 84794d
[nullable]
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

the GValueArray passed in as value_array

Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_insert ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_insert (GValueArray *value_array,
Packit 84794d
                      guint index_,
Packit 84794d
                      const GValue *value);
Packit 84794d
Packit 84794d

g_value_array_insert has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_insert_val() instead.

Packit 84794d
Packit 84794d

Insert a copy of value

Packit 84794d
 at specified position into value_array
Packit 84794d
. If value
Packit 84794d
Packit 84794d
is NULL, an uninitialized value is inserted.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to add an element to

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

index_

Packit 84794d

insertion position, must be <= value_array->;n_values

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

value

Packit 84794d

GValue to copy into GValueArray, or NULL.

Packit 84794d
[nullable]
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

the GValueArray passed in as value_array

Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_remove ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_remove (GValueArray *value_array,
Packit 84794d
                      guint index_);
Packit 84794d
Packit 84794d

g_value_array_remove has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_remove_index() instead.

Packit 84794d
Packit 84794d

Remove the value at position index_

Packit 84794d
 from value_array
Packit 84794d
.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to remove an element from

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

index_

Packit 84794d

position of value to remove, which must be less than

Packit 84794d
value_array->n_values
Packit 84794d

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

the GValueArray passed in as value_array

Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_sort ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_sort (GValueArray *value_array,
Packit 84794d
                    GCompareFunc compare_func);
Packit 84794d
Packit 84794d

g_value_array_sort has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_sort().

Packit 84794d
Packit 84794d

Sort value_array

Packit 84794d
 using compare_func
Packit 84794d
 to compare the elements according to
Packit 84794d
the semantics of GCompareFunc.

Packit 84794d

The current implementation uses the same sorting algorithm as standard

Packit 84794d
C qsort() function.

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to sort

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

compare_func

Packit 84794d

function to compare elements.

Packit 84794d
[scope call]
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

the GValueArray passed in as value_array

Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d

Packit 84794d
Packit 84794d

g_value_array_sort_with_data ()

Packit 84794d
GValueArray *
Packit 84794d
g_value_array_sort_with_data (GValueArray *value_array,
Packit 84794d
                              GCompareDataFunc compare_func,
Packit 84794d
                              gpointer user_data);
Packit 84794d
Packit 84794d

g_value_array_sort_with_data has been deprecated since version 2.32 and should not be used in newly-written code.

Packit 84794d

Use GArray and g_array_sort_with_data().

Packit 84794d
Packit 84794d

Sort value_array

Packit 84794d
 using compare_func
Packit 84794d
 to compare the elements according
Packit 84794d
to the semantics of GCompareDataFunc.

Packit 84794d

The current implementation uses the same sorting algorithm as standard

Packit 84794d
C qsort() function.

Packit 84794d

[rename-to g_value_array_sort]

Packit 84794d
Packit 84794d

Parameters

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

value_array

Packit 84794d

GValueArray to sort

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

compare_func

Packit 84794d

function to compare elements.

Packit 84794d
[scope call]
Packit 84794d
Packit 84794d
Packit 84794d

user_data

Packit 84794d

extra data argument provided for compare_func

Packit 84794d
. 

Packit 84794d
[closure]
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Returns

Packit 84794d

the GValueArray passed in as value_array

Packit 84794d
. 

Packit 84794d

[transfer none]

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Types and Values

Packit 84794d
Packit 84794d

struct GValueArray

Packit 84794d
struct GValueArray {
Packit 84794d
  guint   n_values;
Packit 84794d
  GValue *values;
Packit 84794d
};
Packit 84794d
Packit 84794d

A GValueArray contains an array of GValue elements.

Packit 84794d
Packit 84794d

Members

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

guint n_values;

Packit 84794d

number of values contained in the array

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d

GValue *values;

Packit 84794d

array of values

Packit 84794d
 
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

See Also

Packit 84794d

GValue, GParamSpecValueArray, g_param_spec_value_array()

Packit 84794d
Packit 84794d
Packit 84794d
Packit 84794d

Generated by GTK-Doc V1.29.1
Packit 84794d
</body>
Packit 84794d
</html>