glib-2.0/gobject/gvaluearray.h

0001 /* GObject - GLib Type, Object, Parameter and Signal Library
0002  * Copyright (C) 2001 Red Hat, Inc.
0003  *
0004  * SPDX-License-Identifier: LGPL-2.1-or-later
0005  *
0006  * This library is free software; you can redistribute it and/or
0007  * modify it under the terms of the GNU Lesser General Public
0008  * License as published by the Free Software Foundation; either
0009  * version 2.1 of the License, or (at your option) any later version.
0010  *
0011  * This library is distributed in the hope that it will be useful,
0012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0014  * Lesser General Public License for more details.
0015  *
0016  * You should have received a copy of the GNU Lesser General
0017  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0018  *
0019  * gvaluearray.h: GLib array type holding GValues
0020  */
0021 #ifndef __G_VALUE_ARRAY_H__
0022 #define __G_VALUE_ARRAY_H__
0023
0024 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
0025 #error "Only <glib-object.h> can be included directly."
0026 #endif
0027
0028 #include    <gobject/gvalue.h>
0029
0030 G_BEGIN_DECLS
0031
0032 /**
0033  * G_TYPE_VALUE_ARRAY:
0034  *
0035  * The type ID of the "GValueArray" type which is a boxed type,
0036  * used to pass around pointers to GValueArrays.
0037  *
0038  * Deprecated: 2.32: Use #GArray instead of #GValueArray
0039  */
0040 #define G_TYPE_VALUE_ARRAY (g_value_array_get_type ()) GOBJECT_DEPRECATED_MACRO_IN_2_32_FOR(G_TYPE_ARRAY)
0041
0042 /* --- typedefs & structs --- */
0043 typedef struct _GValueArray GValueArray;
0044 struct _GValueArray
0045 {
0046   guint   n_values;
0047   GValue *values;
0048
0049   /*< private >*/
0050   guint   n_prealloced;
0051 };
0052
0053 /* --- prototypes --- */
0054 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0055 GType           g_value_array_get_type       (void) G_GNUC_CONST;
0056
0057 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0058 GValue*     g_value_array_get_nth        (GValueArray   *value_array,
0059                           guint      index_);
0060
0061 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0062 GValueArray*    g_value_array_new        (guint      n_prealloced);
0063
0064 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0065 void        g_value_array_free       (GValueArray   *value_array);
0066
0067 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0068 GValueArray*    g_value_array_copy       (const GValueArray *value_array);
0069
0070 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0071 GValueArray*    g_value_array_prepend        (GValueArray   *value_array,
0072                           const GValue  *value);
0073
0074 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0075 GValueArray*    g_value_array_append         (GValueArray   *value_array,
0076                           const GValue  *value);
0077
0078 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0079 GValueArray*    g_value_array_insert         (GValueArray   *value_array,
0080                           guint      index_,
0081                           const GValue  *value);
0082
0083 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0084 GValueArray*    g_value_array_remove         (GValueArray   *value_array,
0085                           guint      index_);
0086
0087 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0088 GValueArray*    g_value_array_sort       (GValueArray   *value_array,
0089                           GCompareFunc   compare_func);
0090
0091 GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
0092 GValueArray*    g_value_array_sort_with_data (GValueArray   *value_array,
0093                           GCompareDataFunc   compare_func,
0094                           gpointer       user_data);
0095
0096
0097 G_END_DECLS
0098
0099 #endif /* __G_VALUE_ARRAY_H__ */