mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-07-23 10:27:51 +02:00
Split GObject docs away from the remainder of the docs.
Wed Sep 6 00:30:09 2000 Owen Taylor <otaylor@redhat.com> * glib/* gobject/*: Split GObject docs away from the remainder of the docs. * glib/Makefile.am gobject/Makefile.am: Rework to have reasonable dependencies. (No dependencies on the files actually in the source directories, so to get it going, you have to do 'make scan', but after that, things should work OK.)
This commit is contained in:
5
docs/reference/gobject/.cvsignore
Normal file
5
docs/reference/gobject/.cvsignore
Normal file
@@ -0,0 +1,5 @@
|
||||
gobject-decl.txt
|
||||
gobject-unused.txt
|
||||
gobject-decl-list.txt
|
||||
html
|
||||
sgml
|
95
docs/reference/gobject/Makefile.am
Normal file
95
docs/reference/gobject/Makefile.am
Normal file
@@ -0,0 +1,95 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# The name of the module.
|
||||
DOC_MODULE=gobject
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE=gobject-docs.sgml
|
||||
|
||||
# The directory containing the source code (if it contains documentation).
|
||||
DOC_SOURCE_DIR=$(top_srcdir)/gobject
|
||||
|
||||
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
|
||||
|
||||
tmpl_sources = \
|
||||
tmpl/enumerations_flags.sgml \
|
||||
tmpl/generic_values.sgml \
|
||||
tmpl/gobject-unused.sgml \
|
||||
tmpl/objects.sgml \
|
||||
tmpl/param_specs.sgml \
|
||||
tmpl/standard_params.sgml \
|
||||
tmpl/types.sgml \
|
||||
tmpl/value_collection.sgml \
|
||||
tmpl/value_types.sgml
|
||||
|
||||
gobject_docdir = $(HTML_DIR)
|
||||
gobject_doc_DATA = \
|
||||
gobject-sections.txt
|
||||
|
||||
|
||||
EXTRA_DIST = \
|
||||
$(gobject_doc_DATA)
|
||||
|
||||
if ENABLE_GTK_DOC
|
||||
all-local: html/index.html
|
||||
|
||||
gobject-decl.txt:
|
||||
$(MAKE) scan
|
||||
|
||||
$(tmpl_sources): gobject-decl.txt gobject-sections.txt
|
||||
$(MAKE) templates
|
||||
|
||||
sgml/gobject-doc.bottom: $(tmpl_sources) gobject-decl.txt
|
||||
$(MAKE) sgml
|
||||
|
||||
html/index.html: sgml/gobject-doc.bottom
|
||||
$(MAKE) html
|
||||
endif
|
||||
|
||||
scan:
|
||||
-(cd $(srcdir) \
|
||||
&& gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) )
|
||||
|
||||
templates:
|
||||
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
|
||||
|
||||
sgml:
|
||||
cd $(srcdir) \
|
||||
&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
|
||||
|
||||
html:
|
||||
test -d $(srcdir)/html || mkdir $(srcdir)/html
|
||||
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
|
||||
@echo '-- Fixing Crossreferences'
|
||||
gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) --extra-dir=$(srcdir)/../glib/html
|
||||
|
||||
clean-local:
|
||||
rm -f *~ *.bak *.signals *-unused.txt
|
||||
|
||||
maintainer-clean-local: clean
|
||||
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
||||
|
||||
install-data-local:
|
||||
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
|
||||
(installfiles=`echo $(srcdir)/html/*.html`; \
|
||||
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
|
||||
then echo '-- Nothing to install' ; \
|
||||
else \
|
||||
for i in $$installfiles; do \
|
||||
echo '-- Installing '$$i ; \
|
||||
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
|
||||
done; \
|
||||
echo '-- Installing $(srcdir)/html/index.sgml' ; \
|
||||
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
|
||||
fi)
|
||||
|
||||
dist-hook:
|
||||
mkdir $(distdir)/html
|
||||
mkdir $(distdir)/sgml
|
||||
mkdir $(distdir)/tmpl
|
||||
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
|
||||
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
|
||||
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
|
||||
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
|
||||
|
||||
.PHONY : html sgml templates scan
|
28
docs/reference/gobject/gobject-docs.sgml
Normal file
28
docs/reference/gobject/gobject-docs.sgml
Normal file
@@ -0,0 +1,28 @@
|
||||
<!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-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">
|
||||
]>
|
||||
<book id="index">
|
||||
<bookinfo>
|
||||
<title>GObject Reference Manual</title>
|
||||
</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;
|
||||
|
||||
</book>
|
318
docs/reference/gobject/gobject-sections.txt
Normal file
318
docs/reference/gobject/gobject-sections.txt
Normal file
@@ -0,0 +1,318 @@
|
||||
<INCLUDE>gobject.h</INCLUDE>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Type Information</TITLE>
|
||||
<FILE>types</FILE>
|
||||
GType
|
||||
G_TYPE_FUNDAMENTAL
|
||||
G_TYPE_FUNDAMENTAL_MAX
|
||||
G_TYPE_DERIVE_ID
|
||||
G_TYPE_BRANCH_SEQNO
|
||||
G_TYPE_FUNDAMENTAL_LAST
|
||||
GTypeFundamentals
|
||||
G_TYPE_IS_CLASSED
|
||||
G_TYPE_IS_INSTANTIATABLE
|
||||
G_TYPE_IS_DERIVABLE
|
||||
G_TYPE_IS_DEEP_DERIVABLE
|
||||
G_TYPE_IS_INTERFACE
|
||||
GTypePlugin
|
||||
GTypePluginVTable
|
||||
GTypeInterface
|
||||
GTypeInstance
|
||||
GTypeInfo
|
||||
GTypeFundamentalInfo
|
||||
GInterfaceInfo
|
||||
GTypeValueTable
|
||||
<TITLE>GType</TITLE>
|
||||
G_TYPE_CHECK_INSTANCE_CAST
|
||||
G_TYPE_CHECK_CLASS_CAST
|
||||
G_TYPE_CHECK_INSTANCE_TYPE
|
||||
G_TYPE_CHECK_CLASS_TYPE
|
||||
G_TYPE_INSTANCE_GET_CLASS
|
||||
G_TYPE_FROM_INSTANCE
|
||||
G_TYPE_FROM_CLASS
|
||||
G_TYPE_FROM_INTERFACE
|
||||
g_type_init
|
||||
g_type_name
|
||||
g_type_qname
|
||||
g_type_from_name
|
||||
g_type_parent
|
||||
g_type_next_base
|
||||
g_type_is_a
|
||||
g_type_conforms_to
|
||||
g_type_fundamental_branch_last
|
||||
g_type_class_ref
|
||||
g_type_class_peek
|
||||
g_type_class_unref
|
||||
g_type_class_peek_parent
|
||||
g_type_interface_peek
|
||||
g_type_children
|
||||
g_type_interfaces
|
||||
g_type_set_qdata
|
||||
g_type_get_qdata
|
||||
GBaseInitFunc
|
||||
GBaseFinalizeFunc
|
||||
GClassInitFunc
|
||||
GClassFinalizeFunc
|
||||
GInstanceInitFunc
|
||||
GInterfaceInitFunc
|
||||
GInterfaceFinalizeFunc
|
||||
GTypePluginRef
|
||||
GTypePluginUnRef
|
||||
GTypePluginFillTypeInfo
|
||||
GTypePluginFillInterfaceInfo
|
||||
GTypeClassCacheFunc
|
||||
GTypeFlags
|
||||
g_type_register_static
|
||||
g_type_register_dynamic
|
||||
g_type_register_fundamental
|
||||
g_type_add_interface_static
|
||||
g_type_add_interface_dynamic
|
||||
g_type_class_is_a
|
||||
g_type_check_class_cast
|
||||
g_type_check_instance_cast
|
||||
g_type_instance_conforms_to
|
||||
g_type_check_flags
|
||||
g_type_create_instance
|
||||
g_type_free_instance
|
||||
g_type_value_table_peek
|
||||
g_type_add_class_cache_func
|
||||
g_type_remove_class_cache_func
|
||||
g_type_class_unref_uncached
|
||||
g_type_get_plugin
|
||||
g_type_fundamental_last
|
||||
|
||||
<SUBSECTION Private>
|
||||
g_log_domain_gobject
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>The Base Object Type</TITLE>
|
||||
<FILE>objects</FILE>
|
||||
GObject
|
||||
GObjectClass
|
||||
G_OBJECT
|
||||
G_OBJECT_GET_CLASS
|
||||
G_OBJECT_TYPE
|
||||
G_OBJECT_TYPE_NAME
|
||||
G_OBJECT_CLASS_TYPE
|
||||
G_OBJECT_CLASS_NAME
|
||||
G_IS_VALUE_OBJECT
|
||||
G_TYPE_IS_OBJECT
|
||||
G_IS_OBJECT
|
||||
G_OBJECT_CLASS
|
||||
G_IS_OBJECT_CLASS
|
||||
G_NOTIFY_PRIORITY
|
||||
GObjectGetParamFunc
|
||||
GObjectSetParamFunc
|
||||
GObjectFinalizeFunc
|
||||
g_object_class_install_param
|
||||
g_object_class_find_param_spec
|
||||
g_object_new
|
||||
g_object_new_valist
|
||||
g_object_set
|
||||
g_object_get
|
||||
g_object_set_valist
|
||||
g_object_get_valist
|
||||
g_object_set_param
|
||||
g_object_get_param
|
||||
g_object_queue_param_changed
|
||||
g_object_ref
|
||||
g_object_unref
|
||||
g_object_get_qdata
|
||||
g_object_set_qdata
|
||||
g_object_set_qdata_full
|
||||
g_object_steal_qdata
|
||||
g_value_set_object
|
||||
g_value_get_object
|
||||
g_value_dup_object
|
||||
G_WARN_INVALID_PARAM_ID
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Enumeration and Flag Types</TITLE>
|
||||
<FILE>enumerations_flags</FILE>
|
||||
GEnumClass
|
||||
GFlagsClass
|
||||
G_ENUM_CLASS_TYPE
|
||||
G_ENUM_CLASS_TYPE_NAME
|
||||
G_TYPE_IS_ENUM
|
||||
G_ENUM_CLASS
|
||||
G_IS_ENUM_CLASS
|
||||
G_TYPE_IS_FLAGS
|
||||
G_FLAGS_CLASS
|
||||
G_IS_FLAGS_CLASS
|
||||
G_FLAGS_CLASS_TYPE
|
||||
G_FLAGS_CLASS_TYPE_NAME
|
||||
G_IS_VALUE_ENUM
|
||||
G_IS_VALUE_FLAGS
|
||||
GEnumValue
|
||||
GFlagsValue
|
||||
g_enum_get_value
|
||||
g_enum_get_value_by_name
|
||||
g_enum_get_value_by_nick
|
||||
g_flags_get_first_value
|
||||
g_flags_get_value_by_name
|
||||
g_flags_get_value_by_nick
|
||||
g_value_set_enum
|
||||
g_value_get_enum
|
||||
g_value_set_flags
|
||||
g_value_get_flags
|
||||
g_enum_register_static
|
||||
g_flags_register_static
|
||||
g_enum_complete_type_info
|
||||
g_flags_complete_type_info
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Generic values</TITLE>
|
||||
<FILE>generic_values</FILE>
|
||||
G_VALUE_TYPE
|
||||
G_VALUE_TYPE_NAME
|
||||
G_TYPE_IS_VALUE
|
||||
G_IS_VALUE
|
||||
GValueExchange
|
||||
GValue
|
||||
g_value_init
|
||||
g_value_copy
|
||||
g_value_convert
|
||||
g_value_reset
|
||||
g_value_unset
|
||||
g_values_exchange
|
||||
g_value_types_exchangable
|
||||
g_value_register_exchange_func
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Standard value types</TITLE>
|
||||
<FILE>value_types</FILE>
|
||||
G_IS_VALUE_CHAR
|
||||
G_IS_VALUE_UCHAR
|
||||
G_IS_VALUE_BOOLEAN
|
||||
G_IS_VALUE_INT
|
||||
G_IS_VALUE_UINT
|
||||
G_IS_VALUE_LONG
|
||||
G_IS_VALUE_ULONG
|
||||
G_IS_VALUE_FLOAT
|
||||
G_IS_VALUE_DOUBLE
|
||||
G_IS_VALUE_STRING
|
||||
g_value_set_char
|
||||
g_value_get_char
|
||||
g_value_set_uchar
|
||||
g_value_get_uchar
|
||||
g_value_set_boolean
|
||||
g_value_get_boolean
|
||||
g_value_set_int
|
||||
g_value_get_int
|
||||
g_value_set_uint
|
||||
g_value_get_uint
|
||||
g_value_set_long
|
||||
g_value_get_long
|
||||
g_value_set_ulong
|
||||
g_value_get_ulong
|
||||
g_value_set_float
|
||||
g_value_get_float
|
||||
g_value_set_double
|
||||
g_value_get_double
|
||||
g_value_set_string
|
||||
g_value_get_string
|
||||
g_value_dup_string
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Object Parameter Specifications</TITLE>
|
||||
<FILE>param_specs</FILE>
|
||||
GParamSpec
|
||||
GParamSpecClass
|
||||
G_PARAM_SPEC_TYPE
|
||||
G_PARAM_SPEC_TYPE_NAME
|
||||
G_PARAM_SPEC
|
||||
G_IS_PARAM_SPEC
|
||||
G_PARAM_SPEC_GET_CLASS
|
||||
G_IS_PARAM_VALUE
|
||||
G_PARAM_SPEC_VALUE_TYPE
|
||||
G_TYPE_IS_PARAM
|
||||
GParamFlags
|
||||
g_param_spec_ref
|
||||
g_param_spec_unref
|
||||
g_param_spec_get_qdata
|
||||
g_param_spec_set_qdata
|
||||
g_param_spec_set_qdata_full
|
||||
g_param_spec_steal_qdata
|
||||
g_param_value_set_default
|
||||
g_param_value_defaults
|
||||
g_param_value_validate
|
||||
g_param_values_cmp
|
||||
g_param_spec_internal
|
||||
g_param_spec_hash_table_new
|
||||
g_param_spec_hash_table_insert
|
||||
g_param_spec_hash_table_remove
|
||||
g_param_spec_hash_table_lookup
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Standard Parameter Types</TITLE>
|
||||
<FILE>standard_params</FILE>
|
||||
G_IS_PARAM_SPEC_CHAR
|
||||
G_PARAM_SPEC_CHAR
|
||||
G_IS_PARAM_SPEC_UCHAR
|
||||
G_PARAM_SPEC_UCHAR
|
||||
G_IS_PARAM_SPEC_BOOLEAN
|
||||
G_PARAM_SPEC_BOOLEAN
|
||||
G_IS_PARAM_SPEC_INT
|
||||
G_PARAM_SPEC_INT
|
||||
G_IS_PARAM_SPEC_UINT
|
||||
G_PARAM_SPEC_UINT
|
||||
G_IS_PARAM_SPEC_LONG
|
||||
G_PARAM_SPEC_LONG
|
||||
G_IS_PARAM_SPEC_ULONG
|
||||
G_PARAM_SPEC_ULONG
|
||||
G_IS_PARAM_SPEC_ENUM
|
||||
G_PARAM_SPEC_ENUM
|
||||
G_IS_PARAM_SPEC_FLAGS
|
||||
G_PARAM_SPEC_FLAGS
|
||||
G_IS_PARAM_SPEC_FLOAT
|
||||
G_PARAM_SPEC_FLOAT
|
||||
G_IS_PARAM_SPEC_DOUBLE
|
||||
G_PARAM_SPEC_DOUBLE
|
||||
G_IS_PARAM_SPEC_STRING
|
||||
G_PARAM_SPEC_STRING
|
||||
G_IS_PARAM_SPEC_OBJECT
|
||||
G_PARAM_SPEC_OBJECT
|
||||
GParamSpecChar
|
||||
GParamSpecUChar
|
||||
GParamSpecBoolean
|
||||
GParamSpecInt
|
||||
GParamSpecUInt
|
||||
GParamSpecLong
|
||||
GParamSpecULong
|
||||
GParamSpecEnum
|
||||
GParamSpecFlags
|
||||
GParamSpecFloat
|
||||
GParamSpecDouble
|
||||
GParamSpecString
|
||||
GParamSpecObject
|
||||
g_param_spec_char
|
||||
g_param_spec_uchar
|
||||
g_param_spec_boolean
|
||||
g_param_spec_int
|
||||
g_param_spec_uint
|
||||
g_param_spec_long
|
||||
g_param_spec_ulong
|
||||
g_param_spec_enum
|
||||
g_param_spec_flags
|
||||
g_param_spec_float
|
||||
g_param_spec_double
|
||||
g_param_spec_string
|
||||
g_param_spec_string_c
|
||||
g_param_spec_object
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Varargs Value Collection</TITLE>
|
||||
<FILE>value_collection</FILE>
|
||||
GTypeCValue
|
||||
G_VALUE_COLLECT
|
||||
G_VALUE_LCOPY
|
||||
</SECTION>
|
||||
|
280
docs/reference/gobject/tmpl/enumerations_flags.sgml
Normal file
280
docs/reference/gobject/tmpl/enumerations_flags.sgml
Normal file
@@ -0,0 +1,280 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Enumeration and Flag Types
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GEnumClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GFlagsClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_ENUM_CLASS_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_ENUM_CLASS_TYPE_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_ENUM_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_ENUM_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_FLAGS_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_FLAGS_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_FLAGS_CLASS_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_FLAGS_CLASS_TYPE_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GEnumValue ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@value_name:
|
||||
@value_nick:
|
||||
|
||||
<!-- ##### STRUCT GFlagsValue ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@value_name:
|
||||
@value_nick:
|
||||
|
||||
<!-- ##### FUNCTION g_enum_get_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_class:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_enum_get_value_by_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_class:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_enum_get_value_by_nick ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_class:
|
||||
@nick:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_flags_get_first_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_class:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_flags_get_value_by_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_class:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_flags_get_value_by_nick ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_class:
|
||||
@nick:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_enum ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_enum:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_enum ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_flags:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_enum_register_static ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@const_static_values:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_flags_register_static ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@const_static_values:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_enum_complete_type_info ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_enum_type:
|
||||
@info:
|
||||
@const_values:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_flags_complete_type_info ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_flags_type:
|
||||
@info:
|
||||
@const_values:
|
||||
|
||||
|
139
docs/reference/gobject/tmpl/generic_values.sgml
Normal file
139
docs/reference/gobject/tmpl/generic_values.sgml
Normal file
@@ -0,0 +1,139 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Generic values
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_VALUE_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_VALUE_TYPE_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_VALUE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GValueExchange ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GValue ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@g_type:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src_value:
|
||||
@dest_value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_convert ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src_value:
|
||||
@dest_value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_reset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_unset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_values_exchange ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_types_exchangable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value_type1:
|
||||
@value_type2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_register_exchange_func ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value_type1:
|
||||
@value_type2:
|
||||
@func:
|
||||
|
||||
|
0
docs/reference/gobject/tmpl/gobject-unused.sgml
Normal file
0
docs/reference/gobject/tmpl/gobject-unused.sgml
Normal file
364
docs/reference/gobject/tmpl/objects.sgml
Normal file
364
docs/reference/gobject/tmpl/objects.sgml
Normal file
@@ -0,0 +1,364 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
The Base Object Type
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GObject ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_type_instance:
|
||||
|
||||
<!-- ##### STRUCT GObjectClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT_TYPE_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT_CLASS_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT_CLASS_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_OBJECT_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_OBJECT_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_NOTIFY_PRIORITY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GObjectGetParamFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@param_id:
|
||||
@value:
|
||||
@pspec:
|
||||
@trailer:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GObjectSetParamFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@param_id:
|
||||
@value:
|
||||
@pspec:
|
||||
@trailer:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GObjectFinalizeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_class_install_param ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@oclass:
|
||||
@param_id:
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_class_find_param_spec ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@oclass:
|
||||
@param_name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object_type:
|
||||
@first_param_name:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_new_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object_type:
|
||||
@first_param_name:
|
||||
@var_args:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@first_param_name:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@first_param_name:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_set_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@first_param_name:
|
||||
@var_args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_get_valist ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@first_param_name:
|
||||
@var_args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_set_param ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@param_name:
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_get_param ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@param_name:
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_queue_param_changed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@param_name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_get_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@quark:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_set_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@quark:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_set_qdata_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@quark:
|
||||
@data:
|
||||
@destroy:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_object_steal_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@quark:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_dup_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_WARN_INVALID_PARAM_ID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@param_id:
|
||||
@pspec:
|
||||
|
||||
|
261
docs/reference/gobject/tmpl/param_specs.sgml
Normal file
261
docs/reference/gobject/tmpl/param_specs.sgml
Normal file
@@ -0,0 +1,261 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Object Parameter Specifications
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GParamSpec ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_instance:
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@flags:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_TYPE_NAME ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_VALUE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_VALUE_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_PARAM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### ENUM GParamFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@G_PARAM_READABLE:
|
||||
@G_PARAM_WRITABLE:
|
||||
@G_PARAM_MASK:
|
||||
@G_PARAM_USER_MASK:
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_get_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@quark:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_set_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@quark:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_set_qdata_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@quark:
|
||||
@data:
|
||||
@destroy:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_steal_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@quark:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_value_set_default ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_value_defaults ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_value_validate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_values_cmp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_internal ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@param_type:
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_hash_table_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_hash_table_insert ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@hash_table:
|
||||
@pspec:
|
||||
@owner_type:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_hash_table_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@hash_table:
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_hash_table_lookup ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@hash_table:
|
||||
@param_name:
|
||||
@owner_type:
|
||||
@try_ancestors:
|
||||
@trailer:
|
||||
@Returns:
|
||||
|
||||
|
555
docs/reference/gobject/tmpl/standard_params.sgml
Normal file
555
docs/reference/gobject/tmpl/standard_params.sgml
Normal file
@@ -0,0 +1,555 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Standard Parameter Types
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_CHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_CHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_UCHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_UCHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_BOOLEAN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_BOOLEAN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_LONG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_LONG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_ULONG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_ULONG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_FLOAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_FLOAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_DOUBLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_DOUBLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GParamSpecChar ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecUChar ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecBoolean ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecInt ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecUInt ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecLong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecULong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecEnum ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@enum_class:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@flags_class:
|
||||
@default_value:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecFloat ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@epsilon:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecDouble ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@epsilon:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecString ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@default_value:
|
||||
@cset_first:
|
||||
@cset_nth:
|
||||
@substitutor:
|
||||
@null_fold_if_empty:
|
||||
@ensure_non_null:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecObject ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_instance:
|
||||
@object_type:
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_char ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_uchar ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_boolean ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_uint ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_long ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_ulong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_enum ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@enum_type:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@flags_type:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_float ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@minimum:
|
||||
@maximum:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_string_c ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@default_value:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@nick:
|
||||
@blurb:
|
||||
@object_type:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
753
docs/reference/gobject/tmpl/types.sgml
Normal file
753
docs/reference/gobject/tmpl/types.sgml
Normal file
@@ -0,0 +1,753 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GType
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_FUNDAMENTAL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_FUNDAMENTAL_MAX ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_DERIVE_ID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ptype:
|
||||
@branch_seqno:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_BRANCH_SEQNO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GTypeFundamentals ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@G_TYPE_INVALID:
|
||||
@G_TYPE_NONE:
|
||||
@G_TYPE_INTERFACE:
|
||||
@G_TYPE_CHAR:
|
||||
@G_TYPE_UCHAR:
|
||||
@G_TYPE_BOOLEAN:
|
||||
@G_TYPE_INT:
|
||||
@G_TYPE_UINT:
|
||||
@G_TYPE_LONG:
|
||||
@G_TYPE_ULONG:
|
||||
@G_TYPE_ENUM:
|
||||
@G_TYPE_FLAGS:
|
||||
@G_TYPE_FLOAT:
|
||||
@G_TYPE_DOUBLE:
|
||||
@G_TYPE_STRING:
|
||||
@G_TYPE_PARAM:
|
||||
@G_TYPE_OBJECT:
|
||||
@G_TYPE_GTK_BOXED:
|
||||
@G_TYPE_GTK_POINTER:
|
||||
@G_TYPE_GTK_SIGNAL:
|
||||
@G_TYPE_BSE_PROCEDURE:
|
||||
@G_TYPE_BSE_TIME:
|
||||
@G_TYPE_BSE_NOTE:
|
||||
@G_TYPE_BSE_DOTS:
|
||||
@G_TYPE_GLE_GOBJECT:
|
||||
@G_TYPE_LAST_RESERVED_FUNDAMENTAL:
|
||||
@G_TYPE_PARAM_CHAR:
|
||||
@G_TYPE_PARAM_UCHAR:
|
||||
@G_TYPE_PARAM_BOOLEAN:
|
||||
@G_TYPE_PARAM_INT:
|
||||
@G_TYPE_PARAM_UINT:
|
||||
@G_TYPE_PARAM_LONG:
|
||||
@G_TYPE_PARAM_ULONG:
|
||||
@G_TYPE_PARAM_ENUM:
|
||||
@G_TYPE_PARAM_FLAGS:
|
||||
@G_TYPE_PARAM_FLOAT:
|
||||
@G_TYPE_PARAM_DOUBLE:
|
||||
@G_TYPE_PARAM_STRING:
|
||||
@G_TYPE_PARAM_OBJECT:
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_CLASSED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_INSTANTIATABLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_DERIVABLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_DEEP_DERIVABLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_INTERFACE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GTypePlugin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@vtable:
|
||||
|
||||
<!-- ##### STRUCT GTypePluginVTable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin_ref:
|
||||
@plugin_unref:
|
||||
@complete_type_info:
|
||||
@complete_interface_info:
|
||||
|
||||
<!-- ##### STRUCT GTypeInterface ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GTypeInstance ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GTypeInfo ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class_size:
|
||||
@base_init:
|
||||
@base_finalize:
|
||||
@class_init:
|
||||
@class_finalize:
|
||||
@class_data:
|
||||
@instance_size:
|
||||
@n_preallocs:
|
||||
@instance_init:
|
||||
@value_table:
|
||||
|
||||
<!-- ##### STRUCT GTypeFundamentalInfo ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type_flags:
|
||||
|
||||
<!-- ##### STRUCT GInterfaceInfo ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@interface_init:
|
||||
@interface_finalize:
|
||||
@interface_data:
|
||||
|
||||
<!-- ##### STRUCT GTypeValueTable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value_init:
|
||||
@value_free:
|
||||
@value_copy:
|
||||
@collect_type:
|
||||
@collect_value:
|
||||
@lcopy_type:
|
||||
@lcopy_value:
|
||||
|
||||
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
@g_type:
|
||||
@c_type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@g_type:
|
||||
@c_type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
@g_type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@g_type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
@g_type:
|
||||
@c_type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_FROM_INSTANCE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_FROM_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_FROM_INTERFACE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_iface:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_qname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_from_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_parent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_next_base ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@base_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_is_a ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@is_a_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_conforms_to ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@iface_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_fundamental_branch_last ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_class_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_class_peek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_class_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_class_peek_parent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_interface_peek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance_class:
|
||||
@iface_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_children ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@n_children:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_interfaces ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@n_interfaces:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_set_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@quark:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_get_qdata ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@quark:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GBaseInitFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GBaseFinalizeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GClassInitFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@class_data:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GClassFinalizeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@class_data:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GInstanceInitFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
@g_class:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GInterfaceInitFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_iface:
|
||||
@iface_data:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GInterfaceFinalizeFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_iface:
|
||||
@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>
|
||||
|
||||
</para>
|
||||
|
||||
@cache_data:
|
||||
@g_class:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### ENUM GTypeFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@G_TYPE_FLAG_CLASSED:
|
||||
@G_TYPE_FLAG_INSTANTIATABLE:
|
||||
@G_TYPE_FLAG_DERIVABLE:
|
||||
@G_TYPE_FLAG_DEEP_DERIVABLE:
|
||||
|
||||
<!-- ##### FUNCTION g_type_register_static ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_type:
|
||||
@type_name:
|
||||
@info:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_register_dynamic ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent_type:
|
||||
@type_name:
|
||||
@plugin:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_register_fundamental ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type_id:
|
||||
@type_name:
|
||||
@info:
|
||||
@finfo:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_add_interface_static ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance_type:
|
||||
@interface_type:
|
||||
@info:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_add_interface_dynamic ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance_type:
|
||||
@interface_type:
|
||||
@plugin:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_class_is_a ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@is_a_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_check_class_cast ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
@is_a_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
@iface_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_instance_conforms_to ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
@iface_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_check_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_create_instance ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_free_instance ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@instance:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_value_table_peek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_add_class_cache_func ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cache_data:
|
||||
@cache_func:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_remove_class_cache_func ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cache_data:
|
||||
@cache_func:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_class_unref_uncached ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_class:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_get_plugin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_type_fundamental_last ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
44
docs/reference/gobject/tmpl/value_collection.sgml
Normal file
44
docs/reference/gobject/tmpl/value_collection.sgml
Normal file
@@ -0,0 +1,44 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Varargs Value Collection
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### UNION GTypeCValue ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_VALUE_COLLECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@var_args:
|
||||
@__error:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_VALUE_LCOPY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@var_args:
|
||||
@__error:
|
||||
|
||||
|
287
docs/reference/gobject/tmpl/value_types.sgml
Normal file
287
docs/reference/gobject/tmpl/value_types.sgml
Normal file
@@ -0,0 +1,287 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Standard value types
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_CHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_UCHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_BOOLEAN ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_LONG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_ULONG ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_FLOAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_DOUBLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_VALUE_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_char ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_char:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_char ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_uchar ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_uchar:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_uchar ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_boolean ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_boolean:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_boolean ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_int:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_int ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_uint ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_uint:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_uint ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_long ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_long:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_long ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_ulong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_ulong:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_ulong ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_float ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_float:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_float ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_double:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_double ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_set_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@v_string:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_get_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_value_dup_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
Reference in New Issue
Block a user