diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 35ea80363..d1f8f66fa 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Sat Oct 25 01:07:45 2003 Matthias Clasen + + * gobject/tmpl/gparamspec.sgml: + * gobject/tmpl/objects.sgml: Additions. + Thu Oct 23 14:27:54 2003 Owen Taylor * gobject/Makefile.am: Add a dist-hook so that the diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml index e6d5a1031..84641c8e8 100644 --- a/docs/reference/gobject/tmpl/gparamspec.sgml +++ b/docs/reference/gobject/tmpl/gparamspec.sgml @@ -93,7 +93,8 @@ Retrieves the #GType to initialize a #GValue for this parameter. - +All fields of the GParamSpec struct are private and +should not be used directly, except for the following: @g_type_instance: private #GTypeInstance portion @@ -104,16 +105,23 @@ Retrieves the #GType to initialize a #GValue for this parameter. - +The class structure for the GParamSpec type. +Normally, GParamSpec classes are filled by +g_param_type_register_static(). -@g_type_class: -@value_type: -@finalize: -@value_set_default: -@value_validate: -@values_cmp: -@dummy: +@g_type_class: the parent class +@value_type: the #GValue type for this parameter +@finalize: The instance finalization function (optional), should chain + up to the finalize method of the parent class. +@value_set_default: Resets a @value to the default value for this type + (recommended, the default is g_value_reset()), see + g_param_value_set_default(). +@value_validate: Ensures that the contents of @value comply with the + specifications set out by this type (optional), see + g_param_value_set_validate(). +@values_cmp: Compares @value1 with @value2 according to this type + (recommended, the default is memcmp()), see g_param_values_cmp(). diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index 800b9514a..083ba009c 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -34,17 +34,33 @@ the setter for the property is called to reinstate the previous value. - +The class structure for the GObject type. -@g_type_class: -@constructor: -@set_property: -@get_property: -@dispose: -@finalize: -@dispatch_properties_changed: -@notify: +@g_type_class: the parent class +@constructor: the @constructor function is called by g_object_new () to + complete the object initialization after all the construction properties are + set. The first thing a @constructor implementation must do is chain up to the + @constructor of the parent class. Overriding @constructor should be rarely + needed. +@set_property: the generic setter for all properties of this type. Should be + overridden for every type with properties. Implementations of @set_property + don't need to emit property change notification explicitly, this is handled + by the type system. +@get_property: the generic getter for all properties of this type. Should be + overridden for every type with properties. +@dispose: the @dispose function is supposed to drop all references to other + objects, but keep the instance otherwise intact, so that client method + invocations still work. It may be run multiple times (due to reference + loops). Before returning, @dispose should chain up to the @dispose method + of the parent class. +@finalize: instance finalization function, should finish the finalization of + the instance begun in @dispose and chain up to the @finalize method of the + parent class. +@dispatch_properties_changed: emits property change notification for a bunch + of properties. Overriding @dispatch_properties_changed should be rarely + needed. +@notify: the class closure for the notify signal diff --git a/gobject/gparam.h b/gobject/gparam.h index f86ebdd38..9cd33e123 100644 --- a/gobject/gparam.h +++ b/gobject/gparam.h @@ -98,6 +98,7 @@ struct _GParamSpecClass gint (*values_cmp) (GParamSpec *pspec, const GValue *value1, const GValue *value2); + /*< private >*/ gpointer dummy[4]; }; struct _GParameter /* auxillary structure for _setv() variants */