luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 11:26:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs for G_DEFINE_TYPE_* macros.

Browse Source 
Sun Jan 11 01:25:44 2004  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/gtype.sgml: Improve docs for G_DEFINE_TYPE_* macros.

Sun Jan 11 01:25:29 2004  Matthias Clasen  <maclas@gmx.de>

	* gobject/gobject-sections.txt: Add G_DEFINE_TYPE_EXTENDED.
This commit is contained in:
Matthias Clasen 2004-01-11 00:23:57 +00:00 committed by Matthias Clasen
parent 805ba95fb1
commit af81f44e66
3 changed files with 113 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/ChangeLog
View File

@ -1,3 +1,11 @@
Sun Jan 11 01:25:44 2004 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/gtype.sgml: Improve docs for G_DEFINE_TYPE_* macros.
Sun Jan 11 01:25:29 2004 Matthias Clasen <maclas@gmx.de>
* gobject/gobject-sections.txt: Add G_DEFINE_TYPE_EXTENDED.
Sat Jan 10 02:18:32 2004 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/gtype.sgml: Document the new GType boilerplate macros

3
docs/reference/gobject/gobject-sections.txt
View File

@ -101,6 +101,8 @@ G_DEFINE_TYPE_WITH_CODE
G_DEFINE_ABSTRACT_TYPE
G_DEFINE_ABSTRACT_TYPE_WITH_CODE
G_IMPLEMENT_INTERFACE
G_DEFINE_TYPE_EXTENDED
<SUBSECTION Private>
G_TYPE_FUNDAMENTAL_SHIFT
g_type_check_instance
@ -115,7 +117,6 @@ g_type_instance_get_private
g_type_test_flags
g_type_name_from_instance
g_type_name_from_class
G_DEFINE_TYPE_INTERNAL
<SUBSECTION>
G_TYPE_INVALID

156
docs/reference/gobject/tmpl/gtype.sgml
View File

@ -1462,8 +1462,15 @@ that implements or has internal knowledge of the implementation of
<!-- ##### MACRO G_DEFINE_TYPE ##### -->
<para>
A convenience macro for type implementations.
See G_DEFINE_TYPE_WITH_CODE() for an example.
A convenience macro for type implementations, which declares a
class initialization function, an instance initialization function (see #GTypeInfo for information about
these) and a static variable named parent_class pointing to the parent class. Furthermore, it defines
a *_get_type() function. See G_DEFINE_TYPE_EXTENDED() for an example.
</para>
<para>
Note that you can't use this macro if you want to define multiple types in one file,
since the parent_class variables will clash. In this case, use
G_DEFINE_TYPE_EXTENDED() and choose different identifiers for @type_parent_class.
</para>
@TN: The name of the new type, in Camel case.
@ -1472,25 +1479,105 @@ See G_DEFINE_TYPE_WITH_CODE() for an example.
@T_P: The #GType of the parent type.
@Since: 2.4
<!-- ##### MACRO G_DEFINE_TYPE_WITH_CODE ##### -->
<para>
A convenience macro for type implementations.
Similar to G_DEFINE_TYPE(), but allows to insert custom code into the
*_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().
See G_DEFINE_TYPE_EXTENDED() for an example.
</para>
<para>
Note that you can't use this macro if you want to define multiple types in one file,
since the parent_class variables will clash. In this case, use
G_DEFINE_TYPE_EXTENDED() and choose different identifiers for @type_parent_class.
</para>
@TN: The name of the new type, in Camel case.
@t_n: The name of the new type in lowercase, with words separated by '_'.
@T_P: The #GType of the parent type.
@_C_: Custom code that gets inserted in the *_get_type() function.
@Since: 2.4
<!-- ##### MACRO G_DEFINE_ABSTRACT_TYPE ##### -->
<para>
A convenience macro for type implementations.
Similar to G_DEFINE_TYPE(), but defines an abstract type.
See G_DEFINE_TYPE_EXTENDED() for an example.
</para>
<para>
Note that you can't use this macro if you want to define multiple types in one file,
since the parent_class variables will clash. In this case, use
G_DEFINE_TYPE_EXTENDED() and choose different identifiers for @type_parent_class.
</para>
@TN: The name of the new type, in Camel case.
@t_n: The name of the new type, in lowercase, with words
separated by '_'.
@T_P: The #GType of the parent type.
@Since: 2.4
<!-- ##### MACRO G_DEFINE_ABSTRACT_TYPE_WITH_CODE ##### -->
<para>
A convenience macro for type implementations.
Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and allows to
insert custom code into the *_get_type() function, e.g. interface implementations
via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example.
</para>
<para>
Note that you can't use this macro if you want to define multiple types in one file,
since the parent_class variables will clash. In this case, use
G_DEFINE_TYPE_EXTENDED() and choose different identifiers for @type_parent_class.
</para>
@TN: The name of the new type, in Camel case.
@t_n: The name of the new type, in lowercase, with words
separated by '_'.
@T_P: The #GType of the parent type.
@_C_: Custom code that gets inserted in the @type_name_get_type() function.
@Since: 2.4
<!-- ##### MACRO G_IMPLEMENT_INTERFACE ##### -->
<para>
A convenience macro to ease interface addition in the @_C_ section
of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
See G_DEFINE_TYPE_EXTENDED() for an example.
</para>
<para>
Note that this macro can only be used together with the G_DEFINE_TYPE_*
macros, since it depends on variable names from those macros.
</para>
@TYPE_IFACE: The #GType of the interface to add
@iface_init: The interface init function
@Since: 2.4
<!-- ##### MACRO G_DEFINE_TYPE_EXTENDED ##### -->
<para>
The most general convenience macro for type implementations, on which
G_DEFINE_TYPE(), etc are based.
</para>
<informalexample><programlisting>
G_DEFINE_TYPE_WITH_CODE (GtkGadget,
gtk_gadget,
GTK_TYPE_WIDGET,
G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
gtk_gadget_gizmo_init));
G_DEFINE_TYPE_EXTENDED (GtkGadget,
gtk_gadget,
GTK_TYPE_WIDGET,
0,
gtk_gadget_parent_class,
G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
gtk_gadget_gizmo_init));
</programlisting>
exands to
expands to
<programlisting>
static void gtk_gadget_init (GtkGadget *self);
static void gtk_gadget_class_init (GtkGadgetClass *klass);
static gpointer parent_class = NULL;
static gpointer gtk_gadget_parent_class = NULL;
static void gtk_gadget_class_intern_init (gpointer klass)
{
parent_class = g_type_class_peek_parent (klass);
gtk_gadget_parent_class = g_type_class_peek_parent (klass);
gtk_gadget_class_init ((GtkGadgetClass*) klass);
}
<!-- -->
@ -1527,53 +1614,16 @@ instance and class structure and the definitions of the instance and class
init functions.
</informalexample>
@TN: The name of the new type, in Camel case.
@t_n: The name of the new type in lowercase, with words separated by '_'.
@T_P: The #GType of the parent type.
@_C_: Custom code that gets inserted in the *_get_type() function.
@Since: 2.4
<!-- ##### MACRO G_DEFINE_ABSTRACT_TYPE ##### -->
<para>
A convenience macro for type implementations.
Similar to G_DEFINE_TYPE(), but defines an abstract type.
See G_DEFINE_TYPE_WITH_CODE() for an example.
</para>
@TN: The name of the new type, in Camel case.
@t_n: The name of the new type, in lowercase, with words
@TypeName: The name of the new type, in Camel case.
@type_name: The name of the new type, in lowercase, with words
separated by '_'.
@T_P: The #GType of the parent type.
@TYPE_PARENT: The #GType of the parent type.
@flags: #GTypeFlags to pass to g_type_register_static()
@type_parent_class: the identifier for the static variable holding the parent class
@CODE: Custom code that gets inserted in the *_get_type() function.
@Since: 2.4
<!-- ##### MACRO G_DEFINE_ABSTRACT_TYPE_WITH_CODE ##### -->
<para>
A convenience macro for type implementations.
Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type.
See G_DEFINE_TYPE_WITH_CODE() for an example.
</para>
@TN: The name of the new type, in Camel case.
@t_n: The name of the new type, in lowercase, with words
separated by '_'.
@T_P: The #GType of the parent type.
@_C_: Custom code that gets inserted in the @type_name_get_type() function.
@Since: 2.4
<!-- ##### MACRO G_IMPLEMENT_INTERFACE ##### -->
<para>
A convenience macro to ease interface addition in the @Code section
of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
See G_DEFINE_TYPE_WITH_CODE() for an example.
</para>
@TYPE_IFACE: The #GType of the interface to add
@iface_init: The interface init function
@Since: 2.4
<!-- ##### MACRO G_TYPE_INVALID ##### -->
<para>
An invalid #GType, used as error return value in some functions which return