+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.
+
Fri Jan 5 15:47:10 2001 Owen Taylor <otaylor@redhat.com>
* glib/glib-sections.txt glib/tmpl/* glib/Makefile.am: Updated.
-<!-- ##### FUNCTION g_mem_check ##### -->
-<para>
-Checks if the given memory has already been freed. If it has it outputs
-a warning message.
-To use this function you must configure glib with the flag
-'--enable-mem-check=yes' before compiling.
-</para>
-
-@mem: the memory to check.
-
-<!-- ##### FUNCTION g_main_remove_poll ##### -->
-<para>
-Removes a file descriptor from the list being polled.
-</para>
-
-@fd: the #GPollFD to remove.
-
-<!-- ##### FUNCTION g_source_connect ##### -->
+<!-- ##### FUNCTION g_source_connect_indirect ##### -->
<para>
</para>
@source:
-@func:
-@data:
-@notify:
-
-<!-- ##### MACRO lseek ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION g_main_loop_destroy ##### -->
-<para>
-
-</para>
-
-@loop:
+@callback_data:
+@callback_funcs:
-<!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
+<!-- ##### MACRO popen ##### -->
<para>
</para>
-@s1:
-@s2:
-@Returns:
-<!-- ##### FUNCTION g_convert_error_quark ##### -->
+<!-- ##### FUNCTION g_mem_check ##### -->
<para>
-
+Checks if the given memory has already been freed. If it has it outputs
+a warning message.
+To use this function you must configure glib with the flag
+'--enable-mem-check=yes' before compiling.
</para>
-@Returns:
+@mem: the memory to check.
-<!-- ##### MACRO write ##### -->
+<!-- ##### MACRO pclose ##### -->
<para>
</para>
See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
#G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
-<!-- ##### MACRO pclose ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION g_source_connect_indirect ##### -->
-<para>
-
-</para>
-
-@source:
-@callback_data:
-@callback_funcs:
-
-<!-- ##### MACRO g_string ##### -->
-<para>
-Turns the argument into a string literal by using the '#' stringizing operator.
-</para>
-
-@x: text to convert to a literal string.
-
-<!-- ##### MACRO popen ##### -->
+<!-- ##### MACRO lseek ##### -->
<para>
</para>
-<!-- ##### MACRO access ##### -->
+<!-- ##### MACRO getpid ##### -->
<para>
</para>
type of source.
@Returns: TRUE if an event source was found and removed.
-<!-- ##### MACRO open ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO getpid ##### -->
+<!-- ##### MACRO close ##### -->
<para>
</para>
</para>
-<!-- ##### MACRO close ##### -->
+<!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
+<para>
+
+</para>
+
+@s1:
+@s2:
+@Returns:
+
+<!-- ##### FUNCTION g_source_connect ##### -->
<para>
</para>
+@source:
+@func:
+@data:
+@notify:
<!-- ##### MACRO getcwd ##### -->
<para>
</para>
-<!-- ##### MACRO read ##### -->
+<!-- ##### MACRO write ##### -->
<para>
</para>
+<!-- ##### FUNCTION g_main_remove_poll ##### -->
+<para>
+Removes a file descriptor from the list being polled.
+</para>
+
+@fd: the #GPollFD to remove.
+
+<!-- ##### MACRO access ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO g_string ##### -->
+<para>
+Turns the argument into a string literal by using the '#' stringizing operator.
+</para>
+
+@x: text to convert to a literal string.
+
<!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
<para>
@Returns:
+<!-- ##### MACRO read ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION g_main_loop_destroy ##### -->
+<para>
+
+</para>
+
+@loop:
+
+<!-- ##### FUNCTION g_convert_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### MACRO open ##### -->
+<para>
+
+</para>
+
+
Portable way to copy <type>va_list</type> variables.
</para>
+<!-- # Unused Parameters # -->
@ap1: the <type>va_list</type> variable to place a copy of @ap2 in.
@ap2: a <type>va_list</type>.
G_TYPE_DERIVE_ID
G_TYPE_BRANCH_SEQNO
G_TYPE_FUNDAMENTAL_LAST
-GTypeFundamentals
+G_TYPE_IS_ABSTRACT
+G_TYPE_IS_DERIVED
+G_TYPE_IS_FUNDAMENTAL
+G_TYPE_IS_VALUE_TYPE
G_TYPE_IS_CLASSED
G_TYPE_IS_INSTANTIATABLE
G_TYPE_IS_DERIVABLE
G_TYPE_IS_DEEP_DERIVABLE
G_TYPE_IS_INTERFACE
+GTypeFundamentals
GTypeInterface
GTypeInstance
GTypeInfo
GTypeFundamentalInfo
GInterfaceInfo
GTypeValueTable
+
<TITLE>GType</TITLE>
-G_TYPE_CHECK_INSTANCE_CAST
-G_TYPE_CHECK_CLASS_CAST
-G_TYPE_CHECK_INSTANCE_TYPE
-G_TYPE_CHECK_CLASS_TYPE
-G_TYPE_INSTANCE_GET_CLASS
G_TYPE_FROM_INSTANCE
G_TYPE_FROM_CLASS
G_TYPE_FROM_INTERFACE
+G_TYPE_INSTANCE_GET_CLASS
+G_TYPE_INSTANCE_GET_INTERFACE
+G_TYPE_CHECK_INSTANCE
+G_TYPE_CHECK_INSTANCE_CAST
+G_TYPE_CHECK_INSTANCE_TYPE
+G_TYPE_CHECK_CLASS_CAST
+G_TYPE_CHECK_CLASS_TYPE
+G_TYPE_CHECK_VALUE
+G_TYPE_CHECK_VALUE_TYPE
g_type_init
g_type_name
g_type_qname
g_type_parent
g_type_next_base
g_type_is_a
-g_type_conforms_to
g_type_fundamental_branch_last
g_type_class_ref
g_type_class_peek
GInterfaceFinalizeFunc
GTypeClassCacheFunc
GTypeFlags
+GTypeFundamentalFlags
g_type_register_static
g_type_register_dynamic
g_type_register_fundamental
g_type_add_interface_static
g_type_add_interface_dynamic
-g_type_class_is_a
-g_type_check_class_cast
-g_type_check_instance_cast
-g_type_instance_conforms_to
+g_type_get_plugin
+g_type_interface_get_plugin
+g_type_fundamental_last
g_type_check_flags
g_type_create_instance
g_type_free_instance
-g_type_value_table_peek
g_type_add_class_cache_func
g_type_remove_class_cache_func
g_type_class_unref_uncached
-g_type_get_plugin
-g_type_fundamental_last
g_type_check_instance
+g_type_check_instance_cast
+g_type_instance_is_a
+g_type_check_class_cast
+g_type_class_is_a
g_type_check_value
-g_type_value_conforms_to
+g_type_value_is_a
+g_type_value_table_peek
<SUBSECTION Private>
-g_log_domain_gobject
</SECTION>
<SECTION>
<FILE>objects</FILE>
GObject
GObjectClass
+GObjectConstructParam
+GObjectGetPropertyFunc
+GObjectSetPropertyFunc
G_OBJECT
G_OBJECT_GET_CLASS
G_OBJECT_TYPE
G_IS_OBJECT
G_OBJECT_CLASS
G_IS_OBJECT_CLASS
-G_NOTIFY_PRIORITY
-GObjectGetParamFunc
-GObjectSetParamFunc
GObjectFinalizeFunc
-g_object_class_install_param
-g_object_class_find_param_spec
+g_object_class_install_property
+g_object_class_find_property
g_object_new
g_object_new_valist
g_object_set
g_object_get
g_object_set_valist
g_object_get_valist
-g_object_set_param
-g_object_get_param
-g_object_queue_param_changed
+g_object_set_property
+g_object_get_property
+g_object_freeze_notify
+g_object_notify
+g_object_thaw_notify
g_object_ref
g_object_unref
g_object_get_qdata
g_object_set_qdata
g_object_set_qdata_full
g_object_steal_qdata
+g_object_get_data
+g_object_set_data
+g_object_set_data_full
+g_object_steal_data
g_value_set_object
g_value_get_object
g_value_dup_object
-G_WARN_INVALID_PARAM_ID
+g_object_watch_closure
+G_OBJECT_WARN_INVALID_PROPERTY_ID
</SECTION>
<SECTION>
G_FLAGS_CLASS_TYPE_NAME
G_IS_VALUE_ENUM
G_IS_VALUE_FLAGS
-G_IS_VALUE_POINTER
GEnumValue
GFlagsValue
g_enum_get_value
G_IS_VALUE_FLOAT
G_IS_VALUE_DOUBLE
G_IS_VALUE_STRING
+G_IS_VALUE_POINTER
+G_IS_VALUE_CCALLBACK
+G_IS_VALUE_PARAM
g_value_set_char
g_value_get_char
g_value_set_uchar
g_value_set_double
g_value_get_double
g_value_set_string
+g_value_set_static_string
g_value_get_string
g_value_dup_string
+g_value_set_param
+g_value_get_param
+g_value_dup_param
+g_value_get_ccallback
+g_value_get_pointer
+g_value_set_pointer
+g_value_set_ccallback
+g_value_set_instance
</SECTION>
<SECTION>
G_PARAM_SPEC
G_IS_PARAM_SPEC
G_PARAM_SPEC_GET_CLASS
-G_IS_PARAM_VALUE
G_PARAM_SPEC_VALUE_TYPE
G_TYPE_IS_PARAM
GParamFlags
g_param_spec_ref
g_param_spec_unref
+g_param_spec_sink
g_param_spec_get_qdata
g_param_spec_set_qdata
g_param_spec_set_qdata_full
g_param_value_validate
g_param_values_cmp
g_param_spec_internal
-g_param_spec_hash_table_new
-g_param_spec_hash_table_insert
-g_param_spec_hash_table_remove
-g_param_spec_hash_table_lookup
+g_param_spec_pool_new
+g_param_spec_pool_insert
+g_param_spec_pool_remove
+g_param_spec_pool_lookup
+g_param_type_register_static
</SECTION>
<SECTION>
G_PARAM_SPEC_DOUBLE
G_IS_PARAM_SPEC_STRING
G_PARAM_SPEC_STRING
+G_IS_PARAM_SPEC_POINTER
+G_PARAM_SPEC_POINTER
+G_IS_PARAM_SPEC_BOXED
+G_PARAM_SPEC_BOXED
+G_IS_PARAM_SPEC_CCALLBACK
+G_PARAM_SPEC_CCALLBACK
+G_IS_PARAM_SPEC_PARAM
+G_PARAM_SPEC_PARAM
G_IS_PARAM_SPEC_OBJECT
G_PARAM_SPEC_OBJECT
GParamSpecChar
GParamSpecFloat
GParamSpecDouble
GParamSpecString
+GParamSpecBoxed
+GParamSpecCCallback
+GParamSpecParam
+GParamSpecPointer
GParamSpecObject
g_param_spec_char
g_param_spec_uchar
g_param_spec_double
g_param_spec_string
g_param_spec_string_c
+g_param_spec_boxed
+g_param_spec_ccallback
+g_param_spec_param
+g_param_spec_pointer
g_param_spec_object
</SECTION>
GSignalFlags
GSignalMatchType
GSignalQuery
+g_signal_newc
g_signal_newv
-g_signal_emitv
+g_signal_new_valist
+g_signal_query
g_signal_lookup
g_signal_name
-g_signal_query
g_signal_list_ids
+g_signal_emit
+g_signal_emit_by_name
+g_signal_emitv
+g_signal_emit_valist
+g_signal_connect_data
+g_signal_connect_object
+g_signal_connect_closure
g_signal_connect_closure_by_id
g_signal_handler_block
g_signal_handler_unblock
g_signal_handlers_disconnect_matched
g_signal_has_handler_pending
g_signal_stop_emission
-g_signal_type_closure_new
g_signal_add_emission_hook_full
g_signal_remove_emission_hook
g_signal_parse_name
+g_signal_handlers_destroy
+g_signal_type_cclosure_new
</SECTION>
<SECTION>
@value:
-<!-- ##### MACRO G_IS_VALUE_POINTER ##### -->
-<para>
-
-</para>
-
-@value:
-
-
<!-- ##### STRUCT GEnumValue ##### -->
<para>
-<!-- ##### FUNCTION g_object_set_param ##### -->
+<!-- ##### FUNCTION g_type_conforms_to ##### -->
<para>
</para>
-@object:
-@param_name:
-@value:
+@type:
+@iface_type:
+@Returns:
-<!-- ##### FUNCTION g_param_spec_hash_table_remove ##### -->
+<!-- ##### FUNCTION g_object_class_install_param ##### -->
<para>
</para>
-@hash_table:
+@oclass:
+@param_id:
@pspec:
-<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Long_Description ##### -->
+<!-- ##### FUNCTION g_param_spec_hash_table_insert ##### -->
<para>
</para>
+@hash_table:
+@pspec:
+@owner_type:
-<!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:See_Also ##### -->
<para>
</para>
-@plugin:
-<!-- ##### FUNCTION g_signals_destroy ##### -->
+<!-- ##### MACRO G_IS_PARAM_VALUE ##### -->
<para>
</para>
-@itype:
+@pspec:
+@value:
-<!-- ##### FUNCTION g_param_spec_hash_table_new ##### -->
+<!-- ##### FUNCTION g_type_instance_conforms_to ##### -->
<para>
</para>
+@instance:
+@iface_type:
@Returns:
-<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### STRUCT GTypePluginVTable ##### -->
+<!-- ##### FUNCTION g_object_get_param ##### -->
<para>
</para>
-@plugin_ref:
-@plugin_unref:
-@complete_type_info:
-@complete_interface_info:
+@object:
+@param_name:
+@value:
-<!-- ##### FUNCTION g_signal_connect_closure ##### -->
+<!-- ##### USER_FUNCTION GTypePluginRef ##### -->
<para>
</para>
-@instance:
-@signal_id:
-@detail:
-@closure:
-@after:
-@Returns:
+@plugin:
-<!-- ##### FUNCTION g_signal_type_closure_new ##### -->
+<!-- ##### FUNCTION g_object_set_param ##### -->
<para>
</para>
-@itype:
-@struct_offset:
-@Returns:
+@object:
+@param_name:
+@value:
-<!-- ##### MACRO G_WARN_INVALID_PARAM_ID ##### -->
+<!-- ##### USER_FUNCTION GObjectGetParamFunc ##### -->
<para>
</para>
@object:
@param_id:
+@value:
@pspec:
+@trailer:
<!-- ##### ENUM GSignalType ##### -->
<para>
@G_SIGNAL_ACTION:
@G_SIGNAL_NO_HOOKS:
-<!-- ##### FUNCTION g_param_spec_hash_table_insert ##### -->
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Long_Description ##### -->
<para>
</para>
-@hash_table:
-@pspec:
-@owner_type:
-<!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
+<!-- ##### FUNCTION g_signal_type_closure_new ##### -->
<para>
</para>
-@plugin:
-@g_type:
-@info:
-@value_table:
+@itype:
+@struct_offset:
+@Returns:
-<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:See_Also ##### -->
+<!-- ##### FUNCTION g_object_class_find_param_spec ##### -->
<para>
</para>
+@oclass:
+@param_name:
+@Returns:
-<!-- ##### USER_FUNCTION GTypePluginRef ##### -->
+<!-- ##### FUNCTION g_object_queue_param_changed ##### -->
<para>
</para>
-@plugin:
+@object:
+@param_name:
+
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Title ##### -->
+gtypemodule.sgml
-<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
+
+<!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
<para>
</para>
-@instance:
+@plugin:
-<!-- ##### FUNCTION g_type_instance_conforms_to ##### -->
+<!-- ##### FUNCTION g_param_spec_hash_table_lookup ##### -->
<para>
</para>
-@instance:
-@iface_type:
+@hash_table:
+@param_name:
+@owner_type:
+@try_ancestors:
+@trailer:
@Returns:
<!-- ##### USER_FUNCTION GObjectSetParamFunc ##### -->
@pspec:
@trailer:
-<!-- ##### FUNCTION g_type_is_dynamic ##### -->
-<para>
-
-</para>
-
-@type:
-@flags:
-@Returns:
-
<!-- ##### FUNCTION g_type_value_conforms_to ##### -->
<para>
@type:
@Returns:
-<!-- ##### FUNCTION g_param_spec_hash_table_lookup ##### -->
+<!-- ##### FUNCTION g_type_is_dynamic ##### -->
<para>
</para>
-@hash_table:
-@param_name:
-@owner_type:
-@try_ancestors:
-@trailer:
+@type:
+@flags:
@Returns:
-<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Title ##### -->
-gtypemodule.sgml
-
-
-<!-- ##### FUNCTION g_object_queue_param_changed ##### -->
+<!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
<para>
</para>
-@object:
-@param_name:
+@plugin:
+@g_type:
+@info:
+@value_table:
-<!-- ##### USER_FUNCTION GObjectGetParamFunc ##### -->
+<!-- ##### FUNCTION g_signals_destroy ##### -->
<para>
</para>
-@object:
-@param_id:
-@value:
-@pspec:
-@trailer:
+@itype:
-<!-- ##### MACRO G_IS_PARAM_VALUE ##### -->
+<!-- ##### STRUCT GTypePluginVTable ##### -->
<para>
</para>
-@pspec:
-@value:
+@plugin_ref:
+@plugin_unref:
+@complete_type_info:
+@complete_interface_info:
-<!-- ##### FUNCTION g_object_class_install_param ##### -->
+<!-- ##### USER_FUNCTION GTypePluginFillInterfaceInfo ##### -->
<para>
</para>
-@oclass:
-@param_id:
-@pspec:
+@plugin:
+@interface_type:
+@instance_type:
+@info:
<!-- ##### MACRO G_NOTIFY_PRIORITY ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_object_get_param ##### -->
+<!-- ##### MACRO G_WARN_INVALID_PARAM_ID ##### -->
<para>
</para>
@object:
-@param_name:
-@value:
+@param_id:
+@pspec:
-<!-- ##### FUNCTION g_type_conforms_to ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Short_Description ##### -->
-</para>
-@type:
-@iface_type:
-@Returns:
-<!-- ##### USER_FUNCTION GTypePluginFillInterfaceInfo ##### -->
+<!-- ##### FUNCTION g_param_spec_hash_table_new ##### -->
<para>
</para>
-@plugin:
-@interface_type:
-@instance_type:
-@info:
+@Returns:
-<!-- ##### FUNCTION g_object_class_find_param_spec ##### -->
+<!-- ##### FUNCTION g_param_spec_hash_table_remove ##### -->
<para>
</para>
-@oclass:
-@param_name:
-@Returns:
+@hash_table:
+@pspec:
</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>
@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>
@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>
@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>
@Returns:
+<!-- ##### FUNCTION g_object_watch_closure ##### -->
+<para>
+
+</para>
+
+@object:
+@closure:
+
+
+<!-- ##### MACRO G_OBJECT_WARN_INVALID_PROPERTY_ID ##### -->
+<para>
+
+</para>
+
+@object:
+@property_id:
+@pspec:
+
+
@pspec:
+<!-- ##### FUNCTION g_param_spec_sink ##### -->
+<para>
+
+</para>
+
+@pspec:
+
+
<!-- ##### FUNCTION g_param_spec_get_qdata ##### -->
<para>
@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:
+
+
<!-- ##### 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>
<!-- ##### 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>
@gpointer data2);
</programlisting></msgtext>
-<!-- ##### FUNCTION g_signal_newv ##### -->
+<!-- ##### FUNCTION g_signal_newc ##### -->
<para>
</para>
@signal_name:
@itype:
@signal_flags:
-@class_closure:
+@class_offset:
@accumulator:
@c_marshaller:
@return_type:
@n_params:
-@param_types:
+@Varargs:
@Returns:
-<!-- ##### FUNCTION g_signal_emitv ##### -->
-<para>
-
-</para>
-
-@instance_and_params:
-@signal_id:
-@detail:
-@return_value:
-
-
-<!-- ##### FUNCTION g_signal_lookup ##### -->
+<!-- ##### FUNCTION g_signal_newv ##### -->
<para>
</para>
-@name:
+@signal_name:
@itype:
+@signal_flags:
+@class_closure:
+@accumulator:
+@c_marshaller:
+@return_type:
+@n_params:
+@param_types:
@Returns:
-<!-- ##### FUNCTION g_signal_name ##### -->
+<!-- ##### FUNCTION g_signal_new_valist ##### -->
<para>
</para>
-@signal_id:
+@signal_name:
+@itype:
+@signal_flags:
+@class_closure:
+@accumulator:
+@c_marshaller:
+@return_type:
+@n_params:
+@args:
@Returns:
values upon success.
+<!-- ##### FUNCTION g_signal_lookup ##### -->
+<para>
+
+</para>
+
+@name:
+@itype:
+@Returns:
+
+
+<!-- ##### FUNCTION g_signal_name ##### -->
+<para>
+
+</para>
+
+@signal_id:
+@Returns:
+
+
<!-- ##### FUNCTION g_signal_list_ids ##### -->
<para>
List the signals by id, that a certain instance or interface type
@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>
@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:
+
+
@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>
@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>
@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>
+<!-- ##### 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>
@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>
@lcopy_type:
@lcopy_value:
-<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
+<!-- ##### MACRO G_TYPE_FROM_INSTANCE ##### -->
<para>
</para>
@instance:
-@g_type:
-@c_type:
-<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
+<!-- ##### MACRO G_TYPE_FROM_CLASS ##### -->
<para>
</para>
@g_class:
+
+
+<!-- ##### MACRO G_TYPE_FROM_INTERFACE ##### -->
+<para>
+
+</para>
+
+@g_iface:
+
+
+<!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
+<para>
+
+</para>
+
+@instance:
@g_type:
@c_type:
-<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
+<!-- ##### MACRO G_TYPE_INSTANCE_GET_INTERFACE ##### -->
<para>
</para>
@instance:
@g_type:
+@c_type:
-<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_INSTANCE ##### -->
<para>
</para>
-@g_class:
-@g_type:
+@instance:
-<!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
<para>
</para>
@c_type:
-<!-- ##### MACRO G_TYPE_FROM_INSTANCE ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
<para>
</para>
@instance:
+@g_type:
-<!-- ##### MACRO G_TYPE_FROM_CLASS ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
<para>
</para>
@g_class:
+@g_type:
+@c_type:
-<!-- ##### MACRO G_TYPE_FROM_INTERFACE ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
<para>
</para>
-@g_iface:
+@g_class:
+@g_type:
-<!-- ##### FUNCTION g_type_init ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_VALUE ##### -->
<para>
</para>
+@value:
-<!-- ##### FUNCTION g_type_name ##### -->
+<!-- ##### MACRO G_TYPE_CHECK_VALUE_TYPE ##### -->
<para>
</para>
-@type:
-@Returns:
+@value:
+@g_type:
-<!-- ##### FUNCTION g_type_qname ##### -->
+<!-- ##### 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_from_name ##### -->
+<!-- ##### FUNCTION g_type_qname ##### -->
<para>
+Return the corresponding quark of the type IDs name.
+</para>
+
+@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 ##### -->
<!-- ##### 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 ##### -->
@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>
@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:
@instance:
-<!-- ##### FUNCTION g_type_value_table_peek ##### -->
-<para>
-
-</para>
-
-@type:
-@Returns:
-
-
<!-- ##### FUNCTION g_type_add_class_cache_func ##### -->
<para>
@g_class:
-<!-- ##### FUNCTION g_type_get_plugin ##### -->
+<!-- ##### FUNCTION g_type_check_instance ##### -->
<para>
</para>
-@type:
+@instance:
@Returns:
-<!-- ##### FUNCTION g_type_fundamental_last ##### -->
+<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
<para>
</para>
+@instance:
+@iface_type:
@Returns:
-<!-- ##### FUNCTION g_type_check_instance ##### -->
+<!-- ##### 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:
@Returns:
+<!-- ##### FUNCTION g_type_value_is_a ##### -->
+<para>
+
+</para>
+
+@value:
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION g_type_value_table_peek ##### -->
+<para>
+
+</para>
+
+@type:
+@Returns:
+
+
@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>
@v_string:
+<!-- ##### FUNCTION g_value_set_static_string ##### -->
+<para>
+
+</para>
+
+@value:
+@v_string:
+
+
<!-- ##### FUNCTION g_value_get_string ##### -->
<para>
@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:
+
+
/*< private >*/
-GTypeClass* g_type_check_class_cast (GTypeClass *g_class,
- GType is_a_type);
-gboolean g_type_class_is_a (GTypeClass *g_class,
- GType is_a_type);
+gboolean g_type_check_instance (GTypeInstance *instance);
GTypeInstance* g_type_check_instance_cast (GTypeInstance *instance,
GType iface_type);
gboolean g_type_instance_is_a (GTypeInstance *instance,
GType iface_type);
+GTypeClass* g_type_check_class_cast (GTypeClass *g_class,
+ GType is_a_type);
+gboolean g_type_class_is_a (GTypeClass *g_class,
+ GType is_a_type);
gboolean g_type_check_value (GValue *value);
gboolean g_type_value_is_a (GValue *value,
GType type);
-gboolean g_type_check_instance (GTypeInstance *instance);
GTypeValueTable* g_type_value_table_peek (GType type);