luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-02 07:23:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

added some function documentations.

Browse Source 
Tue Jan  9 03:10:38 2001  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/types.sgml: added some function documentations.

        * gobject/gobject-sections.txt: buncha fixups.
This commit is contained in:
Tim Janik
2001-01-09 02:18:57 +00:00
committed by Tim Janik
parent deb68e1592
commit 05122f2861
13 changed files with 1238 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/gobject/tmpl/enumerations_flags.sgml
View File

@@ -122,14 +122,6 @@ Enumeration and Flag Types
@value:
<!-- ##### MACRO G_IS_VALUE_POINTER ##### -->
<para>
</para>
@value:
<!-- ##### STRUCT GEnumValue ##### -->
<para>

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

@@ -1,3 +1,69 @@
<!-- ##### FUNCTION g_type_conforms_to ##### -->
<para>
</para>
@type:
@iface_type:
@Returns:
<!-- ##### FUNCTION g_object_class_install_param ##### -->
<para>
</para>
@oclass:
@param_id:
@pspec:
<!-- ##### FUNCTION g_param_spec_hash_table_insert ##### -->
<para>
</para>
@hash_table:
@pspec:
@owner_type:
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO G_IS_PARAM_VALUE ##### -->
<para>
</para>
@pspec:
@value:
<!-- ##### FUNCTION g_type_instance_conforms_to ##### -->
<para>
</para>
@instance:
@iface_type:
@Returns:
<!-- ##### FUNCTION g_object_get_param ##### -->
<para>
</para>
@object:
@param_name:
@value:
<!-- ##### USER_FUNCTION GTypePluginRef ##### -->
<para>
</para>
@plugin:
<!-- ##### FUNCTION g_object_set_param ##### -->
<para>
@@ -7,84 +73,16 @@
@param_name:
@value:
<!-- ##### FUNCTION g_param_spec_hash_table_remove ##### -->
<para>
</para>
@hash_table:
@pspec:
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
<para>
</para>
@plugin:
<!-- ##### FUNCTION g_signals_destroy ##### -->
<para>
</para>
@itype:
<!-- ##### FUNCTION g_param_spec_hash_table_new ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Short_Description ##### -->
<!-- ##### STRUCT GTypePluginVTable ##### -->
<para>
</para>
@plugin_ref:
@plugin_unref:
@complete_type_info:
@complete_interface_info:
<!-- ##### FUNCTION g_signal_connect_closure ##### -->
<para>
</para>
@instance:
@signal_id:
@detail:
@closure:
@after:
@Returns:
<!-- ##### FUNCTION g_signal_type_closure_new ##### -->
<para>
</para>
@itype:
@struct_offset:
@Returns:
<!-- ##### MACRO G_WARN_INVALID_PARAM_ID ##### -->
<!-- ##### USER_FUNCTION GObjectGetParamFunc ##### -->
<para>
</para>
@object:
@param_id:
@value:
@pspec:
@trailer:
<!-- ##### ENUM GSignalType ##### -->
<para>
@@ -98,82 +96,48 @@
@G_SIGNAL_ACTION:
@G_SIGNAL_NO_HOOKS:
<!-- ##### FUNCTION g_param_spec_hash_table_insert ##### -->
<para>
</para>
@hash_table:
@pspec:
@owner_type:
<!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
<para>
</para>
@plugin:
@g_type:
@info:
@value_table:
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:See_Also ##### -->
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GTypePluginRef ##### -->
<!-- ##### FUNCTION g_signal_type_closure_new ##### -->
<para>
</para>
@plugin:
<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
<para>
</para>
@instance:
<!-- ##### FUNCTION g_type_instance_conforms_to ##### -->
<para>
</para>
@instance:
@iface_type:
@itype:
@struct_offset:
@Returns:
<!-- ##### USER_FUNCTION GObjectSetParamFunc ##### -->
<!-- ##### FUNCTION g_object_class_find_param_spec ##### -->
<para>
</para>
@oclass:
@param_name:
@Returns:
<!-- ##### FUNCTION g_object_queue_param_changed ##### -->
<para>
</para>
@object:
@param_id:
@value:
@pspec:
@trailer:
@param_name:
<!-- ##### FUNCTION g_type_is_dynamic ##### -->
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Title ##### -->
gtypemodule.sgml
<!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
<para>
</para>
@type:
@flags:
@Returns:
<!-- ##### FUNCTION g_type_value_conforms_to ##### -->
<para>
</para>
@value:
@type:
@Returns:
@plugin:
<!-- ##### FUNCTION g_param_spec_hash_table_lookup ##### -->
<para>
@@ -187,19 +151,7 @@
@trailer:
@Returns:
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Title ##### -->
gtypemodule.sgml
<!-- ##### FUNCTION g_object_queue_param_changed ##### -->
<para>
</para>
@object:
@param_name:
<!-- ##### USER_FUNCTION GObjectGetParamFunc ##### -->
<!-- ##### USER_FUNCTION GObjectSetParamFunc ##### -->
<para>
</para>
@@ -210,47 +162,51 @@ gtypemodule.sgml
@pspec:
@trailer:
<!-- ##### MACRO G_IS_PARAM_VALUE ##### -->
<!-- ##### FUNCTION g_type_value_conforms_to ##### -->
<para>
</para>
@pspec:
@value:
@type:
@Returns:
<!-- ##### FUNCTION g_object_class_install_param ##### -->
<para>
</para>
@oclass:
@param_id:
@pspec:
<!-- ##### MACRO G_NOTIFY_PRIORITY ##### -->
<para>
</para>
<!-- ##### FUNCTION g_object_get_param ##### -->
<para>
</para>
@object:
@param_name:
@value:
<!-- ##### FUNCTION g_type_conforms_to ##### -->
<!-- ##### FUNCTION g_type_is_dynamic ##### -->
<para>
</para>
@type:
@iface_type:
@flags:
@Returns:
<!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
<para>
</para>
@plugin:
@g_type:
@info:
@value_table:
<!-- ##### FUNCTION g_signals_destroy ##### -->
<para>
</para>
@itype:
<!-- ##### STRUCT GTypePluginVTable ##### -->
<para>
</para>
@plugin_ref:
@plugin_unref:
@complete_type_info:
@complete_interface_info:
<!-- ##### USER_FUNCTION GTypePluginFillInterfaceInfo ##### -->
<para>
@@ -261,12 +217,37 @@ gtypemodule.sgml
@instance_type:
@info:
<!-- ##### FUNCTION g_object_class_find_param_spec ##### -->
<!-- ##### MACRO G_NOTIFY_PRIORITY ##### -->
<para>
</para>
<!-- ##### MACRO G_WARN_INVALID_PARAM_ID ##### -->
<para>
</para>
@object:
@param_id:
@pspec:
<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Short_Description ##### -->
<!-- ##### FUNCTION g_param_spec_hash_table_new ##### -->
<para>
</para>
@oclass:
@param_name:
@Returns:
<!-- ##### FUNCTION g_param_spec_hash_table_remove ##### -->
<para>
</para>
@hash_table:
@pspec:

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

@@ -27,6 +27,39 @@ The Base Object Type
</para>
<!-- ##### STRUCT GObjectConstructParam ##### -->
<para>
</para>
@pspec:
@value:
@trailer:
<!-- ##### USER_FUNCTION GObjectGetPropertyFunc ##### -->
<para>
</para>
@object:
@property_id:
@value:
@pspec:
@trailer:
<!-- ##### USER_FUNCTION GObjectSetPropertyFunc ##### -->
<para>
</para>
@object:
@property_id:
@value:
@pspec:
@trailer:
<!-- ##### MACRO G_OBJECT ##### -->
<para>
@@ -123,6 +156,26 @@ The Base Object Type
@object:
<!-- ##### FUNCTION g_object_class_install_property ##### -->
<para>
</para>
@oclass:
@property_id:
@pspec:
<!-- ##### FUNCTION g_object_class_find_property ##### -->
<para>
</para>
@oclass:
@property_name:
@Returns:
<!-- ##### FUNCTION g_object_new ##### -->
<para>
@@ -197,6 +250,51 @@ The Base Object Type
@first_param_name:
<!-- ##### FUNCTION g_object_set_property ##### -->
<para>
</para>
@object:
@property_name:
@value:
<!-- ##### FUNCTION g_object_get_property ##### -->
<para>
</para>
@object:
@property_name:
@value:
<!-- ##### FUNCTION g_object_freeze_notify ##### -->
<para>
</para>
@object:
<!-- ##### FUNCTION g_object_notify ##### -->
<para>
</para>
@object:
@property_name:
<!-- ##### FUNCTION g_object_thaw_notify ##### -->
<para>
</para>
@object:
<!-- ##### FUNCTION g_object_ref ##### -->
<para>
@@ -255,6 +353,47 @@ The Base Object Type
@Returns:
<!-- ##### FUNCTION g_object_get_data ##### -->
<para>
</para>
@object:
@key:
@Returns:
<!-- ##### FUNCTION g_object_set_data ##### -->
<para>
</para>
@object:
@key:
@data:
<!-- ##### FUNCTION g_object_set_data_full ##### -->
<para>
</para>
@object:
@key:
@data:
@destroy:
<!-- ##### FUNCTION g_object_steal_data ##### -->
<para>
</para>
@object:
@key:
@Returns:
<!-- ##### FUNCTION g_value_set_object ##### -->
<para>
@@ -282,3 +421,22 @@ The Base Object Type
@Returns:
<!-- ##### FUNCTION g_object_watch_closure ##### -->
<para>
</para>
@object:
@closure:
<!-- ##### MACRO G_OBJECT_WARN_INVALID_PROPERTY_ID ##### -->
<para>
</para>
@object:
@property_id:
@pspec:

59
docs/reference/gobject/tmpl/param_specs.sgml
View File

@@ -116,6 +116,14 @@ Parameter Specifications
@pspec:
<!-- ##### FUNCTION g_param_spec_sink ##### -->
<para>
</para>
@pspec:
<!-- ##### FUNCTION g_param_spec_get_qdata ##### -->
<para>
@@ -210,3 +218,54 @@ Parameter Specifications
@Returns:
<!-- ##### FUNCTION g_param_spec_pool_new ##### -->
<para>
</para>
@type_prefixing:
@Returns:
<!-- ##### FUNCTION g_param_spec_pool_insert ##### -->
<para>
</para>
@pool:
@pspec:
@owner_type:
<!-- ##### FUNCTION g_param_spec_pool_remove ##### -->
<para>
</para>
@pool:
@pspec:
<!-- ##### FUNCTION g_param_spec_pool_lookup ##### -->
<para>
</para>
@pool:
@param_name:
@owner_type:
@walk_ancestors:
@trailer_p:
@Returns:
<!-- ##### FUNCTION g_param_type_register_static ##### -->
<para>
</para>
@name:
@pspec_info:
@Returns:

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

@@ -103,7 +103,11 @@ value returned by the last callback.
<!-- ##### TYPEDEF GSignalCMarshaller ##### -->
<para>
This is the signature of marshaller functions, required to marshall
arrays of parameter values to signal emissions into C language callback
invocations. It is merely an alias to @GClosureMarshal since the @GClosure
mechanism takes over responsibility of actuall function invocation for the
signal system.
</para>
@@ -124,16 +128,25 @@ value returned by the last callback.
<!-- ##### ENUM GSignalFlags ##### -->
<para>
The signal flags are used to specify a signal's behaviour, the overrall
signal description outlines how especially the RUN flags controll the
stages of a signal emission.
</para>
@G_SIGNAL_RUN_FIRST:
@G_SIGNAL_RUN_LAST:
@G_SIGNAL_RUN_CLEANUP:
@G_SIGNAL_NO_RECURSE:
@G_SIGNAL_DETAILED:
@G_SIGNAL_ACTION:
@G_SIGNAL_NO_HOOKS:
@G_SIGNAL_RUN_FIRST: Invoke the object method handler in the first emission stage.
@G_SIGNAL_RUN_LAST: Invoke the object method handler in the third emission stage.
@G_SIGNAL_RUN_CLEANUP: Invoke the object method handler in the last emission stage.
@G_SIGNAL_NO_RECURSE: Signals being emitted for an object while currently being in
emission for this very object will not be emitted recursively,
but instead cause the first emission to be restarted.
@G_SIGNAL_DETAILED: This signal supports "::detail" appendixes to the signal name
upon hanlder connections and emissions.
@G_SIGNAL_ACTION: Action signals are signals that may freely be emitted on alive
objects from user code via g_signal_emit() and friends, without
the need of being embedded into extra code that performs pre or
post emission adjustments on the object. They can also be thought
of as by third-party code generically callable obejct methods.
@G_SIGNAL_NO_HOOKS: No emissions hooks are supported for this signal.
<!-- ##### ENUM GSignalMatchType ##### -->
<para>
@@ -168,6 +181,23 @@ filled in by the g_signal_query() function.
@gpointer data2);
</programlisting></msgtext>
<!-- ##### FUNCTION g_signal_newc ##### -->
<para>
</para>
@signal_name:
@itype:
@signal_flags:
@class_offset:
@accumulator:
@c_marshaller:
@return_type:
@n_params:
@Varargs:
@Returns:
<!-- ##### FUNCTION g_signal_newv ##### -->
<para>
@@ -185,15 +215,36 @@ filled in by the g_signal_query() function.
@Returns:
<!-- ##### FUNCTION g_signal_emitv ##### -->
<!-- ##### FUNCTION g_signal_new_valist ##### -->
<para>
</para>
@instance_and_params:
@signal_id:
@detail:
@return_value:
@signal_name:
@itype:
@signal_flags:
@class_closure:
@accumulator:
@c_marshaller:
@return_type:
@n_params:
@args:
@Returns:
<!-- ##### FUNCTION g_signal_query ##### -->
<para>
Query the signal system for in-depth information about a
specific signal. This function will fill in a user-provided
structure to hold signal-specific information. If an invalid
dignal id is passed in, the @signal_id member of the @GSignalQuery
is 0. All members filled into the @GSignalQuery structure should
be considered constant and have to be left untouched.
</para>
@signal_id: The signal id of the signal to query information for
@query: A user provided structure that is filled in with constant
values upon success.
<!-- ##### FUNCTION g_signal_lookup ##### -->
@@ -215,21 +266,6 @@ filled in by the g_signal_query() function.
@Returns:
<!-- ##### FUNCTION g_signal_query ##### -->
<para>
Query the signal system for in-depth information about a
specific signal. This function will fill in a user-provided
structure to hold signal-specific information. If an invalid
dignal id is passed in, the @signal_id member of the @GSignalQuery
is 0. All members filled into the @GSignalQuery structure should
be considered constant and have to be left untouched.
</para>
@signal_id: The signal id of the signal to query information for
@query: A user provided structure that is filled in with constant
values upon success.
<!-- ##### FUNCTION g_signal_list_ids ##### -->
<para>
List the signals by id, that a certain instance or interface type
@@ -242,6 +278,93 @@ g_signal_query().
@Returns: Newly allocated array of signal ids
<!-- ##### FUNCTION g_signal_emit ##### -->
<para>
</para>
@instance:
@signal_id:
@detail:
@Varargs:
<!-- ##### FUNCTION g_signal_emit_by_name ##### -->
<para>
</para>
@instance:
@detailed_signal:
@Varargs:
<!-- ##### FUNCTION g_signal_emitv ##### -->
<para>
</para>
@instance_and_params:
@signal_id:
@detail:
@return_value:
<!-- ##### FUNCTION g_signal_emit_valist ##### -->
<para>
</para>
@instance:
@signal_id:
@detail:
@var_args:
<!-- ##### FUNCTION g_signal_connect_data ##### -->
<para>
</para>
@instance:
@detailed_signal:
@c_handler:
@data:
@destroy_data:
@swapped:
@after:
@Returns:
<!-- ##### FUNCTION g_signal_connect_object ##### -->
<para>
</para>
@instance:
@detailed_signal:
@c_handler:
@gobject:
@swapped:
@after:
@Returns:
<!-- ##### FUNCTION g_signal_connect_closure ##### -->
<para>
</para>
@instance:
@detailed_signal:
@closure:
@after:
@Returns:
<!-- # Unused Parameters # -->
@signal_id:
@detail:
<!-- ##### FUNCTION g_signal_connect_closure_by_id ##### -->
<para>
@@ -452,3 +575,21 @@ and @detail quark.
@signal_id_p and @detail_p contain valid return values.
<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
<para>
</para>
@instance:
<!-- ##### FUNCTION g_signal_type_cclosure_new ##### -->
<para>
</para>
@itype:
@struct_offset:
@Returns:

142
docs/reference/gobject/tmpl/standard_params.sgml
View File

@@ -206,6 +206,70 @@ Standard Parameter Types
@pspec:
<!-- ##### MACRO G_IS_PARAM_SPEC_POINTER ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_PARAM_SPEC_POINTER ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_PARAM_SPEC_BOXED ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_IS_PARAM_SPEC_CCALLBACK ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_PARAM_SPEC_CCALLBACK ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
<para>
@@ -343,6 +407,34 @@ Standard Parameter Types
@null_fold_if_empty:
@ensure_non_null:
<!-- ##### STRUCT GParamSpecBoxed ##### -->
<para>
</para>
@parent_instance:
<!-- ##### STRUCT GParamSpecCCallback ##### -->
<para>
</para>
@parent_instance:
<!-- ##### STRUCT GParamSpecParam ##### -->
<para>
</para>
@parent_instance:
<!-- ##### STRUCT GParamSpecPointer ##### -->
<para>
</para>
@parent_instance:
<!-- ##### STRUCT GParamSpecObject ##### -->
<para>
@@ -537,6 +629,56 @@ Standard Parameter Types
@Returns:
<!-- ##### FUNCTION g_param_spec_boxed ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@boxed_type:
@flags:
@Returns:
<!-- ##### FUNCTION g_param_spec_ccallback ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@flags:
@Returns:
<!-- ##### FUNCTION g_param_spec_param ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@param_type:
@flags:
@Returns:
<!-- ##### FUNCTION g_param_spec_pointer ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@flags:
@Returns:
<!-- ##### FUNCTION g_param_spec_object ##### -->
<para>

424
docs/reference/gobject/tmpl/types.sgml
View File

@@ -59,6 +59,78 @@ GType
<!-- ##### MACRO G_TYPE_IS_ABSTRACT ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_DERIVED ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_FUNDAMENTAL ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_VALUE_TYPE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_CLASSED ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_INSTANTIATABLE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_DERIVABLE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_DEEP_DERIVABLE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_INTERFACE ##### -->
<para>
</para>
@type:
<!-- ##### ENUM GTypeFundamentals ##### -->
<para>
@@ -109,46 +181,6 @@ GType
@G_TYPE_PARAM_BOXED:
@G_TYPE_PARAM_OBJECT:
<!-- ##### MACRO G_TYPE_IS_CLASSED ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_INSTANTIATABLE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_DERIVABLE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_DEEP_DERIVABLE ##### -->
<para>
</para>
@type:
<!-- ##### MACRO G_TYPE_IS_INTERFACE ##### -->
<para>
</para>
@type:
<!-- ##### STRUCT GTypeInterface ##### -->
<para>
@@ -207,54 +239,6 @@ GType
@lcopy_type:
@lcopy_value:
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
<para>
</para>
@instance:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
<para>
</para>
@g_class:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
<para>
</para>
@instance:
@g_type:
<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
<para>
</para>
@g_class:
@g_type:
<!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
<para>
</para>
@instance:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_FROM_INSTANCE ##### -->
<para>
@@ -279,67 +263,160 @@ GType
@g_iface:
<!-- ##### FUNCTION g_type_init ##### -->
<!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
<para>
</para>
@instance:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_INSTANCE_GET_INTERFACE ##### -->
<para>
</para>
@instance:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE ##### -->
<para>
</para>
@instance:
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
<para>
</para>
@instance:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
<para>
</para>
@instance:
@g_type:
<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
<para>
</para>
@g_class:
@g_type:
@c_type:
<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
<para>
</para>
@g_class:
@g_type:
<!-- ##### MACRO G_TYPE_CHECK_VALUE ##### -->
<para>
</para>
@value:
<!-- ##### MACRO G_TYPE_CHECK_VALUE_TYPE ##### -->
<para>
</para>
@value:
@g_type:
<!-- ##### FUNCTION g_type_init ##### -->
<para>
Prior to any use of the type system, g_type_init() has to be called to initialize
the type system and assorted other code portions (such as the various fundamental
type implementations or the signal system).
</para>
<!-- ##### FUNCTION g_type_name ##### -->
<para>
Return the unique name that is assigned to a type ID (this is the preferred method
to find out whether a specific type has been registered for the passed in ID yet).
</para>
@type:
@Returns:
@type: Type to return name for.
@Returns: Static type name or NULL.
<!-- ##### FUNCTION g_type_qname ##### -->
<para>
Return the corresponding quark of the type IDs name.
</para>
@type:
@Returns:
@type: Type to return quark of type name for.
@Returns: The type names quark or 0.
<!-- ##### FUNCTION g_type_from_name ##### -->
<para>
Lookup the type ID from a given type name, returns 0 if no type has been registered under this name
(this is the preferred method to find out by name whether a specific type has been registered yet).
</para>
@name:
@Returns:
@name: Type name to lookup.
@Returns: Corresponding type ID or 0.
<!-- ##### FUNCTION g_type_parent ##### -->
<para>
Return the direct parent type of the passed in type.
If the passed in type has no parent, i.e. is a fundamental type, 0 is returned.
</para>
@type:
@Returns:
@type: The derived type.
@Returns: The parent type.
<!-- ##### FUNCTION g_type_next_base ##### -->
<para>
Given a @type and a @base_type which is contained in its anchestry, return
the type that @base_type is the direct parent type for.
In other words, for a given type branch, e.g. Root-Derived1-Derived2-Leaf, specified
through @type=Leaf, return the nextmost child of @base_type. In this example, for
@base_type=Derived1, the returned value would be Derived2, for @base_type=Root, the
returned value would be Derived1.
</para>
@type:
@base_type:
@Returns:
@type: Descendant of @base_type and the type to be returned.
@base_type: Direct parent of the returned type.
@Returns: Immediate child of @base_type and anchestor of @type.
<!-- ##### FUNCTION g_type_is_a ##### -->
<para>
Check whether @type is a descendant of @is_a_type.
</para>
@type:
@is_a_type:
@Returns:
@type: Type to check anchestry for.
@is_a_type: Possible anchestor of @type.
@Returns: %TRUE if @type is_a @is_a_type holds true.
<!-- ##### FUNCTION g_type_fundamental_branch_last ##### -->
@@ -398,22 +475,25 @@ GType
<!-- ##### FUNCTION g_type_children ##### -->
<para>
Return a newly allocated and 0 terminated array of type IDs, listing the
child types of @type. The return value has to be g_free()ed after use.
</para>
@type:
@n_children:
@Returns:
@type: The parent type.
@n_children: Optional #guint pointer to contain the number of child types.
@Returns: Newly allocated and 0 terminated array of child types.
<!-- ##### FUNCTION g_type_interfaces ##### -->
<para>
Return a newly allocated and 0 terminated array of type IDs, listing the
interface types that @type conforms to. The return value has to be
g_free()ed after use.
</para>
@type:
@n_interfaces:
@Returns:
@type: The type to list interface types for.
@n_interfaces: Optional #guint pointer to contain the number of interface types.
@Returns: Newly allocated and 0 terminated array of interface types.
<!-- ##### FUNCTION g_type_set_qdata ##### -->
@@ -514,6 +594,16 @@ GType
@G_TYPE_FLAG_ABSTRACT:
<!-- ##### ENUM GTypeFundamentalFlags ##### -->
<para>
</para>
@G_TYPE_FLAG_CLASSED:
@G_TYPE_FLAG_INSTANTIATABLE:
@G_TYPE_FLAG_DERIVABLE:
@G_TYPE_FLAG_DEEP_DERIVABLE:
<!-- ##### FUNCTION g_type_register_static ##### -->
<para>
@@ -571,33 +661,30 @@ GType
@plugin:
<!-- ##### FUNCTION g_type_class_is_a ##### -->
<!-- ##### FUNCTION g_type_get_plugin ##### -->
<para>
</para>
@g_class:
@is_a_type:
@type:
@Returns:
<!-- ##### FUNCTION g_type_check_class_cast ##### -->
<!-- ##### FUNCTION g_type_interface_get_plugin ##### -->
<para>
</para>
@g_class:
@is_a_type:
@instance_type:
@implementation_type:
@Returns:
<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
<!-- ##### FUNCTION g_type_fundamental_last ##### -->
<para>
</para>
@instance:
@iface_type:
@Returns:
@@ -628,15 +715,6 @@ GType
@instance:
<!-- ##### FUNCTION g_type_value_table_peek ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION g_type_add_class_cache_func ##### -->
<para>
@@ -663,23 +741,6 @@ GType
@g_class:
<!-- ##### FUNCTION g_type_get_plugin ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION g_type_fundamental_last ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_type_check_instance ##### -->
<para>
@@ -689,6 +750,46 @@ GType
@Returns:
<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
<para>
</para>
@instance:
@iface_type:
@Returns:
<!-- ##### FUNCTION g_type_instance_is_a ##### -->
<para>
</para>
@instance:
@iface_type:
@Returns:
<!-- ##### FUNCTION g_type_check_class_cast ##### -->
<para>
</para>
@g_class:
@is_a_type:
@Returns:
<!-- ##### FUNCTION g_type_class_is_a ##### -->
<para>
</para>
@g_class:
@is_a_type:
@Returns:
<!-- ##### FUNCTION g_type_check_value ##### -->
<para>
@@ -698,3 +799,22 @@ GType
@Returns:
<!-- ##### FUNCTION g_type_value_is_a ##### -->
<para>
</para>
@value:
@type:
@Returns:
<!-- ##### FUNCTION g_type_value_table_peek ##### -->
<para>
</para>
@type:
@Returns:

107
docs/reference/gobject/tmpl/value_types.sgml
View File

@@ -94,6 +94,30 @@ Standard value types
@value:
<!-- ##### MACRO G_IS_VALUE_POINTER ##### -->
<para>
</para>
@value:
<!-- ##### MACRO G_IS_VALUE_CCALLBACK ##### -->
<para>
</para>
@value:
<!-- ##### MACRO G_IS_VALUE_PARAM ##### -->
<para>
</para>
@value:
<!-- ##### FUNCTION g_value_set_char ##### -->
<para>
@@ -265,6 +289,15 @@ Standard value types
@v_string:
<!-- ##### FUNCTION g_value_set_static_string ##### -->
<para>
</para>
@value:
@v_string:
<!-- ##### FUNCTION g_value_get_string ##### -->
<para>
@@ -283,3 +316,77 @@ Standard value types
@Returns:
<!-- ##### FUNCTION g_value_set_param ##### -->
<para>
</para>
@value:
@param:
<!-- ##### FUNCTION g_value_get_param ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION g_value_dup_param ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION g_value_get_ccallback ##### -->
<para>
</para>
@value:
@callback_func:
@callback_data:
<!-- ##### FUNCTION g_value_get_pointer ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION g_value_set_pointer ##### -->
<para>
</para>
@value:
@v_pointer:
<!-- ##### FUNCTION g_value_set_ccallback ##### -->
<para>
</para>
@value:
@callback_func:
@callback_data:
<!-- ##### FUNCTION g_value_set_instance ##### -->
<para>
</para>
@value:
@instance: