2000-11-11 01:03:57 +01:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
2001-09-10 20:03:31 +02:00
|
|
|
GBoxed
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2002-11-23 23:57:35 +01:00
|
|
|
A mechanism to wrap opaque C structures registered by the type system
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
2001-09-10 20:03:31 +02:00
|
|
|
#GParamSpecBoxed, g_param_spec_boxed()
|
2000-11-11 01:03:57 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GBoxedCopyFunc ##### -->
|
|
|
|
<para>
|
2001-09-10 20:03:31 +02:00
|
|
|
This function is provided by the user and should produce a copy of the passed
|
|
|
|
in boxed structure.
|
2000-11-11 01:03:57 +01:00
|
|
|
</para>
|
|
|
|
|
2001-09-10 20:03:31 +02:00
|
|
|
@boxed: The boxed structure to be copied.
|
|
|
|
@Returns: The newly created copy of the boxed structure.
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GBoxedFreeFunc ##### -->
|
|
|
|
<para>
|
2001-09-10 20:03:31 +02:00
|
|
|
This function is provided by the user and should free the boxed
|
|
|
|
structure passed.
|
2000-11-11 01:03:57 +01:00
|
|
|
</para>
|
|
|
|
|
2001-09-10 20:03:31 +02:00
|
|
|
@boxed: The boxed structure to be freed.
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_boxed_copy ##### -->
|
|
|
|
<para>
|
2001-09-10 20:03:31 +02:00
|
|
|
Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
|
2000-11-11 01:03:57 +01:00
|
|
|
</para>
|
|
|
|
|
2001-09-10 20:03:31 +02:00
|
|
|
@boxed_type: The type of @src_boxed.
|
|
|
|
@src_boxed: The boxed structure to be copied.
|
|
|
|
@Returns: The newly created copy of the boxed structure.
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_boxed_free ##### -->
|
|
|
|
<para>
|
2001-09-10 20:03:31 +02:00
|
|
|
Free the boxed structure @boxed which is of type @boxed_type.
|
2000-11-11 01:03:57 +01:00
|
|
|
</para>
|
|
|
|
|
2001-09-10 20:03:31 +02:00
|
|
|
@boxed_type: The type of @boxed.
|
|
|
|
@boxed: The boxed structure to be freed.
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_boxed_type_register_static ##### -->
|
|
|
|
<para>
|
2001-09-10 20:03:31 +02:00
|
|
|
This function creates a new %G_TYPE_BOXED derived type id for a new
|
|
|
|
boxed type with name @name. Boxed type handling functions have to be
|
|
|
|
provided to copy and free opaque boxed structures of this type.
|
2000-11-11 01:03:57 +01:00
|
|
|
</para>
|
|
|
|
|
2001-09-10 20:03:31 +02:00
|
|
|
@name: Name of the new boxed type.
|
|
|
|
@boxed_copy: Boxed structure copy function.
|
|
|
|
@boxed_free: Boxed structure free function.
|
|
|
|
@Returns: New %G_TYPE_BOXED derived type id for @name.
|
|
|
|
<!-- # Unused Parameters # -->
|
changed prototype of g_boxed_type_register_static() to contain an optional
Wed Mar 7 09:36:33 2001 Tim Janik <timj@gtk.org>
* gboxed.[hc]: changed prototype of g_boxed_type_register_static()
to contain an optional init function and a hint at whether the
boxed structure uses ref counting internally.
added g_value_set_boxed_take_ownership().
made G_TYPE_BOXED an abstract value type.
* genums.[hc]: made G_TYPE_ENUM and G_TYPE_FLAGS abstract value
types.
* glib-genmarshal.c: argument type changes, preparation for third-party
arg specification.
* gobject.[hc]: cleaned up get/set property code.
added g_strdup_value_contents() to improve warnings.
* gparam.[hc]: added g_param_value_convert(), taking over responsibility
of the old g_value_convert(). added G_PARAM_LAX_VALIDATION flag so
validation alterations may be valid a part of the property setting
process.
* gparamspecs.[hc]: made value comparisons stable (for sort applications).
added GParamSpecValueArray, a param spec for value arrays and
GParamSpecClosure. nuked the value exchange functions and
GParamSpecCCallback.
* gtype.[hc]: catch unintialized usages of the type system with
g_return_val_if_uninitialized(). introduced G_TYPE_FLAG_VALUE_ABSTRACT
to flag types that introduce a value table, but can't be used for
g_value_init(). cleaned up reserved type ids.
* gvalue.[hc]: code cleanups and saner checking.
nuked the value exchange API. implemented value transformations, we
can't really "convert" values, rather transforms are an anylogy to
C casts, real conversions need a param spec for validation, which is
why g_param_value_convert() does real conversions now.
* gvaluearray.[hc]: new files that implement a GValueArray, a struct
that can hold inhomogeneous arrays of value (to that extend that it
also allowes undefined values, i.e. G_VALUE_TYPE(value)==0).
this is exposed to the type system as a boxed type.
* gvaluetransform.c: new file implementing most of the former value
exchange functions as single-sided transformations.
* gvaluetypes.[hc]: nuked G_TYPE_CCALLBACK, added
g_value_set_string_take_ownership().
* *.h: s/G_IS_VALUE_/G_VALUE_HOLDS_/.
* *.[hc]: many fixes and cleanups.
* many warning improvements.
Tue Feb 27 18:35:15 2001 Tim Janik <timj@gtk.org>
* gobject.c (g_object_get_valist): urg, pass G_VALUE_NOCOPY_CONTENTS
into G_VALUE_LCOPY(), this needs proper documenting.
* gparam.c: fixed G_PARAM_USER_MASK.
* gtype.c (type_data_make_W):
(type_data_last_unref_Wm): fixed invalid memory freeing.
* gobject.c (g_object_last_unref): destroy signal handlers associated
with object, right before finalization.
* gsignal.c (g_signal_parse_name): catch destroyed nodes or signals
that don't actually support details.
* gobject.[hc]: got rid of property trailers. nuked GObject
properties "data" and the "signal" variants.
(g_object_connect): new convenience function to do multiple
signal connections at once.
(g_object_disconnect): likewise, for disconnections.
* gparam.[hc] (g_param_spec_pool_lookup): took out trailer support.
* gvalue.[hc]: marked g_value_fits_pointer() and g_value_peek_pointer()
as private (the latter got renamed from g_value_get_as_pointer()).
Wed Mar 7 09:32:06 2001 Tim Janik <timj@gtk.org>
* glib-object.h: add gvaluearray.h.
* gstring.[hc]: fixup naming of g_string_sprint*.
* gtypes.h: fixed GCompareDataFunc naming.
Wed Mar 7 09:33:27 2001 Tim Janik <timj@gtk.org>
* gobject/Makefile.am: shuffled rules to avoid excessive
rebuilds.
* gobject/gobject-sections.txt: updates.
* gobject/tmpl/*: bunch of updates, added another patch
from Eric Lemings <eric.b.lemings@lmco.com>.
2001-03-07 15:46:45 +01:00
|
|
|
@boxed_init:
|
|
|
|
@is_refcounted:
|
2000-11-11 01:03:57 +01:00
|
|
|
|
|
|
|
|
2001-11-14 02:08:19 +01:00
|
|
|
<!-- ##### FUNCTION g_pointer_type_register_static ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-11-22 19:54:47 +01:00
|
|
|
<!-- ##### MACRO G_TYPE_GSTRING ##### -->
|
|
|
|
<para>
|
2002-12-09 20:06:42 +01:00
|
|
|
The #GType for #GString.
|
2001-11-22 19:54:47 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|