mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-01-12 15:36:17 +01:00
Updates added
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
Owen Taylor
parent
7d4a8d2c4c
commit
975d1e3e4d
@ -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>
|
||||
|
||||
* glib/tmpl/markup.sgml: Write docs
|
||||
|
||||
@ -1,70 +1,9 @@
|
||||
<!-- ##### MACRO popen ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO pclose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO lseek ##### -->
|
||||
<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 ##### -->
|
||||
<para>
|
||||
|
||||
@ -72,9 +11,70 @@ Turns the argument into a string literal by using the '#' stringizing operator.
|
||||
|
||||
@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 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO getpid ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO fdopen ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO close ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO getcwd ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO read ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
@ -2,14 +2,11 @@
|
||||
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 ##### -->
|
||||
@ -19,32 +16,32 @@ was started, and g_timer_stop () to stop the timer.
|
||||
|
||||
<!-- ##### 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 ##### -->
|
||||
@ -52,25 +49,24 @@ Stops the timer.
|
||||
|
||||
</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:
|
||||
|
||||
|
||||
|
||||
@ -2,37 +2,11 @@
|
||||
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 ##### -->
|
||||
@ -42,37 +16,33 @@ To convert an unsigned integer, a #guint, to a #gpointer, use
|
||||
|
||||
<!-- ##### 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:
|
||||
|
||||
|
||||
|
||||
@ -2,23 +2,11 @@
|
||||
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 ##### -->
|
||||
|
||||
@ -13,16 +13,20 @@ DOC_SOURCE_DIR=../../../gobject
|
||||
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 \
|
||||
|
||||
@ -1,14 +1,17 @@
|
||||
<!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>
|
||||
@ -63,16 +66,20 @@
|
||||
<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>
|
||||
|
||||
@ -15,8 +15,6 @@ G_TYPE_IS_INSTANTIATABLE
|
||||
G_TYPE_IS_DERIVABLE
|
||||
G_TYPE_IS_DEEP_DERIVABLE
|
||||
G_TYPE_IS_INTERFACE
|
||||
GTypePlugin
|
||||
GTypePluginVTable
|
||||
GTypeInterface
|
||||
GTypeInstance
|
||||
GTypeInfo
|
||||
@ -57,10 +55,6 @@ GClassFinalizeFunc
|
||||
GInstanceInitFunc
|
||||
GInterfaceInitFunc
|
||||
GInterfaceFinalizeFunc
|
||||
GTypePluginRef
|
||||
GTypePluginUnRef
|
||||
GTypePluginFillTypeInfo
|
||||
GTypePluginFillInterfaceInfo
|
||||
GTypeClassCacheFunc
|
||||
GTypeFlags
|
||||
g_type_register_static
|
||||
@ -83,13 +77,52 @@ g_type_get_plugin
|
||||
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>
|
||||
@ -150,6 +183,7 @@ G_FLAGS_CLASS_TYPE
|
||||
G_FLAGS_CLASS_TYPE_NAME
|
||||
G_IS_VALUE_ENUM
|
||||
G_IS_VALUE_FLAGS
|
||||
G_IS_VALUE_POINTER
|
||||
GEnumValue
|
||||
GFlagsValue
|
||||
g_enum_get_value
|
||||
@ -168,9 +202,28 @@ g_enum_complete_type_info
|
||||
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
|
||||
@ -182,6 +235,7 @@ g_value_copy
|
||||
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
|
||||
@ -360,6 +414,7 @@ GClosureNotify
|
||||
GClosure
|
||||
GCClosure
|
||||
GClosureNotifyData
|
||||
GCallback
|
||||
G_CLOSURE_NEEDS_MARSHAL
|
||||
G_CCLOSURE_SWAP_DATA
|
||||
g_cclosure_new
|
||||
|
||||
@ -59,6 +59,12 @@ Closures
|
||||
@data:
|
||||
@notify:
|
||||
|
||||
<!-- ##### TYPEDEF GCallback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_CLOSURE_NEEDS_MARSHAL ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
@ -122,6 +122,14 @@ Enumeration and Flag Types
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GEnumValue ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
105
docs/reference/gobject/tmpl/gboxed.sgml
Normal file
105
docs/reference/gobject/tmpl/gboxed.sgml
Normal 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:
|
||||
|
||||
|
||||
@ -14,6 +14,15 @@ Generic values
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO G_VALUE_HOLDS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@g_type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_VALUE_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
@ -105,6 +114,15 @@ Generic values
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_fits_pointer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_values_exchange ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
@ -1,14 +1,36 @@
|
||||
<!-- ##### 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>
|
||||
@ -22,6 +44,41 @@
|
||||
@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>
|
||||
|
||||
@ -29,10 +86,26 @@
|
||||
|
||||
@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:
|
||||
|
||||
|
||||
115
docs/reference/gobject/tmpl/gtypemodule.sgml
Normal file
115
docs/reference/gobject/tmpl/gtypemodule.sgml
Normal 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
98
docs/reference/gobject/tmpl/gtypeplugin.sgml
Normal 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:
|
||||
|
||||
|
||||
@ -144,23 +144,6 @@ GType
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GTypePlugin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@vtable:
|
||||
|
||||
<!-- ##### STRUCT GTypePluginVTable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin_ref:
|
||||
@plugin_unref:
|
||||
@complete_type_info:
|
||||
@complete_interface_info:
|
||||
|
||||
<!-- ##### STRUCT GTypeInterface ##### -->
|
||||
<para>
|
||||
|
||||
@ -519,44 +502,6 @@ GType
|
||||
@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>
|
||||
|
||||
@ -768,16 +713,6 @@ GType
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_is_dynamic ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_value_conforms_to ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user