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

Updates added

Browse Source 
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
This commit is contained in:
Owen Taylor
2000-11-11 00:03:57 +00:00
committed by Owen Taylor
parent 7d4a8d2c4c
commit 975d1e3e4d
17 changed files with 685 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@@ -1,3 +1,8 @@
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> 2000-11-05 Havoc Pennington <hp@pobox.com>
* glib/tmpl/markup.sgml: Write docs * glib/tmpl/markup.sgml: Write docs

122
docs/reference/glib/tmpl/glib-unused.sgml
View File

@@ -1,70 +1,9 @@
<!-- ##### MACRO popen ##### -->
<para>
</para>
<!-- ##### MACRO pclose ##### -->
<para>
</para>
<!-- ##### MACRO lseek ##### --> <!-- ##### MACRO lseek ##### -->
<para> <para>
</para> </para>
<!-- ##### MACRO getpid ##### -->
<para>
</para>
<!-- ##### MACRO close ##### -->
<para>
</para>
<!-- ##### MACRO fdopen ##### -->
<para>
</para>
<!-- ##### MACRO getcwd ##### -->
<para>
</para>
<!-- ##### MACRO write ##### -->
<para>
</para>
<!-- ##### 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.
<!-- ##### MACRO read ##### -->
<para>
</para>
<!-- ##### FUNCTION g_convert_error_quark ##### --> <!-- ##### FUNCTION g_convert_error_quark ##### -->
<para> <para>
@@ -72,9 +11,70 @@ Turns the argument into a string literal by using the '#' stringizing operator.
@Returns: @Returns:
<!-- ##### MACRO write ##### -->
<para>
</para>
<!-- ##### MACRO pclose ##### -->
<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.
<!-- ##### MACRO popen ##### -->
<para>
</para>
<!-- ##### MACRO access ##### -->
<para>
</para>
<!-- ##### MACRO open ##### --> <!-- ##### MACRO open ##### -->
<para> <para>
</para> </para>
<!-- ##### MACRO getpid ##### -->
<para>
</para>
<!-- ##### MACRO fdopen ##### -->
<para>
</para>
<!-- ##### MACRO close ##### -->
<para>
</para>
<!-- ##### MACRO getcwd ##### -->
<para>
</para>
<!-- ##### MACRO read ##### -->
<para>
</para>

36
docs/reference/glib/tmpl/timers.sgml
View File

@@ -2,14 +2,11 @@
Timers Timers
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
functions to time operations.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <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> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
@@ -19,32 +16,32 @@ was started, and g_timer_stop () to stop the timer.
<!-- ##### STRUCT GTimer ##### --> <!-- ##### STRUCT GTimer ##### -->
<para> <para>
An opaque data structure which holds the timer information.
</para> </para>
<!-- ##### FUNCTION g_timer_new ##### --> <!-- ##### FUNCTION g_timer_new ##### -->
<para> <para>
Creates a new timer.
</para> </para>
@Returns: the new timer. @Returns:
<!-- ##### FUNCTION g_timer_start ##### --> <!-- ##### FUNCTION g_timer_start ##### -->
<para> <para>
Starts the timer.
</para> </para>
@timer: the timer. @timer:
<!-- ##### FUNCTION g_timer_stop ##### --> <!-- ##### FUNCTION g_timer_stop ##### -->
<para> <para>
Stops the timer.
</para> </para>
@timer: the timer. @timer:
<!-- ##### FUNCTION g_timer_elapsed ##### --> <!-- ##### FUNCTION g_timer_elapsed ##### -->
@@ -52,25 +49,24 @@ Stops the timer.
</para> </para>
@timer: the timer. @timer:
@microseconds: if non-NULL, this will be set to the microseconds component @microseconds:
of the elapsed time (it does not include the number of seconds elapsed). @Returns:
@Returns: the elapsed time in seconds, as a double.
<!-- ##### FUNCTION g_timer_reset ##### --> <!-- ##### FUNCTION g_timer_reset ##### -->
<para> <para>
Resets the elapsed time to 0, leaving the timer running.
</para> </para>
@timer: the timer. @timer:
<!-- ##### FUNCTION g_timer_destroy ##### --> <!-- ##### FUNCTION g_timer_destroy ##### -->
<para> <para>
Destroys the timer, freeing the memory allocated for it.
</para> </para>
@timer: the timer. @timer:

50
docs/reference/glib/tmpl/type_conversion.sgml
View File

@@ -2,37 +2,11 @@
Type Conversion Macros Type Conversion Macros
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
a portable method for storing #gint &amp; #guint values in #gpointer variables.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <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> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
@@ -42,37 +16,33 @@ To convert an unsigned integer, a #guint, to a #gpointer, use
<!-- ##### MACRO GINT_TO_POINTER ##### --> <!-- ##### MACRO GINT_TO_POINTER ##### -->
<para> <para>
Converts a #gint to a #gpointer.
</para> </para>
@i: a #gint value. @i:
@Returns: the value converted to a #gpointer.
<!-- ##### MACRO GPOINTER_TO_INT ##### --> <!-- ##### MACRO GPOINTER_TO_INT ##### -->
<para> <para>
Converts a #gpointer to a #gint.
</para> </para>
@p: a #gpointer value. @p:
@Returns: the value converted to a #gint.
<!-- ##### MACRO GUINT_TO_POINTER ##### --> <!-- ##### MACRO GUINT_TO_POINTER ##### -->
<para> <para>
Converts a #guint to a #gpointer.
</para> </para>
@u: a #guint value. @u:
@Returns: the value converted to a #gpointer.
<!-- ##### MACRO GPOINTER_TO_UINT ##### --> <!-- ##### MACRO GPOINTER_TO_UINT ##### -->
<para> <para>
Converts a #gpointer to a #guint.
</para> </para>
@p: a #gpointer value. @p:
@Returns: the value converted to a #guint.

16
docs/reference/glib/tmpl/windows.sgml
View File

@@ -2,23 +2,11 @@
Windows Compatability Functions Windows Compatability Functions
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
functions to support portability to the Windows environment.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <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> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->

8
docs/reference/gobject/Makefile.am
View File

@@ -13,16 +13,20 @@ DOC_SOURCE_DIR=../../../gobject
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html
# Headers to ignore # Headers to ignore
IGNORE_HFILES= IGNORE_HFILES= \
gbsearcharray.h
tmpl_sources = \ tmpl_sources = \
tmpl/closures.sgml \
tmpl/enumerations_flags.sgml \ tmpl/enumerations_flags.sgml \
tmpl/gboxed.sgml \
tmpl/generic_values.sgml \ tmpl/generic_values.sgml \
tmpl/gobject-unused.sgml \ tmpl/gobject-unused.sgml \
tmpl/gtypemodule.sgml \
tmpl/gtypeplugin.sgml \
tmpl/objects.sgml \ tmpl/objects.sgml \
tmpl/param_specs.sgml \ tmpl/param_specs.sgml \
tmpl/signals.sgml \ tmpl/signals.sgml \
tmpl/closures.sgml \
tmpl/standard_params.sgml \ tmpl/standard_params.sgml \
tmpl/types.sgml \ tmpl/types.sgml \
tmpl/value_collection.sgml \ tmpl/value_collection.sgml \

47
docs/reference/gobject/gobject-docs.sgml
View File

@@ -1,14 +1,17 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity gobject-enumerations-flags SYSTEM "sgml/enumerations_flags.sgml"> <!entity gobject-GType SYSTEM "sgml/types.sgml">
<!entity gobject-generic-values SYSTEM "sgml/generic_values.sgml"> <!entity gobject-GTypePlugin SYSTEM "sgml/gtypeplugin.sgml">
<!entity gobject-objects SYSTEM "sgml/objects.sgml"> <!entity gobject-GTypeModule SYSTEM "sgml/gtypemodule.sgml">
<!entity gobject-param-specs SYSTEM "sgml/param_specs.sgml"> <!entity gobject-The-Base-Object-Type SYSTEM "sgml/objects.sgml">
<!entity gobject-signals SYSTEM "sgml/signals.sgml"> <!entity gobject-Enumeration-and-Flag-Types SYSTEM "sgml/enumerations_flags.sgml">
<!entity gobject-closures SYSTEM "sgml/closures.sgml"> <!entity gobject-Boxed-Types SYSTEM "sgml/gboxed.sgml">
<!entity gobject-standard-params SYSTEM "sgml/standard_params.sgml"> <!entity gobject-Generic-values SYSTEM "sgml/generic_values.sgml">
<!entity gobject-types SYSTEM "sgml/types.sgml"> <!entity gobject-Standard-value-types SYSTEM "sgml/value_types.sgml">
<!entity gobject-value-collection SYSTEM "sgml/value_collection.sgml"> <!entity gobject-Parameter-Specifications SYSTEM "sgml/param_specs.sgml">
<!entity gobject-value-types SYSTEM "sgml/value_types.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"> <book id="index">
<bookinfo> <bookinfo>
@@ -63,16 +66,20 @@
<reference> <reference>
<title>API Reference</title> <title>API Reference</title>
&gobject-types; &gobject-GType;
&gobject-objects; &gobject-GTypePlugin;
&gobject-enumerations-flags; &gobject-GTypeModule;
&gobject-generic-values; &gobject-The-Base-Object-Type;
&gobject-value-types; &gobject-Enumeration-and-Flag-Types;
&gobject-value-collection; &gobject-Boxed-Types;
&gobject-param-specs; &gobject-Generic-values;
&gobject-standard-params; &gobject-Standard-value-types;
&gobject-signals; &gobject-Varargs-Value-Collection;
&gobject-closures; &gobject-Parameter-Specifications;
&gobject-Standard-Parameter-Types;
&gobject-Signals;
&gobject-Closures;
</reference> </reference>
</book> </book>

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

@@ -15,8 +15,6 @@ G_TYPE_IS_INSTANTIATABLE
G_TYPE_IS_DERIVABLE G_TYPE_IS_DERIVABLE
G_TYPE_IS_DEEP_DERIVABLE G_TYPE_IS_DEEP_DERIVABLE
G_TYPE_IS_INTERFACE G_TYPE_IS_INTERFACE
GTypePlugin
GTypePluginVTable
GTypeInterface GTypeInterface
GTypeInstance GTypeInstance
GTypeInfo GTypeInfo
@@ -57,10 +55,6 @@ GClassFinalizeFunc
GInstanceInitFunc GInstanceInitFunc
GInterfaceInitFunc GInterfaceInitFunc
GInterfaceFinalizeFunc GInterfaceFinalizeFunc
GTypePluginRef
GTypePluginUnRef
GTypePluginFillTypeInfo
GTypePluginFillInterfaceInfo
GTypeClassCacheFunc GTypeClassCacheFunc
GTypeFlags GTypeFlags
g_type_register_static g_type_register_static
@@ -83,13 +77,52 @@ g_type_get_plugin
g_type_fundamental_last g_type_fundamental_last
g_type_check_instance g_type_check_instance
g_type_check_value g_type_check_value
g_type_is_dynamic
g_type_value_conforms_to g_type_value_conforms_to
<SUBSECTION Private> <SUBSECTION Private>
g_log_domain_gobject g_log_domain_gobject
</SECTION> </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> <SECTION>
<TITLE>The Base Object Type</TITLE> <TITLE>The Base Object Type</TITLE>
<FILE>objects</FILE> <FILE>objects</FILE>
@@ -150,6 +183,7 @@ G_FLAGS_CLASS_TYPE
G_FLAGS_CLASS_TYPE_NAME G_FLAGS_CLASS_TYPE_NAME
G_IS_VALUE_ENUM G_IS_VALUE_ENUM
G_IS_VALUE_FLAGS G_IS_VALUE_FLAGS
G_IS_VALUE_POINTER
GEnumValue GEnumValue
GFlagsValue GFlagsValue
g_enum_get_value g_enum_get_value
@@ -168,9 +202,28 @@ g_enum_complete_type_info
g_flags_complete_type_info g_flags_complete_type_info
</SECTION> </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> <SECTION>
<TITLE>Generic values</TITLE> <TITLE>Generic values</TITLE>
<FILE>generic_values</FILE> <FILE>generic_values</FILE>
G_VALUE_HOLDS
G_VALUE_TYPE G_VALUE_TYPE
G_VALUE_TYPE_NAME G_VALUE_TYPE_NAME
G_TYPE_IS_VALUE G_TYPE_IS_VALUE
@@ -182,6 +235,7 @@ g_value_copy
g_value_convert g_value_convert
g_value_reset g_value_reset
g_value_unset g_value_unset
g_value_fits_pointer
g_values_exchange g_values_exchange
g_value_types_exchangable g_value_types_exchangable
g_value_register_exchange_func g_value_register_exchange_func
@@ -360,6 +414,7 @@ GClosureNotify
GClosure GClosure
GCClosure GCClosure
GClosureNotifyData GClosureNotifyData
GCallback
G_CLOSURE_NEEDS_MARSHAL G_CLOSURE_NEEDS_MARSHAL
G_CCLOSURE_SWAP_DATA G_CCLOSURE_SWAP_DATA
g_cclosure_new g_cclosure_new

6
docs/reference/gobject/tmpl/closures.sgml
View File

@@ -59,6 +59,12 @@ Closures
@data: @data:
@notify: @notify:
<!-- ##### TYPEDEF GCallback ##### -->
<para>
</para>
<!-- ##### MACRO G_CLOSURE_NEEDS_MARSHAL ##### --> <!-- ##### MACRO G_CLOSURE_NEEDS_MARSHAL ##### -->
<para> <para>

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

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

105
docs/reference/gobject/tmpl/gboxed.sgml Normal file
View File

@@ -0,0 +1,105 @@
<!-- ##### 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:

18
docs/reference/gobject/tmpl/generic_values.sgml
View File

@@ -14,6 +14,15 @@ Generic values
</para> </para>
<!-- ##### MACRO G_VALUE_HOLDS ##### -->
<para>
</para>
@value:
@g_type:
<!-- ##### MACRO G_VALUE_TYPE ##### --> <!-- ##### MACRO G_VALUE_TYPE ##### -->
<para> <para>
@@ -105,6 +114,15 @@ Generic values
@value: @value:
<!-- ##### FUNCTION g_value_fits_pointer ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION g_values_exchange ##### --> <!-- ##### FUNCTION g_values_exchange ##### -->
<para> <para>

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

@@ -1,14 +1,36 @@
<!-- ##### ENUM GSignalType ##### --> <!-- ##### SECTION ./tmpl/gtypemodule.sgml.sgml:Long_Description ##### -->
<para> <para>
</para> </para>
@G_SIGNAL_RUN_FIRST:
@G_SIGNAL_RUN_LAST: <!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
@G_SIGNAL_RUN_CLEANUP: <para>
@G_SIGNAL_NO_RECURSE:
@G_SIGNAL_ACTION: </para>
@G_SIGNAL_NO_HOOKS:
@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 ##### --> <!-- ##### FUNCTION g_signal_connect_closure ##### -->
<para> <para>
@@ -22,6 +44,41 @@
@after: @after:
@Returns: @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 ##### --> <!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
<para> <para>
@@ -29,10 +86,26 @@
@instance: @instance:
<!-- ##### FUNCTION g_signals_destroy ##### --> <!-- ##### FUNCTION g_type_is_dynamic ##### -->
<para> <para>
</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:

115
docs/reference/gobject/tmpl/gtypemodule.sgml Normal file
View File

@@ -0,0 +1,115 @@
<!-- ##### 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:

98
docs/reference/gobject/tmpl/gtypeplugin.sgml Normal file
View File

@@ -0,0 +1,98 @@
<!-- ##### 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:

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

@@ -76,9 +76,9 @@ The @GSignalInvocationHint structure is used to pass on additional information
to callbacks during a signal emission. to callbacks during a signal emission.
</para> </para>
@signal_id: The signal id of the signal invoking the callback @signal_id: The signal id of the signal invoking the callback
@detail: The detail passed on for this emission @detail: The detail passed on for this emission
@run_type: The stage the signal emission is currently in, this @run_type: The stage the signal emission is currently in, this
field will contain one of @G_SIGNAL_RUN_FIRST, field will contain one of @G_SIGNAL_RUN_FIRST,
@G_SIGNAL_RUN_LAST or @G_SIGNAL_RUN_CLEANUP. @G_SIGNAL_RUN_LAST or @G_SIGNAL_RUN_CLEANUP.
@@ -92,11 +92,11 @@ values is perfomed. The return value of signal emissions is then the
value returned by the last callback. value returned by the last callback.
</para> </para>
@ihint: Signal invokation hint, see @GSignalInvocationHint @ihint: Signal invokation hint, see @GSignalInvocationHint
@return_accu: Accumulator to collect callback return values in, this @return_accu: Accumulator to collect callback return values in, this
is the return value of the current signal emission is the return value of the current signal emission
@return_value: The return value of the most recent callback function @return_value: The return value of the most recent callback function
@Returns: The accumulator function returns whether the signal emission @Returns: The accumulator function returns whether the signal emission
should be aborted. Returning @FALSE means to abort the should be aborted. Returning @FALSE means to abort the
current emission and @TRUE is returned for continuation. current emission and @TRUE is returned for continuation.
@@ -153,14 +153,14 @@ A structure holding in-depth information for a specific signal. It is
filled in by the g_signal_query() function. filled in by the g_signal_query() function.
</para> </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 to be querried was unknown
@signal_name: The signal name @signal_name: The signal name
@itype: The interface/instance type that this signal can be emitted for @itype: The interface/instance type that this signal can be emitted for
@signal_flags: The signal flags as passed in to @g_signal_new() @signal_flags: The signal flags as passed in to @g_signal_new()
@return_type: The return type for user callbacks @return_type: The return type for user callbacks
@n_params: The number of parameters that user callbacks take @n_params: The number of parameters that user callbacks take
@param_types: The individual parameter types for user callbacks, note that the @param_types: The individual parameter types for user callbacks, note that the
effective callback signature is: effective callback signature is:
<msgtext><programlisting> <msgtext><programlisting>
@return_type callback (@gpointer data1, @return_type callback (@gpointer data1,
@@ -225,8 +225,8 @@ is 0. All members filled into the @GSignalQuery structure should
be considered constant and have to be left untouched. be considered constant and have to be left untouched.
</para> </para>
@signal_id: The signal id of the signal to query information for @signal_id: The signal id of the signal to query information for
@query: A user provided structure that is filled in with constant @query: A user provided structure that is filled in with constant
values upon success. values upon success.
@@ -237,9 +237,9 @@ created. Further information about the signals can be aquired through
g_signal_query(). g_signal_query().
</para> </para>
@itype: Instance or interface type @itype: Instance or interface type
@n_ids: Location to store the number of signal ids for @itype @n_ids: Location to store the number of signal ids for @itype
@Returns: Newly allocated array of signal ids @Returns: Newly allocated array of signal ids
<!-- ##### FUNCTION g_signal_connect_closure_by_id ##### --> <!-- ##### FUNCTION g_signal_connect_closure_by_id ##### -->
@@ -268,8 +268,8 @@ to be a valid signal handler id, connected to a signal of
@instance. @instance.
</para> </para>
@instance: The instance to block the signal handler of @instance: The instance to block the signal handler of
@handler_id: Handler id of the handler to be blocked @handler_id: Handler id of the handler to be blocked
<!-- ##### FUNCTION g_signal_handler_unblock ##### --> <!-- ##### FUNCTION g_signal_handler_unblock ##### -->
@@ -290,8 +290,8 @@ to be a valid id of a signal handler that is connected to a
signal of @instance and is currently blocked. signal of @instance and is currently blocked.
</para> </para>
@instance: The instance to unblock the signal handler of @instance: The instance to unblock the signal handler of
@handler_id: Handler id of the handler to be unblocked @handler_id: Handler id of the handler to be unblocked
<!-- ##### FUNCTION g_signal_handler_disconnect ##### --> <!-- ##### FUNCTION g_signal_handler_disconnect ##### -->
@@ -305,8 +305,8 @@ to be a valid signal handler id, connected to a signal of
@instance. @instance.
</para> </para>
@instance: The instance to remove the signal handler from @instance: The instance to remove the signal handler from
@handler_id: Handler id of the handler to be disconnected @handler_id: Handler id of the handler to be disconnected
<!-- ##### FUNCTION g_signal_handler_find ##### --> <!-- ##### FUNCTION g_signal_handler_find ##### -->
@@ -318,15 +318,15 @@ The match @mask has to be non-0 for successfull matches.
If no handler was found, 0 is returned. If no handler was found, 0 is returned.
</para> </para>
@instance: The instance owning the signal handler to be found @instance: The instance owning the signal handler to be found
@mask: Mask indicating which of @signal_id, @detail, @mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handler has to match @closure, @func and/or @data the handler has to match
@signal_id: Signal the handler has to be connected to @signal_id: Signal the handler has to be connected to
@detail: Signal detail the handler has to be connected to @detail: Signal detail the handler has to be connected to
@closure: The closure the handler will invoke @closure: The closure the handler will invoke
@func: The C closure callback of the handler (useless for non-C closures) @func: The C closure callback of the handler (useless for non-C closures)
@data: The closure data of the handler's closure @data: The closure data of the handler's closure
@Returns: A valid non-0 signal handler id for a successfull match @Returns: A valid non-0 signal handler id for a successfull match
<!-- ##### FUNCTION g_signal_handlers_block_matched ##### --> <!-- ##### FUNCTION g_signal_handlers_block_matched ##### -->
@@ -340,15 +340,15 @@ If no handlers were found, 0 is returned, the number of blocked handlers
otherwise. otherwise.
</para> </para>
@instance: The instance to block handlers from @instance: The instance to block handlers from
@mask: Mask indicating which of @signal_id, @detail, @mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handlers have to match @closure, @func and/or @data the handlers have to match
@signal_id: Signal the handlers have to be connected to @signal_id: Signal the handlers have to be connected to
@detail: Signal detail the handlers have to be connected to @detail: Signal detail the handlers have to be connected to
@closure: The closure the handlers will invoke @closure: The closure the handlers will invoke
@func: The C closure callback of the handlers (useless for non-C closures) @func: The C closure callback of the handlers (useless for non-C closures)
@data: The closure data of the handlers' closures @data: The closure data of the handlers' closures
@Returns: The amount of handlers that got blocked @Returns: The amount of handlers that got blocked
<!-- ##### FUNCTION g_signal_handlers_unblock_matched ##### --> <!-- ##### FUNCTION g_signal_handlers_unblock_matched ##### -->
@@ -363,15 +363,15 @@ otherwise. The match criteria should not apply to any handlers that are
not currently blocked. not currently blocked.
</para> </para>
@instance: The instance to unblock handlers from @instance: The instance to unblock handlers from
@mask: Mask indicating which of @signal_id, @detail, @mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handlers have to match @closure, @func and/or @data the handlers have to match
@signal_id: Signal the handlers have to be connected to @signal_id: Signal the handlers have to be connected to
@detail: Signal detail the handlers have to be connected to @detail: Signal detail the handlers have to be connected to
@closure: The closure the handlers will invoke @closure: The closure the handlers will invoke
@func: The C closure callback of the handlers (useless for non-C closures) @func: The C closure callback of the handlers (useless for non-C closures)
@data: The closure data of the handlers' closures @data: The closure data of the handlers' closures
@Returns: The amount of handlers that got unblocked @Returns: The amount of handlers that got unblocked
<!-- ##### FUNCTION g_signal_handlers_disconnect_matched ##### --> <!-- ##### FUNCTION g_signal_handlers_disconnect_matched ##### -->
@@ -385,15 +385,15 @@ If no handlers were found, 0 is returned, the number of disconnected handlers
otherwise. otherwise.
</para> </para>
@instance: The instance to remove handlers from @instance: The instance to remove handlers from
@mask: Mask indicating which of @signal_id, @detail, @mask: Mask indicating which of @signal_id, @detail,
@closure, @func and/or @data the handlers have to match @closure, @func and/or @data the handlers have to match
@signal_id: Signal the handlers have to be connected to @signal_id: Signal the handlers have to be connected to
@detail: Signal detail the handlers have to be connected to @detail: Signal detail the handlers have to be connected to
@closure: The closure the handlers will invoke @closure: The closure the handlers will invoke
@func: The C closure callback of the handlers (useless for non-C closures) @func: The C closure callback of the handlers (useless for non-C closures)
@data: The closure data of the handlers' closures @data: The closure data of the handlers' closures
@Returns: The amount of handlers that got disconnected @Returns: The amount of handlers that got disconnected
<!-- ##### FUNCTION g_signal_has_handler_pending ##### --> <!-- ##### FUNCTION g_signal_has_handler_pending ##### -->
@@ -453,12 +453,12 @@ Internal function to parse a signal names into its @signal_id
and @detail quark. and @detail quark.
</para> </para>
@detailed_signal: A string of the form "signal-name::detail" @detailed_signal: A string of the form "signal-name::detail"
@itype: The interface/instance type taht introduced "signal-name" @itype: The interface/instance type taht introduced "signal-name"
@signal_id_p: Location to store the signal id @signal_id_p: Location to store the signal id
@detail_p: Location to stroe the detail quark @detail_p: Location to stroe the detail quark
@force_detail_quark: %TRUE forces creation of a GQuark for the detail @force_detail_quark: %TRUE forces creation of a GQuark for the detail
@Returns: Whether the signal name could successfully be parsed and @Returns: Whether the signal name could successfully be parsed and
@signal_id_p and @detail_p contain valid return values. @signal_id_p and @detail_p contain valid return values.

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

@@ -144,23 +144,6 @@ GType
@type: @type:
<!-- ##### STRUCT GTypePlugin ##### -->
<para>
</para>
@vtable:
<!-- ##### STRUCT GTypePluginVTable ##### -->
<para>
</para>
@plugin_ref:
@plugin_unref:
@complete_type_info:
@complete_interface_info:
<!-- ##### STRUCT GTypeInterface ##### --> <!-- ##### STRUCT GTypeInterface ##### -->
<para> <para>
@@ -519,44 +502,6 @@ GType
@iface_data: @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 ##### --> <!-- ##### USER_FUNCTION GTypeClassCacheFunc ##### -->
<para> <para>
@@ -768,16 +713,6 @@ GType
@Returns: @Returns:
<!-- ##### FUNCTION g_type_is_dynamic ##### -->
<para>
</para>
@type:
@flags:
@Returns:
<!-- ##### FUNCTION g_type_value_conforms_to ##### --> <!-- ##### FUNCTION g_type_value_conforms_to ##### -->
<para> <para>