glib/docs/reference/gobject/tmpl/gboxed.sgml
Owen Taylor b9f59f0f9d Update.
Thu Nov 22 12:56:57 2001  Owen Taylor  <otaylor@redhat.com>

        * gobject/gobject-sections.txt: Update.

        * glib/tmpl/{spawn.sgml,patterns.sgml}: SGML fixes.

        * glib/glib-sections.txt: Updated.

        * glib/Makefile.am (IGNORE_HFILES): Don't scan
        headers in build/
2001-11-22 18:54:47 +00:00

87 lines
1.9 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GBoxed
<!-- ##### SECTION Short_Description ##### -->
Mechanism to wrap opaque C structures registered by the type system.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GParamSpecBoxed, g_param_spec_boxed()
</para>
<!-- ##### USER_FUNCTION GBoxedCopyFunc ##### -->
<para>
This function is provided by the user and should produce a copy of the passed
in boxed structure.
</para>
@boxed: The boxed structure to be copied.
@Returns: The newly created copy of the boxed structure.
<!-- ##### USER_FUNCTION GBoxedFreeFunc ##### -->
<para>
This function is provided by the user and should free the boxed
structure passed.
</para>
@boxed: The boxed structure to be freed.
<!-- ##### FUNCTION g_boxed_copy ##### -->
<para>
Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
</para>
@boxed_type: The type of @src_boxed.
@src_boxed: The boxed structure to be copied.
@Returns: The newly created copy of the boxed structure.
<!-- ##### FUNCTION g_boxed_free ##### -->
<para>
Free the boxed structure @boxed which is of type @boxed_type.
</para>
@boxed_type: The type of @boxed.
@boxed: The boxed structure to be freed.
<!-- ##### FUNCTION g_boxed_type_register_static ##### -->
<para>
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.
</para>
@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 # -->
@boxed_init:
@is_refcounted:
<!-- ##### FUNCTION g_pointer_type_register_static ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### MACRO G_TYPE_GSTRING ##### -->
<para>
</para>