+Sun Nov 5 13:24:50 2000 Owen Taylor <otaylor@redhat.com>
+
+ * gobject/Makefile.am gobject/gobject-sections.sgml: Updates
+ * gobject/tmpl/g{boxed,type{plugin,module}}.sgml: added
+
2000-11-05 Havoc Pennington <hp@pobox.com>
* glib/tmpl/markup.sgml: Write docs
-<!-- ##### MACRO popen ##### -->
+<!-- ##### MACRO lseek ##### -->
<para>
</para>
-<!-- ##### MACRO pclose ##### -->
+<!-- ##### FUNCTION g_convert_error_quark ##### -->
<para>
</para>
+@Returns:
-<!-- ##### MACRO lseek ##### -->
+<!-- ##### MACRO write ##### -->
<para>
</para>
-<!-- ##### MACRO getpid ##### -->
+<!-- ##### MACRO pclose ##### -->
<para>
</para>
-<!-- ##### MACRO close ##### -->
+<!-- ##### 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 fdopen ##### -->
+<!-- ##### MACRO popen ##### -->
<para>
</para>
-<!-- ##### MACRO getcwd ##### -->
+<!-- ##### MACRO access ##### -->
<para>
</para>
-<!-- ##### MACRO write ##### -->
+<!-- ##### MACRO open ##### -->
<para>
</para>
-<!-- ##### MACRO access ##### -->
+<!-- ##### MACRO getpid ##### -->
<para>
</para>
-<!-- ##### MACRO g_string ##### -->
+<!-- ##### MACRO fdopen ##### -->
<para>
-Turns the argument into a string literal by using the '#' stringizing operator.
+
</para>
-@x: text to convert to a literal string.
-<!-- ##### MACRO read ##### -->
+<!-- ##### MACRO close ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_convert_error_quark ##### -->
+<!-- ##### MACRO getcwd ##### -->
<para>
</para>
-@Returns:
-<!-- ##### MACRO open ##### -->
+<!-- ##### MACRO read ##### -->
<para>
</para>
Timers
<!-- ##### SECTION Short_Description ##### -->
-functions to time operations.
+
<!-- ##### SECTION Long_Description ##### -->
<para>
-Timers can be used to time operations, in a similar way to a stopwatch.
-Call g_timer_new () to create the timer, g_timer_start () to start it,
-g_timer_elapsed () to determine the time which has elapsed since the timer
-was started, and g_timer_stop () to stop the timer.
+
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### STRUCT GTimer ##### -->
<para>
-An opaque data structure which holds the timer information.
+
</para>
<!-- ##### FUNCTION g_timer_new ##### -->
<para>
-Creates a new timer.
+
</para>
-@Returns: the new timer.
+@Returns:
<!-- ##### FUNCTION g_timer_start ##### -->
<para>
-Starts the timer.
+
</para>
-@timer: the timer.
+@timer:
<!-- ##### FUNCTION g_timer_stop ##### -->
<para>
-Stops the timer.
+
</para>
-@timer: the timer.
+@timer:
<!-- ##### FUNCTION g_timer_elapsed ##### -->
</para>
-@timer: the timer.
-@microseconds: if non-NULL, this will be set to the microseconds component
-of the elapsed time (it does not include the number of seconds elapsed).
-@Returns: the elapsed time in seconds, as a double.
+@timer:
+@microseconds:
+@Returns:
<!-- ##### FUNCTION g_timer_reset ##### -->
<para>
-Resets the elapsed time to 0, leaving the timer running.
+
</para>
-@timer: the timer.
+@timer:
<!-- ##### FUNCTION g_timer_destroy ##### -->
<para>
-Destroys the timer, freeing the memory allocated for it.
+
</para>
-@timer: the timer.
+@timer:
Type Conversion Macros
<!-- ##### SECTION Short_Description ##### -->
-a portable method for storing #gint & #guint values in #gpointer variables.
+
<!-- ##### SECTION Long_Description ##### -->
<para>
-These macros provide a portable method of storing #gint and #guint values in
-#gpointer variables.
-</para>
-<para>
-Many of the GLib data types are based on storing #gpointer values,
-e.g. #GHashTable, #GList, #GSList, #GTree, and #GNode.
-By using the type conversion macros described below you can store #gint and
-#guint values inside a #gpointer. So you can, for example, create
-a hash table of #gint values, or a linked list of #guint values.
-</para>
-<para>
-The type conversion macros are necessary because the size of a #gpointer can
-vary across different platforms. So the type conversion has to be done
-carefully.
-</para>
-<para>
-Note that the reverse operation, storing #gpointer values in
-integer variables, is not supported, since an integer is not guaranteed to
-be large enough to store #gpointer values across all platforms.
-</para>
-<para>
-To convert an integer value, a #gint, to a #gpointer, use #GINT_TO_POINTER.
-To convert it back to a #gint, use #GPOINTER_TO_INT.
-</para>
-<para>
-To convert an unsigned integer, a #guint, to a #gpointer, use
-#GUINT_TO_POINTER. To convert it back to a #guint, use #GPOINTER_TO_UINT.
+
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### MACRO GINT_TO_POINTER ##### -->
<para>
-Converts a #gint to a #gpointer.
+
</para>
-@i: a #gint value.
-@Returns: the value converted to a #gpointer.
+@i:
<!-- ##### MACRO GPOINTER_TO_INT ##### -->
<para>
-Converts a #gpointer to a #gint.
+
</para>
-@p: a #gpointer value.
-@Returns: the value converted to a #gint.
+@p:
<!-- ##### MACRO GUINT_TO_POINTER ##### -->
<para>
-Converts a #guint to a #gpointer.
+
</para>
-@u: a #guint value.
-@Returns: the value converted to a #gpointer.
+@u:
<!-- ##### MACRO GPOINTER_TO_UINT ##### -->
<para>
-Converts a #gpointer to a #guint.
+
</para>
-@p: a #gpointer value.
-@Returns: the value converted to a #guint.
+@p:
Windows Compatability Functions
<!-- ##### SECTION Short_Description ##### -->
-functions to support portability to the Windows environment.
+
<!-- ##### SECTION Long_Description ##### -->
<para>
-These functions and macros are provided in the GLib library when compiled
-on the Windows platform.
-</para>
-<para>
-Many of the macros simply rename available windows functions
-so that they use the same name as the standard Unix functions.
-This means that code written for the Unix platform will work without change
-under Windows.
-</para>
-<para>
-A few additional constants, types, and functions are also provided,
-to provide a common base set of functions across both the Unix and Windows
-environments.
+
</para>
<!-- ##### SECTION See_Also ##### -->
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html
# Headers to ignore
-IGNORE_HFILES=
+IGNORE_HFILES= \
+ gbsearcharray.h
tmpl_sources = \
+ tmpl/closures.sgml \
tmpl/enumerations_flags.sgml \
+ tmpl/gboxed.sgml \
tmpl/generic_values.sgml \
tmpl/gobject-unused.sgml \
+ tmpl/gtypemodule.sgml \
+ tmpl/gtypeplugin.sgml \
tmpl/objects.sgml \
tmpl/param_specs.sgml \
tmpl/signals.sgml \
- tmpl/closures.sgml \
tmpl/standard_params.sgml \
tmpl/types.sgml \
tmpl/value_collection.sgml \
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!entity gobject-enumerations-flags SYSTEM "sgml/enumerations_flags.sgml">
-<!entity gobject-generic-values SYSTEM "sgml/generic_values.sgml">
-<!entity gobject-objects SYSTEM "sgml/objects.sgml">
-<!entity gobject-param-specs SYSTEM "sgml/param_specs.sgml">
-<!entity gobject-signals SYSTEM "sgml/signals.sgml">
-<!entity gobject-closures SYSTEM "sgml/closures.sgml">
-<!entity gobject-standard-params SYSTEM "sgml/standard_params.sgml">
-<!entity gobject-types SYSTEM "sgml/types.sgml">
-<!entity gobject-value-collection SYSTEM "sgml/value_collection.sgml">
-<!entity gobject-value-types SYSTEM "sgml/value_types.sgml">
+<!entity gobject-GType SYSTEM "sgml/types.sgml">
+<!entity gobject-GTypePlugin SYSTEM "sgml/gtypeplugin.sgml">
+<!entity gobject-GTypeModule SYSTEM "sgml/gtypemodule.sgml">
+<!entity gobject-The-Base-Object-Type SYSTEM "sgml/objects.sgml">
+<!entity gobject-Enumeration-and-Flag-Types SYSTEM "sgml/enumerations_flags.sgml">
+<!entity gobject-Boxed-Types SYSTEM "sgml/gboxed.sgml">
+<!entity gobject-Generic-values SYSTEM "sgml/generic_values.sgml">
+<!entity gobject-Standard-value-types SYSTEM "sgml/value_types.sgml">
+<!entity gobject-Parameter-Specifications SYSTEM "sgml/param_specs.sgml">
+<!entity gobject-Standard-Parameter-Types SYSTEM "sgml/standard_params.sgml">
+<!entity gobject-Varargs-Value-Collection SYSTEM "sgml/value_collection.sgml">
+<!entity gobject-Signals SYSTEM "sgml/signals.sgml">
+<!entity gobject-Closures SYSTEM "sgml/closures.sgml">
]>
<book id="index">
<bookinfo>
<reference>
<title>API Reference</title>
- &gobject-types;
- &gobject-objects;
- &gobject-enumerations-flags;
- &gobject-generic-values;
- &gobject-value-types;
- &gobject-value-collection;
- &gobject-param-specs;
- &gobject-standard-params;
- &gobject-signals;
- &gobject-closures;
+ &gobject-GType;
+ &gobject-GTypePlugin;
+ &gobject-GTypeModule;
+ &gobject-The-Base-Object-Type;
+ &gobject-Enumeration-and-Flag-Types;
+ &gobject-Boxed-Types;
+ &gobject-Generic-values;
+ &gobject-Standard-value-types;
+ &gobject-Varargs-Value-Collection;
+ &gobject-Parameter-Specifications;
+ &gobject-Standard-Parameter-Types;
+ &gobject-Signals;
+ &gobject-Closures;
+
</reference>
</book>
G_TYPE_IS_DERIVABLE
G_TYPE_IS_DEEP_DERIVABLE
G_TYPE_IS_INTERFACE
-GTypePlugin
-GTypePluginVTable
GTypeInterface
GTypeInstance
GTypeInfo
GInstanceInitFunc
GInterfaceInitFunc
GInterfaceFinalizeFunc
-GTypePluginRef
-GTypePluginUnRef
-GTypePluginFillTypeInfo
-GTypePluginFillInterfaceInfo
GTypeClassCacheFunc
GTypeFlags
g_type_register_static
g_type_fundamental_last
g_type_check_instance
g_type_check_value
-g_type_is_dynamic
g_type_value_conforms_to
-
<SUBSECTION Private>
g_log_domain_gobject
</SECTION>
+<SECTION>
+<FILE>gtypeplugin</FILE>
+<TITLE>GTypePlugin</TITLE>
+GTypePlugin
+GTypePluginUse
+GTypePluginUnuse
+GTypePluginCompleteTypeInfo
+GTypePluginCompleteInterfaceInfo
+g_type_plugin_use
+g_type_plugin_unuse
+g_type_plugin_complete_type_info
+g_type_plugin_complete_interface_info
+<SUBSECTION Standard>
+G_TYPE_PLUGIN
+G_IS_TYPE_PLUGIN
+G_TYPE_TYPE_PLUGIN
+g_type_plugin_get_type
+G_TYPE_PLUGIN_CLASS
+G_IS_TYPE_PLUGIN_CLASS
+G_TYPE_PLUGIN_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gtypemodule</FILE>
+<TITLE>GTypeModule</TITLE>
+GTypeModule
+g_type_module_use
+g_type_module_unuse
+g_type_module_set_name
+g_type_module_register_type
+g_type_module_add_interface
+<SUBSECTION Standard>
+G_TYPE_MODULE
+G_IS_TYPE_MODULE
+G_TYPE_TYPE_MODULE
+g_type_module_get_type
+G_TYPE_MODULE_CLASS
+G_IS_TYPE_MODULE_CLASS
+G_TYPE_MODULE_GET_CLASS
+</SECTION>
+
<SECTION>
<TITLE>The Base Object Type</TITLE>
<FILE>objects</FILE>
G_FLAGS_CLASS_TYPE_NAME
G_IS_VALUE_ENUM
G_IS_VALUE_FLAGS
+G_IS_VALUE_POINTER
GEnumValue
GFlagsValue
g_enum_get_value
g_flags_complete_type_info
</SECTION>
+<SECTION>
+<FILE>gboxed</FILE>
+<TITLE>Boxed Types</TITLE>
+GBoxed
+GBoxedCopyFunc
+GBoxedFreeFunc
+g_boxed_copy
+g_boxed_free
+g_value_set_boxed
+g_value_set_static_boxed
+g_value_get_boxed
+g_value_dup_boxed
+g_boxed_type_register_static
+<SUBSECTION Standard>
+G_IS_VALUE_BOXED
+G_TYPE_IS_BOXED
+</SECTION>
+
<SECTION>
<TITLE>Generic values</TITLE>
<FILE>generic_values</FILE>
+G_VALUE_HOLDS
G_VALUE_TYPE
G_VALUE_TYPE_NAME
G_TYPE_IS_VALUE
g_value_convert
g_value_reset
g_value_unset
+g_value_fits_pointer
g_values_exchange
g_value_types_exchangable
g_value_register_exchange_func
GClosure
GCClosure
GClosureNotifyData
+GCallback
G_CLOSURE_NEEDS_MARSHAL
G_CCLOSURE_SWAP_DATA
g_cclosure_new
@data:
@notify:
+<!-- ##### TYPEDEF GCallback ##### -->
+<para>
+
+</para>
+
+
<!-- ##### MACRO G_CLOSURE_NEEDS_MARSHAL ##### -->
<para>
@value:
+<!-- ##### MACRO G_IS_VALUE_POINTER ##### -->
+<para>
+
+</para>
+
+@value:
+
+
<!-- ##### STRUCT GEnumValue ##### -->
<para>
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+gboxed
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GBoxed ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION GBoxedCopyFunc ##### -->
+<para>
+
+</para>
+
+@boxed:
+@Returns:
+
+
+<!-- ##### USER_FUNCTION GBoxedFreeFunc ##### -->
+<para>
+
+</para>
+
+@boxed:
+
+
+<!-- ##### FUNCTION g_boxed_copy ##### -->
+<para>
+
+</para>
+
+@boxed_type:
+@src_boxed:
+@Returns:
+
+
+<!-- ##### FUNCTION g_boxed_free ##### -->
+<para>
+
+</para>
+
+@boxed_type:
+@boxed:
+
+
+<!-- ##### FUNCTION g_value_set_boxed ##### -->
+<para>
+
+</para>
+
+@value:
+@boxed:
+
+
+<!-- ##### FUNCTION g_value_set_static_boxed ##### -->
+<para>
+
+</para>
+
+@value:
+@boxed:
+
+
+<!-- ##### FUNCTION g_value_get_boxed ##### -->
+<para>
+
+</para>
+
+@value:
+@Returns:
+
+
+<!-- ##### FUNCTION g_value_dup_boxed ##### -->
+<para>
+
+</para>
+
+@value:
+@Returns:
+
+
+<!-- ##### FUNCTION g_boxed_type_register_static ##### -->
+<para>
+
+</para>
+
+@name:
+@boxed_copy:
+@boxed_free:
+@Returns:
+
+
</para>
+<!-- ##### MACRO G_VALUE_HOLDS ##### -->
+<para>
+
+</para>
+
+@value:
+@g_type:
+
+
<!-- ##### MACRO G_VALUE_TYPE ##### -->
<para>
@value:
+<!-- ##### FUNCTION g_value_fits_pointer ##### -->
+<para>
+
+</para>
+
+@value:
+@Returns:
+
+
<!-- ##### FUNCTION g_values_exchange ##### -->
<para>
-<!-- ##### ENUM GSignalType ##### -->
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Long_Description ##### -->
<para>
</para>
-@G_SIGNAL_RUN_FIRST:
-@G_SIGNAL_RUN_LAST:
-@G_SIGNAL_RUN_CLEANUP:
-@G_SIGNAL_NO_RECURSE:
-@G_SIGNAL_ACTION:
-@G_SIGNAL_NO_HOOKS:
+
+<!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
+<para>
+
+</para>
+
+@plugin:
+
+<!-- ##### FUNCTION g_signals_destroy ##### -->
+<para>
+
+</para>
+
+@itype:
+
+<!-- ##### 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>
@after:
@Returns:
+<!-- ##### ENUM GSignalType ##### -->
+<para>
+
+</para>
+
+@G_SIGNAL_RUN_FIRST:
+@G_SIGNAL_RUN_LAST:
+@G_SIGNAL_RUN_CLEANUP:
+@G_SIGNAL_NO_RECURSE:
+@G_SIGNAL_ACTION:
+@G_SIGNAL_NO_HOOKS:
+
+<!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
+<para>
+
+</para>
+
+@plugin:
+@g_type:
+@info:
+@value_table:
+
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION GTypePluginRef ##### -->
+<para>
+
+</para>
+
+@plugin:
+
<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
<para>
@instance:
-<!-- ##### FUNCTION g_signals_destroy ##### -->
+<!-- ##### FUNCTION g_type_is_dynamic ##### -->
<para>
</para>
-@itype:
+@type:
+@flags:
+@Returns:
+
+<!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Title ##### -->
+gtypemodule.sgml
+
+
+<!-- ##### USER_FUNCTION GTypePluginFillInterfaceInfo ##### -->
+<para>
+
+</para>
+
+@plugin:
+@interface_type:
+@instance_type:
+@info:
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+GTypeModule
+
+<!-- ##### SECTION Short_Description ##### -->
+Type Loading Modules
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#GTypeModule provides a simple implementation of the #GTypePlugin
+interface. The model of #GTypeModule is a dynamically loaded module
+which implements some number of types and interface
+implementations. When the module is loaded, it registerse its types
+and interfaces using g_type_module_register_type() and
+g_type_module_add_interface(). As long as any instances of these
+types and interface implementations are in use, the module is kept
+loaded. When the types and interfaces are gone, the module may be
+unloaded. If the types and interfaces become used again, the module
+will be reloaded.
+</para>
+<para>
+Keeping track of whether the module should be loaded or not is done by
+using a use count - it starts at zero, and whenever it is greater than
+zero, the module is loaded. The use count is maintained internally by
+the type system, but also can be explicitely controlled by
+g_type_module_use() and g_type_module_unuse(). Typically, when loading
+a module for the first type, g_type_module_use() will be used to load
+it so that it can initialize its types. At some later point, when the
+module no longer needs to be loaded except for the type
+implementations it contains, g_type_module_unuse() is called.
+</para>
+<para>
+#GTypeModule does not actually provide any implementation of module
+loading and unloading. To create a particular module type you must
+derive from #GTypeModule and implement the load and unload functions
+in #GTypeModuleClass.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+<variablelist>
+
+<varlistentry>
+<term>#GTypePlugin</term>
+<listitem><para>The abstract type loader interface.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>#GModule</term>
+<listitem><para>Portable mechanism for dynamically loaded modules.</para></listitem>
+</varlistentry>
+
+</variablelist>
+</para>
+
+<!-- ##### STRUCT GTypeModule ##### -->
+<para>
+
+</para>
+
+@parent_instance:
+@use_count:
+@type_infos:
+@interface_infos:
+@name:
+
+<!-- ##### FUNCTION g_type_module_use ##### -->
+<para>
+
+</para>
+
+@module:
+@Returns:
+
+
+<!-- ##### FUNCTION g_type_module_unuse ##### -->
+<para>
+
+</para>
+
+@module:
+
+
+<!-- ##### FUNCTION g_type_module_set_name ##### -->
+<para>
+
+</para>
+
+@module:
+@name:
+
+
+<!-- ##### FUNCTION g_type_module_register_type ##### -->
+<para>
+
+</para>
+
+@module:
+@parent_type:
+@type_name:
+@type_info:
+@flags:
+@Returns:
+
+
+<!-- ##### FUNCTION g_type_module_add_interface ##### -->
+<para>
+
+</para>
+
+@module:
+@instance_type:
+@interface_type:
+@interface_info:
+
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+GTypePlugin
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GTypePlugin ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION GTypePluginUse ##### -->
+<para>
+
+</para>
+
+@plugin:
+
+
+<!-- ##### USER_FUNCTION GTypePluginUnuse ##### -->
+<para>
+
+</para>
+
+@plugin:
+
+
+<!-- ##### USER_FUNCTION GTypePluginCompleteTypeInfo ##### -->
+<para>
+
+</para>
+
+@plugin:
+@g_type:
+@info:
+@value_table:
+
+
+<!-- ##### USER_FUNCTION GTypePluginCompleteInterfaceInfo ##### -->
+<para>
+
+</para>
+
+@plugin:
+@interface_type:
+@instance_type:
+@info:
+
+
+<!-- ##### FUNCTION g_type_plugin_use ##### -->
+<para>
+
+</para>
+
+@plugin:
+
+
+<!-- ##### FUNCTION g_type_plugin_unuse ##### -->
+<para>
+
+</para>
+
+@plugin:
+
+
+<!-- ##### FUNCTION g_type_plugin_complete_type_info ##### -->
+<para>
+
+</para>
+
+@plugin:
+@g_type:
+@info:
+@value_table:
+
+
+<!-- ##### FUNCTION g_type_plugin_complete_interface_info ##### -->
+<para>
+
+</para>
+
+@plugin:
+@interface_type:
+@instance_type:
+@info:
+
+
to callbacks during a signal emission.
</para>
-@signal_id: The signal id of the signal invoking the callback
-@detail: The detail passed on for this emission
-@run_type: The stage the signal emission is currently in, this
+@signal_id: The signal id of the signal invoking the callback
+@detail: The detail passed on for this emission
+@run_type: The stage the signal emission is currently in, this
field will contain one of @G_SIGNAL_RUN_FIRST,
@G_SIGNAL_RUN_LAST or @G_SIGNAL_RUN_CLEANUP.
value returned by the last callback.
</para>
-@ihint: Signal invokation hint, see @GSignalInvocationHint
-@return_accu: Accumulator to collect callback return values in, this
+@ihint: Signal invokation hint, see @GSignalInvocationHint
+@return_accu: Accumulator to collect callback return values in, this
is the return value of the current signal emission
-@return_value: The return value of the most recent callback function
-@Returns: The accumulator function returns whether the signal emission
+@return_value: The return value of the most recent callback function
+@Returns: The accumulator function returns whether the signal emission
should be aborted. Returning @FALSE means to abort the
current emission and @TRUE is returned for continuation.
filled in by the g_signal_query() function.
</para>
-@signal_id: The signal id of the signal being querried, or 0 if the
+@signal_id: The signal id of the signal being querried, or 0 if the
signal to be querried was unknown
-@signal_name: The signal name
-@itype: The interface/instance type that this signal can be emitted for
-@signal_flags: The signal flags as passed in to @g_signal_new()
-@return_type: The return type for user callbacks
-@n_params: The number of parameters that user callbacks take
-@param_types: The individual parameter types for user callbacks, note that the
+@signal_name: The signal name
+@itype: The interface/instance type that this signal can be emitted for
+@signal_flags: The signal flags as passed in to @g_signal_new()
+@return_type: The return type for user callbacks
+@n_params: The number of parameters that user callbacks take
+@param_types: The individual parameter types for user callbacks, note that the
effective callback signature is:
<msgtext><programlisting>
@return_type callback (@gpointer data1,
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
+@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.
g_signal_query().
</para>
-@itype: Instance or interface type
-@n_ids: Location to store the number of signal ids for @itype
-@Returns: Newly allocated array of signal ids
+@itype: Instance or interface type
+@n_ids: Location to store the number of signal ids for @itype
+@Returns: Newly allocated array of signal ids
<!-- ##### FUNCTION g_signal_connect_closure_by_id ##### -->
@instance.
</para>
-@instance: The instance to block the signal handler of
-@handler_id: Handler id of the handler to be blocked
+@instance: The instance to block the signal handler of
+@handler_id: Handler id of the handler to be blocked
<!-- ##### FUNCTION g_signal_handler_unblock ##### -->
signal of @instance and is currently blocked.
</para>
-@instance: The instance to unblock the signal handler of
-@handler_id: Handler id of the handler to be unblocked
+@instance: The instance to unblock the signal handler of
+@handler_id: Handler id of the handler to be unblocked
<!-- ##### FUNCTION g_signal_handler_disconnect ##### -->
@instance.
</para>
-@instance: The instance to remove the signal handler from
-@handler_id: Handler id of the handler to be disconnected
+@instance: The instance to remove the signal handler from
+@handler_id: Handler id of the handler to be disconnected
<!-- ##### FUNCTION g_signal_handler_find ##### -->
If no handler was found, 0 is returned.
</para>
-@instance: The instance owning the signal handler to be found
-@mask: Mask indicating which of @signal_id, @detail,
+@instance: The instance owning the signal handler to be found
+@mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handler has to match
-@signal_id: Signal the handler has to be connected to
-@detail: Signal detail the handler has to be connected to
-@closure: The closure the handler will invoke
-@func: The C closure callback of the handler (useless for non-C closures)
-@data: The closure data of the handler's closure
-@Returns: A valid non-0 signal handler id for a successfull match
+@signal_id: Signal the handler has to be connected to
+@detail: Signal detail the handler has to be connected to
+@closure: The closure the handler will invoke
+@func: The C closure callback of the handler (useless for non-C closures)
+@data: The closure data of the handler's closure
+@Returns: A valid non-0 signal handler id for a successfull match
<!-- ##### FUNCTION g_signal_handlers_block_matched ##### -->
otherwise.
</para>
-@instance: The instance to block handlers from
-@mask: Mask indicating which of @signal_id, @detail,
+@instance: The instance to block handlers from
+@mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handlers have to match
-@signal_id: Signal the handlers have to be connected to
-@detail: Signal detail the handlers have to be connected to
-@closure: The closure the handlers will invoke
-@func: The C closure callback of the handlers (useless for non-C closures)
-@data: The closure data of the handlers' closures
-@Returns: The amount of handlers that got blocked
+@signal_id: Signal the handlers have to be connected to
+@detail: Signal detail the handlers have to be connected to
+@closure: The closure the handlers will invoke
+@func: The C closure callback of the handlers (useless for non-C closures)
+@data: The closure data of the handlers' closures
+@Returns: The amount of handlers that got blocked
<!-- ##### FUNCTION g_signal_handlers_unblock_matched ##### -->
not currently blocked.
</para>
-@instance: The instance to unblock handlers from
-@mask: Mask indicating which of @signal_id, @detail,
+@instance: The instance to unblock handlers from
+@mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handlers have to match
-@signal_id: Signal the handlers have to be connected to
-@detail: Signal detail the handlers have to be connected to
-@closure: The closure the handlers will invoke
-@func: The C closure callback of the handlers (useless for non-C closures)
-@data: The closure data of the handlers' closures
-@Returns: The amount of handlers that got unblocked
+@signal_id: Signal the handlers have to be connected to
+@detail: Signal detail the handlers have to be connected to
+@closure: The closure the handlers will invoke
+@func: The C closure callback of the handlers (useless for non-C closures)
+@data: The closure data of the handlers' closures
+@Returns: The amount of handlers that got unblocked
<!-- ##### FUNCTION g_signal_handlers_disconnect_matched ##### -->
otherwise.
</para>
-@instance: The instance to remove handlers from
-@mask: Mask indicating which of @signal_id, @detail,
+@instance: The instance to remove handlers from
+@mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handlers have to match
-@signal_id: Signal the handlers have to be connected to
-@detail: Signal detail the handlers have to be connected to
-@closure: The closure the handlers will invoke
-@func: The C closure callback of the handlers (useless for non-C closures)
-@data: The closure data of the handlers' closures
-@Returns: The amount of handlers that got disconnected
+@signal_id: Signal the handlers have to be connected to
+@detail: Signal detail the handlers have to be connected to
+@closure: The closure the handlers will invoke
+@func: The C closure callback of the handlers (useless for non-C closures)
+@data: The closure data of the handlers' closures
+@Returns: The amount of handlers that got disconnected
<!-- ##### FUNCTION g_signal_has_handler_pending ##### -->
and @detail quark.
</para>
-@detailed_signal: A string of the form "signal-name::detail"
-@itype: The interface/instance type taht introduced "signal-name"
-@signal_id_p: Location to store the signal id
-@detail_p: Location to stroe the detail quark
-@force_detail_quark: %TRUE forces creation of a GQuark for the detail
-@Returns: Whether the signal name could successfully be parsed and
+@detailed_signal: A string of the form "signal-name::detail"
+@itype: The interface/instance type taht introduced "signal-name"
+@signal_id_p: Location to store the signal id
+@detail_p: Location to stroe the detail quark
+@force_detail_quark: %TRUE forces creation of a GQuark for the detail
+@Returns: Whether the signal name could successfully be parsed and
@signal_id_p and @detail_p contain valid return values.
@type:
-<!-- ##### STRUCT GTypePlugin ##### -->
-<para>
-
-</para>
-
-@vtable:
-
-<!-- ##### STRUCT GTypePluginVTable ##### -->
-<para>
-
-</para>
-
-@plugin_ref:
-@plugin_unref:
-@complete_type_info:
-@complete_interface_info:
-
<!-- ##### STRUCT GTypeInterface ##### -->
<para>
@iface_data:
-<!-- ##### USER_FUNCTION GTypePluginRef ##### -->
-<para>
-
-</para>
-
-@plugin:
-
-
-<!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
-<para>
-
-</para>
-
-@plugin:
-
-
-<!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
-<para>
-
-</para>
-
-@plugin:
-@g_type:
-@info:
-@value_table:
-
-
-<!-- ##### USER_FUNCTION GTypePluginFillInterfaceInfo ##### -->
-<para>
-
-</para>
-
-@plugin:
-@interface_type:
-@instance_type:
-@info:
-
-
<!-- ##### USER_FUNCTION GTypeClassCacheFunc ##### -->
<para>
@Returns:
-<!-- ##### FUNCTION g_type_is_dynamic ##### -->
-<para>
-
-</para>
-
-@type:
-@flags:
-@Returns:
-
-
<!-- ##### FUNCTION g_type_value_conforms_to ##### -->
<para>
projects / dana / cg-glib.git / commitdiff