diff options
author | Matthias Clasen <matthiasc@src.gnome.org> | 2005-11-27 20:09:13 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2005-11-27 20:09:13 +0000 |
commit | 9adc9c942d8250262dc76ac2225134fcc744ef20 (patch) | |
tree | b053dccbfbbd2cce50d16bf599e11faf0c6d9ad8 /docs | |
parent | d9d75c48de44c33e3f2a19c8ea5c8db94f395d65 (diff) |
Document GObject API additions
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/gobject/tmpl/gparamspec.sgml | 10 | ||||
-rw-r--r-- | docs/reference/gobject/tmpl/objects.sgml | 56 |
2 files changed, 63 insertions, 3 deletions
diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml index 75399b801..c1b793bad 100644 --- a/docs/reference/gobject/tmpl/gparamspec.sgml +++ b/docs/reference/gobject/tmpl/gparamspec.sgml @@ -205,6 +205,16 @@ not flagged "floating" anymore). @pspec: a valid #GParamSpec +<!-- ##### FUNCTION g_param_spec_ref_sink ##### --> +<para> +Convenience function to ref and sink a #GParamSpec. +</para> + +@pspec: a valid #GParamSpec +@Returns: the #GParamSpec that was passed into this function +@Since: 2.10 + + <!-- ##### FUNCTION g_param_value_set_default ##### --> <para> Sets @value to its default value as specified in @pspec. diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index 81da0dea2..e331dff63 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -6,11 +6,25 @@ The base object type <!-- ##### SECTION Long_Description ##### --> <para> -GObject is the fundamental type providing the common attributes and methods for all object -types in GTK+, Pango and other libraries based on GObject. The GObject class provides methods -for object construction and destruction, property access methods, and signal support. +GObject is the fundamental type providing the common attributes and methods +for all object types in GTK+, Pango and other libraries based on GObject. +The GObject class provides methods for object construction and destruction, +property access methods, and signal support. Signals are described in detail in <xref linkend="gobject-Signals"/>. </para> +<para id="floating-ref"> +The initial reference to a #GObject which is returned by g_object_new() can +optionally be "floating", which means that it is not specifically owned +by the creator of the object. The floating reference can be converted into +an ordinary reference by anyone at any time, by calling g_object_ref_sink(). +If the object is already sunk (has no floating reference), g_object_ref_sink() +returns a new reference. +</para> +<para> +To create #GObject<!-- -->s with a floating reference, call +g_object_force_floating() from the object's init function. +</para> + <!-- ##### SECTION See_Also ##### --> <para> @@ -395,6 +409,42 @@ Increases the reference count of @object. @Returns: @object +<!-- ##### FUNCTION g_object_ref_sink ##### --> +<para> +Increase the reference count of @object, and remove the +<link linkend="floating-ref">floating</link> reference, if @object +has a floating reference. +</para> + +@object: a #GObject +@Returns: @object +@Since: 2.10 + + +<!-- ##### FUNCTION g_object_is_floating ##### --> +<para> +Checks wether @object has a <link linkend="floating-ref">floating</link> +reference. +</para> + +@object: a #GObject +@Returns: %TRUE if @object has a floating reference +@Since: 2.10 + + +<!-- ##### FUNCTION g_object_force_floating ##### --> +<para> +This function is intended for #GObject implementations to mark the +initial reference to the object as +<link linkend="floating-ref">floating</link>. It must only be called +from an object's init function. +</para> + +@object: a #GObject +@Since: 2.10 + + + <!-- ##### FUNCTION g_object_unref ##### --> <para> Decreases the reference count if @object. |