gobject/gvaluearray.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 2001 Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General
  15  * Public License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  *
  19  * gvaluearray.h: GLib array type holding GValues
  20  */
  21 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  22 #error "Only <glib-object.h> can be included directly."
  23 #endif
  24
  25 #ifndef __G_VALUE_ARRAY_H__
  26 #define __G_VALUE_ARRAY_H__
  27
  28 #include        <gobject/gvalue.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /**
  33  * G_TYPE_VALUE_ARRAY:
  34  *
  35  * The type ID of the "GValueArray" type which is a boxed type,
  36  * used to pass around pointers to GValueArrays.
  37  *
  38  * Deprecated: 2.32: Use #GArray instead of #GValueArray
  39  */
  40 #define G_TYPE_VALUE_ARRAY (g_value_array_get_type ())
  41
  42 /* --- typedefs & structs --- */
  43 typedef struct _GValueArray GValueArray;
  44 /**
  45  * GValueArray:
  46  * @n_values: number of values contained in the array
  47  * @values: array of values
  48  *
  49  * A #GValueArray contains an array of #GValue elements.
  50  */
  51 struct _GValueArray
  52 {
  53   guint   n_values;
  54   GValue *values;
  55
  56   /*< private >*/
  57   guint   n_prealloced;
  58 };
  59
  60 /* --- prototypes --- */
  61 GLIB_DEPRECATED_IN_2_32_FOR(g_array_get_type)
  62 GType           g_value_array_get_type       (void) G_GNUC_CONST;
  63
  64 GLIB_DEPRECATED_IN_2_32_FOR(g_array_index)
  65 GValue*         g_value_array_get_nth        (GValueArray       *value_array,
  66                                               guint              index_);
  67
  68 GLIB_DEPRECATED_IN_2_32_FOR(g_array_new)
  69 GValueArray*    g_value_array_new            (guint              n_prealloced);
  70
  71 GLIB_DEPRECATED_IN_2_32_FOR(g_array_unref)
  72 void            g_value_array_free           (GValueArray       *value_array);
  73
  74 GLIB_DEPRECATED_IN_2_32_FOR(g_array_ref)
  75 GValueArray*    g_value_array_copy           (const GValueArray *value_array);
  76
  77 GLIB_DEPRECATED_IN_2_32_FOR(g_array_prepend_vals)
  78 GValueArray*    g_value_array_prepend        (GValueArray       *value_array,
  79                                               const GValue      *value);
  80
  81 GLIB_DEPRECATED_IN_2_32_FOR(g_array_append_vals)
  82 GValueArray*    g_value_array_append         (GValueArray       *value_array,
  83                                               const GValue      *value);
  84
  85 GLIB_DEPRECATED_IN_2_32_FOR(g_array_insert_vals)
  86 GValueArray*    g_value_array_insert         (GValueArray       *value_array,
  87                                               guint              index_,
  88                                               const GValue      *value);
  89
  90 GLIB_DEPRECATED_IN_2_32_FOR(g_array_remove_index)
  91 GValueArray*    g_value_array_remove         (GValueArray       *value_array,
  92                                               guint              index_);
  93
  94 GLIB_DEPRECATED_IN_2_32_FOR(g_array_sort)
  95 GValueArray*    g_value_array_sort           (GValueArray       *value_array,
  96                                               GCompareFunc       compare_func);
  97
  98 GLIB_DEPRECATED_IN_2_32_FOR(g_array_sort_with_data)
  99 GValueArray*    g_value_array_sort_with_data (GValueArray       *value_array,
 100                                               GCompareDataFunc   compare_func,
 101                                               gpointer           user_data);
 102
 103
 104 G_END_DECLS
 105
 106 #endif /* __G_VALUE_ARRAY_H__ */