1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000-2001 Red Hat, Inc.
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.
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.
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.
19 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
20 #error "Only <glib-object.h> can be included directly."
26 #include <gobject/gtype.h>
28 #ifndef __GI_SCANNER__
29 #include <gobject/glib-types.h>
34 /* --- type macros --- */
35 #define G_TYPE_IS_BOXED(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_BOXED)
37 * G_VALUE_HOLDS_BOXED:
38 * @value: a valid #GValue structure
40 * Checks whether the given #GValue can hold values derived
41 * from type %G_TYPE_BOXED.
43 * Returns: %TRUE on success.
45 #define G_VALUE_HOLDS_BOXED(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_BOXED))
48 /* --- typedefs --- */
51 * @boxed: The boxed structure to be copied.
53 * This function is provided by the user and should produce a copy
54 * of the passed in boxed structure.
56 * Returns: The newly created copy of the boxed structure.
58 typedef gpointer (*GBoxedCopyFunc) (gpointer boxed);
62 * @boxed: The boxed structure to be freed.
64 * This function is provided by the user and should free the boxed
67 typedef void (*GBoxedFreeFunc) (gpointer boxed);
70 /* --- prototypes --- */
71 gpointer g_boxed_copy (GType boxed_type,
72 gconstpointer src_boxed);
73 void g_boxed_free (GType boxed_type,
75 void g_value_set_boxed (GValue *value,
76 gconstpointer v_boxed);
77 void g_value_set_static_boxed (GValue *value,
78 gconstpointer v_boxed);
79 void g_value_take_boxed (GValue *value,
80 gconstpointer v_boxed);
81 #ifndef G_DISABLE_DEPRECATED
82 void g_value_set_boxed_take_ownership (GValue *value,
83 gconstpointer v_boxed);
85 gpointer g_value_get_boxed (const GValue *value);
86 gpointer g_value_dup_boxed (const GValue *value);
89 /* --- convenience --- */
90 GType g_boxed_type_register_static (const gchar *name,
91 GBoxedCopyFunc boxed_copy,
92 GBoxedFreeFunc boxed_free);
94 /* --- GObject boxed types --- */
98 * The #GType for #GClosure.
100 #define G_TYPE_CLOSURE (g_closure_get_type ())
105 * The type ID of the "GValue" type which is a boxed type,
106 * used to pass around pointers to GValues.
108 #define G_TYPE_VALUE (g_value_get_type ())
111 * G_TYPE_VALUE_ARRAY:
113 * The type ID of the "GValueArray" type which is a boxed type,
114 * used to pass around pointers to GValueArrays.
116 #define G_TYPE_VALUE_ARRAY (g_value_array_get_type ())
118 GType g_closure_get_type (void) G_GNUC_CONST;
119 GType g_value_get_type (void) G_GNUC_CONST;
120 GType g_value_array_get_type (void) G_GNUC_CONST;
124 #endif /* __G_BOXED_H__ */