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

Updates

Browse Source
This commit is contained in:
Matthias Clasen 2006-04-24 21:12:52 +00:00
parent 8506d70257
commit 5dd378d2bd
7 changed files with 114 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ChangeLog
View File

@ -1,5 +1,9 @@
2006-04-21 Matthias Clasen <mclasen@redhat.com> 2006-04-21 Matthias Clasen <mclasen@redhat.com>
* gobject/gobject-sections.txt:
* gobject/tmpl/objects.sgml:
* gobject/tmpl/gtype.sgml: Additions
* glib/glib-docs.sgml: * glib/glib-docs.sgml:
* gobject/gobject-docs.sgml: Add 2.12 indices. * gobject/gobject-docs.sgml: Add 2.12 indices.

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

@ -141,6 +141,7 @@ G_TYPE_POINTER
G_TYPE_BOXED G_TYPE_BOXED
G_TYPE_PARAM G_TYPE_PARAM
G_TYPE_OBJECT G_TYPE_OBJECT
G_TYPE_GTYPE
<SUBSECTION> <SUBSECTION>
G_TYPE_RESERVED_GLIB_FIRST G_TYPE_RESERVED_GLIB_FIRST
@ -160,6 +161,7 @@ g_object_type_init
g_param_spec_types_init g_param_spec_types_init
g_value_transforms_init g_value_transforms_init
g_signal_init g_signal_init
g_gtype_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -239,6 +241,9 @@ GParameter
g_object_ref g_object_ref
g_object_unref g_object_unref
g_object_ref_sink g_object_ref_sink
GInitiallyUnowned
GInitiallyUnownedClass
G_TYPE_INITIALLY_UNOWNED
g_object_is_floating g_object_is_floating
g_object_force_floating g_object_force_floating
GWeakNotify GWeakNotify
@ -272,8 +277,18 @@ g_object_get_valist
g_object_watch_closure g_object_watch_closure
g_object_run_dispose g_object_run_dispose
G_OBJECT_WARN_INVALID_PROPERTY_ID G_OBJECT_WARN_INVALID_PROPERTY_ID
<SUBSECTION Standard>
G_INITIALLY_UNOWNED
G_INITIALLY_UNOWNED_CLASS
G_INITIALLY_UNOWNED_GET_CLASS
G_IS_INITIALLY_UNOWNED
G_IS_INITIALLY_UNOWNED_CLASS
<SUBSECTION Private> <SUBSECTION Private>
G_OBJECT_WARN_INVALID_PSPEC G_OBJECT_WARN_INVALID_PSPEC
g_initially_unowned_get_type
g_object_compat_control
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -650,9 +665,12 @@ g_param_spec_override
<SUBSECTION GType> <SUBSECTION GType>
G_IS_PARAM_SPEC_GTYPE G_IS_PARAM_SPEC_GTYPE
G_PARAM_SPEC_GTYPE G_PARAM_SPEC_GTYPE
G_VALUE_HOLDS_GTYPE
G_TYPE_PARAM_GTYPE G_TYPE_PARAM_GTYPE
GParamSpecGType GParamSpecGType
g_param_spec_gtype g_param_spec_gtype
g_value_get_gtype
g_value_set_gtype
<SUBSECTION Private> <SUBSECTION Private>
g_value_set_instance g_value_set_instance

40
docs/reference/gobject/tmpl/gobject-unused.sgml
View File

@ -94,6 +94,46 @@ The predefined identifiers of the reserved fundamental types.
@G_TYPE_PARAM_CLOSURE: @G_TYPE_PARAM_CLOSURE:
@G_TYPE_PARAM_OBJECT: @G_TYPE_PARAM_OBJECT:
<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
<para>
Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
pointer. Depending on the current debugging level, this function may invoke
certain runtime checks to identify invalid casts.
</para>
@object: Object which is subject to casting
<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
<para>
Casts a derived #GInitiallyUnownedClass structure into a
#GInitiallyUnownedClass structure.
</para>
@class: a valid #GInitiallyUnownedClass
<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
<para>
Returns the class structure associated to a #GInitiallyUnowned instance.
</para>
@object: a #GInitiallyUnowned instance
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
<para>
Checks whether a valid #GTypeInstance pointer is of type
%G_TYPE_INITIALLY_UNOWNED.
</para>
@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
<para>
Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
%G_TYPE_INITIALLY_UNOWNED or derived.
</para>
@class: a #GInitiallyUnownedClass
<!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### -->
<para> <para>

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

@ -240,9 +240,9 @@ A structure that provides information to the type system which is
used specifically for managing interface types. used specifically for managing interface types.
</para> </para>
@interface_init: @interface_init: location of the interface initialization function
@interface_finalize: @interface_finalize: location of the interface finalization function
@interface_data: @interface_data: user-supplied data passed to the interface init/finalize functions
<!-- ##### STRUCT GTypeValueTable ##### --> <!-- ##### STRUCT GTypeValueTable ##### -->
<para> <para>
@ -1248,6 +1248,7 @@ struct and calling g_type_info_register_static().
@Returns: The new type identifier. @Returns: The new type identifier.
@Since: 2.12 @Since: 2.12
<!-- ##### FUNCTION g_type_register_dynamic ##### --> <!-- ##### FUNCTION g_type_register_dynamic ##### -->
<para> <para>
Registers @type_name as the name of a new dynamic type derived from Registers @type_name as the name of a new dynamic type derived from
@ -1635,25 +1636,6 @@ init functions.
@Since: 2.4 @Since: 2.4
<!-- ##### FUNCTION g_value_set_gtype ##### -->
<para>
Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.
</para>
@value: a valid #GValue of type %G_TYPE_GTYPE
@v_gtype: #GType to be set
@Since: 2.12
<!-- ##### FUNCTION g_value_get_gtype ##### -->
<para>
Get the contents of a %G_TYPE_GTYPE #GValue.
</para>
@value: a valid #GValue of type %G_TYPE_GTYPE
@Returns: the #GType stored in @value
@Since: 2.12
<!-- ##### MACRO G_TYPE_INVALID ##### --> <!-- ##### MACRO G_TYPE_INVALID ##### -->
<para> <para>
An invalid #GType, used as error return value in some functions which return An invalid #GType, used as error return value in some functions which return

99
docs/reference/gobject/tmpl/objects.sgml
View File

@ -87,8 +87,7 @@ the setter for the property is called to reinstate the previous value.
</para> </para>
@pspec: the #GParamSpec of the property which changed @pspec: the #GParamSpec of the property which changed
@: @:
<!-- # Unused Parameters # -->
@gobject: the object which received the signal. @gobject: the object which received the signal.
<!-- ##### STRUCT GObjectClass ##### --> <!-- ##### STRUCT GObjectClass ##### -->
@ -146,7 +145,6 @@ my_singleton_constructor (GType type,
needed. needed.
@notify: the class closure for the notify signal @notify: the class closure for the notify signal
<!-- ##### STRUCT GObjectConstructParam ##### --> <!-- ##### STRUCT GObjectConstructParam ##### -->
<para> <para>
The <structname>GObjectConstructParam</structname> struct is an auxiliary The <structname>GObjectConstructParam</structname> struct is an auxiliary
@ -446,13 +444,14 @@ Increases the reference count of @object.
</para> </para>
@object: a #GObject @object: a #GObject
@Returns: @object @Returns: the same @object
<!-- ##### FUNCTION g_object_unref ##### --> <!-- ##### FUNCTION g_object_unref ##### -->
<para> <para>
Decreases the reference count if @object. Decreases the reference count of @object.
When its reference count drops to 0, the object is finalized (i.e. its memory is freed). When its reference count drops to 0, the object is finalized
(i.e. its memory is freed).
</para> </para>
@object: a #GObject @object: a #GObject
@ -477,6 +476,27 @@ increasing the reference count by one.
@Since: 2.10 @Since: 2.10
<!-- ##### TYPEDEF GInitiallyUnowned ##### -->
<para>
All the fields in the <structname>GInitiallyUnowned</structname> structure
are private to the #GInitiallyUnowned implementation and should never be
accessed directly.
</para>
<!-- ##### TYPEDEF GInitiallyUnownedClass ##### -->
<para>
The class structure for the <structname>GInitiallyUnowned</structname> type.
</para>
<!-- ##### MACRO G_TYPE_INITIALLY_UNOWNED ##### -->
<para>
The type for #GInitiallyUnowned.
</para>
<!-- ##### FUNCTION g_object_is_floating ##### --> <!-- ##### FUNCTION g_object_is_floating ##### -->
<para> <para>
Checks wether @object has a <link linkend="floating-ref">floating</link> Checks wether @object has a <link linkend="floating-ref">floating</link>
@ -631,6 +651,7 @@ reference count of the object is decreased by one.
@data: data to pass to @notify @data: data to pass to @notify
@Since: 2.8 @Since: 2.8
<!-- ##### FUNCTION g_object_connect ##### --> <!-- ##### FUNCTION g_object_connect ##### -->
<para> <para>
A convenience function to connect multiple signals at once. A convenience function to connect multiple signals at once.
@ -1065,69 +1086,3 @@ properties in set_property() and get_property() implementations.
@pspec: the #GParamSpec of the property @pspec: the #GParamSpec of the property
<!-- ##### TYPEDEF GInitiallyUnowned ##### -->
<para>
All the fields in the <structname>GInitiallyUnowned</structname> structure
are private to the #GInitiallyUnowned implementation and should never be
accessed directly.
</para>
<!-- ##### TYPEDEF GInitiallyUnownedClass ##### -->
<para>
The class structure for the <structname>GInitiallyUnowned</structname> type.
</para>
<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
<para>
Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
pointer. Depending on the current debugging level, this function may invoke
certain runtime checks to identify invalid casts.
</para>
@object: Object which is subject to casting
<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
<para>
Casts a derived #GInitiallyUnownedClass structure into a
#GInitiallyUnownedClass structure.
</para>
@class: a valid #GInitiallyUnownedClass
<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
<para>
Returns the class structure associated to a #GInitiallyUnowned instance.
</para>
@object: a #GInitiallyUnowned instance
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
<para>
Checks whether a valid #GTypeInstance pointer is of type
%G_TYPE_INITIALLY_UNOWNED.
</para>
@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
<para>
Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
%G_TYPE_INITIALLY_UNOWNED or derived.
</para>
@class: a #GInitiallyUnownedClass
<!-- ##### MACRO G_TYPE_INITIALLY_UNOWNED ##### -->
<para>
The type for #GInitiallyUnowned.
</para>

20
docs/reference/gobject/tmpl/param_value_types.sgml
View File

@ -1766,3 +1766,23 @@ See g_param_spec_internal() for details on property names.
@Since: 2.10 @Since: 2.10
<!-- ##### FUNCTION g_value_get_gtype ##### -->
<para>
Get the contents of a %G_TYPE_GTYPE #GValue.
</para>
@value: a valid #GValue of type %G_TYPE_GTYPE
@Returns: the #GType stored in @value
@Since: 2.12
<!-- ##### FUNCTION g_value_set_gtype ##### -->
<para>
Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.
</para>
@value: a valid #GValue of type %G_TYPE_GTYPE
@v_gtype: #GType to be set
@Since: 2.12

2
docs/reference/gobject/tmpl/signals.sgml
View File

@ -256,7 +256,7 @@ be used, but they cannot be mixed.
%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
@class_offset: The offset of the function pointer in the class structure @class_offset: The offset of the function pointer in the class structure
for this type. Used to invoke a class method generically. Pass 0 to for this type. Used to invoke a class method generically. Pass 0 to
not associate a class method with this signal. not associate a class method with this signal.
@accumulator: the accumulator for this signal; may be %NULL. @accumulator: the accumulator for this signal; may be %NULL.
@accu_data: user data for the @accumulator. @accu_data: user data for the @accumulator.
@c_marshaller: the function to translate arrays of parameter values to @c_marshaller: the function to translate arrays of parameter values to