mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-20 15:48:54 +02:00
Document GObject API additions
This commit is contained in:
@@ -205,6 +205,16 @@ not flagged "floating" anymore).
|
|||||||
@pspec: a valid #GParamSpec
|
@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 ##### -->
|
<!-- ##### FUNCTION g_param_value_set_default ##### -->
|
||||||
<para>
|
<para>
|
||||||
Sets @value to its default value as specified in @pspec.
|
Sets @value to its default value as specified in @pspec.
|
||||||
|
@@ -6,11 +6,25 @@ The base object type
|
|||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
GObject is the fundamental type providing the common attributes and methods for all object
|
GObject is the fundamental type providing the common attributes and methods
|
||||||
types in GTK+, Pango and other libraries based on GObject. The GObject class provides methods
|
for all object types in GTK+, Pango and other libraries based on GObject.
|
||||||
for object construction and destruction, property access methods, and signal support.
|
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"/>.
|
Signals are described in detail in <xref linkend="gobject-Signals"/>.
|
||||||
</para>
|
</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 ##### -->
|
<!-- ##### SECTION See_Also ##### -->
|
||||||
<para>
|
<para>
|
||||||
@@ -395,6 +409,42 @@ Increases the reference count of @object.
|
|||||||
@Returns: @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 ##### -->
|
<!-- ##### FUNCTION g_object_unref ##### -->
|
||||||
<para>
|
<para>
|
||||||
Decreases the reference count if @object.
|
Decreases the reference count if @object.
|
||||||
|
@@ -1,3 +1,7 @@
|
|||||||
|
2005-11-27 Matthias Clasen <mclasen@redhat.com>
|
||||||
|
|
||||||
|
* gboxed.h: Declare g_hash_table_get_type.
|
||||||
|
|
||||||
Wed Nov 23 18:01:46 2005 Tim Janik <timj@imendio.com>
|
Wed Nov 23 18:01:46 2005 Tim Janik <timj@imendio.com>
|
||||||
|
|
||||||
* gobject.[hc]: added floating reference count.
|
* gobject.[hc]: added floating reference count.
|
||||||
|
@@ -78,6 +78,7 @@ GType g_value_array_get_type (void) G_GNUC_CONST;
|
|||||||
GType g_date_get_type (void) G_GNUC_CONST;
|
GType g_date_get_type (void) G_GNUC_CONST;
|
||||||
GType g_strv_get_type (void) G_GNUC_CONST;
|
GType g_strv_get_type (void) G_GNUC_CONST;
|
||||||
GType g_gstring_get_type (void) G_GNUC_CONST;
|
GType g_gstring_get_type (void) G_GNUC_CONST;
|
||||||
|
GType g_hash_table_get_type (void) G_GNUC_CONST;
|
||||||
|
|
||||||
typedef gchar** GStrv;
|
typedef gchar** GStrv;
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user