From ad23d7bb7fe7d14999ed523711d7fe4fd55faa0e Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 19 Oct 2003 23:17:30 +0000 Subject: [PATCH] Additions. Mon Oct 20 01:12:46 2003 Matthias Clasen * gobject/tmpl/gtype.sgml: * gobject/tmpl/param_value_types.sgml: * gobject/tmpl/value_arrays.sgml: Additions. * gobject/tmpl/gboxed.sgml: * gobject/gobject-sections.txt: Remove prematurely added GStrv documentation. --- docs/reference/ChangeLog | 10 +++ docs/reference/gobject/gobject-sections.txt | 2 - docs/reference/gobject/tmpl/gboxed.sgml | 37 --------- docs/reference/gobject/tmpl/gtype.sgml | 96 ++++++++++++++++------ docs/reference/gobject/tmpl/param_value_types.sgml | 2 +- docs/reference/gobject/tmpl/value_arrays.sgml | 1 + 6 files changed, 85 insertions(+), 63 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 9de9ea7..e3d5e70 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,13 @@ +Mon Oct 20 01:12:46 2003 Matthias Clasen + + * gobject/tmpl/gtype.sgml: + * gobject/tmpl/param_value_types.sgml: + * gobject/tmpl/value_arrays.sgml: Additions. + + * gobject/tmpl/gboxed.sgml: + * gobject/gobject-sections.txt: Remove prematurely added + GStrv documentation. + Sun Oct 19 22:18:28 2003 Matthias Clasen * gobject/Makefile.am (INCLUDES): Add $(top_builddir)/glib diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 9800791..be39794 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -287,8 +287,6 @@ g_pointer_type_register_static G_TYPE_GSTRING -G_TYPE_STRV -GStrv G_TYPE_IS_BOXED diff --git a/docs/reference/gobject/tmpl/gboxed.sgml b/docs/reference/gobject/tmpl/gboxed.sgml index e6b36e9..9a3d974 100644 --- a/docs/reference/gobject/tmpl/gboxed.sgml +++ b/docs/reference/gobject/tmpl/gboxed.sgml @@ -82,40 +82,3 @@ The #GType for #GString. - - -The #GType for a boxed type holding a %NULL-terminated array of strings. - - -The code fragments in the following example show the use of a property of -type #G_TYPE_STRV with g_object_class_install_property(), g_object_set() -and g_object_get(). - - -g_object_class_install_property (object_class, - PROP_AUTHORS, - g_param_spec_boxed ("authors", - _("Authors"), - _("List of authors"), - G_TYPE_STRV, - G_PARAM_READWRITE)); - - -gchar *authors[] = { "Owen", "Tim", NULL }; -g_object_set (obj, "authors", authors, NULL); - - -gchar *writers[]; -g_object_get (obj, "authors", &writers, NULL); -/* do something with writers */ -g_strfreev (writers); - - - - - - - - - - diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml index 5864ee1..9776054 100644 --- a/docs/reference/gobject/tmpl/gtype.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -426,7 +426,10 @@ to serve as a container for values of a type. -Returns the type identifier from a given @instance structure. +Returns the type identifier from a given @instance structure. + + +This macro should only be used in type implementations. @instance: Location of a valid #GTypeInstance structure. @@ -435,6 +438,9 @@ Returns the type identifier from a given @instance structure. Returns the type identifier from a given @class structure. + + +This macro should only be used in type implementations. @g_class: Location of a valid #GTypeClass structure. @@ -443,6 +449,9 @@ Returns the type identifier from a given @class structure. Returns the type identifier from a given @interface structure. + + +This macro should only be used in type implementations. @g_iface: Location of a valid #GTypeInterface structure. @@ -452,6 +461,9 @@ Returns the type identifier from a given @interface structure. Returns the class structure of a given @instance, casted to a specified anchestor type @g_type of the instance. + + +This macro should only be used in type implementations. @instance: Location of the #GTypeInstance structure. @@ -462,6 +474,9 @@ to a specified anchestor type @g_type of the instance. Returns the interface structure for interface @g_type of a given @instance. + + +This macro should only be used in type implementations. @instance: Location of the #GTypeInstance structure. @@ -475,6 +490,9 @@ Gets the private structure for a particular type. The private structure must have been registered in the class_init function with g_type_class_add_private(). + +This macro should only be used in type implementations. + @instance: the instance of a type deriving from @private_type. @g_type: the type identifying which private data to retrieve. @@ -483,65 +501,95 @@ class_init function with g_type_class_add_private(). - +Returns %TRUE if @instance is a valid #GTypeInstance structure, +otherwise emits a warning and returns %FALSE. + + +This macro should only be used in type implementations. -@instance: +@instance: Location of a #GTypeInstance structure. - +Checks that @instance is an instance of the type identified by @g_type +and emits a warning if this is not the case. Returns @instance casted +to a pointer to @c_type. + + +This macro should only be used in type implementations. -@instance: -@g_type: -@c_type: +@instance: Location of a #GTypeInstance structure. +@g_type: The type to be returned. +@c_type: The corresponding C type of @g_type. - +Returns %TRUE if @instance is an instance of the type identified by @g_type. +Otherwise emits a warning and returns %FALSE. + + +This macro should only be used in type implementations. -@instance: -@g_type: +@instance: Location of a #GTypeInstance structure. +@g_type: The type to be checked - +Checks that @g_class is a class structure of the type identified by @g_type +and emits a warning if this is not the case. Returns @g_class casted +to a pointer to @c_type. + + +This macro should only be used in type implementations. -@g_class: -@g_type: -@c_type: +@g_class: Location of a #GTypeClass structure. +@g_type: The type to be returned. +@c_type: The corresponding C type of class structure of @g_type. - +Returns %TRUE if @g_class is a class structure of the type identified by +@g_type. Otherwise emits a warning and returns %FALSE. + + +This macro should only be used in type implementations. -@g_class: -@g_type: +@g_class: Location of a #GTypeClass structure. +@g_type: The type to be checked. - +Returns %TRUE if @value has been initialized to hold values +of a value type. + + +This macro should only be used in type implementations. -@value: +@value: a #GValue - +Returns %TRUE if @value has been initialized to hold values +of type @g_type. + + +This macro should only be used in type implementations. -@value: -@g_type: +@value: a #GValue +@g_type: The type to be checked. @@ -550,6 +598,7 @@ A bit in the type number that's supposed to be left untouched. + Prior to any use of the type system, g_type_init() has to be called to initialize @@ -1327,7 +1376,7 @@ to avoid leaks. @cache_data: data that was given when adding @cache_func -@cache_func: a #GTypeClassCacheFunc +@cache_func: a #GTypeClassCacheFunc @@ -1541,6 +1590,7 @@ The fundamental type for #GObject. + First fundamental type number to create a new fundamental type id with diff --git a/docs/reference/gobject/tmpl/param_value_types.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml index 51a2f56..59613b9 100644 --- a/docs/reference/gobject/tmpl/param_value_types.sgml +++ b/docs/reference/gobject/tmpl/param_value_types.sgml @@ -1062,7 +1062,7 @@ properties. - +A C representable type name for #G_TYPE_STRING. diff --git a/docs/reference/gobject/tmpl/value_arrays.sgml b/docs/reference/gobject/tmpl/value_arrays.sgml index f197867..8b3e08c 100644 --- a/docs/reference/gobject/tmpl/value_arrays.sgml +++ b/docs/reference/gobject/tmpl/value_arrays.sgml @@ -18,6 +18,7 @@ in order for it to be used as a boxed type through %G_TYPE_VALUE_ARRAY. +A #GValueArray contains an array of #GValue elements. @n_values: number of values contained in the array -- 2.7.4