mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-10 11:26:16 +01:00
param spec updates.
Tue Nov 13 19:49:16 2001 Tim Janik <timj@gtk.org>
* gobject/tmpl/gparamspec.sgml: param spec updates.
This commit is contained in:
Tim Janik
Tim Janik
parent
113d5e1d74
commit
930d11d2af
@ -1,3 +1,7 @@
|
||||
Tue Nov 13 19:49:16 2001 Tim Janik <timj@gtk.org>
|
||||
|
||||
* gobject/tmpl/gparamspec.sgml: param spec updates.
|
||||
|
||||
2001-11-12 Matthias Clasen <matthiasc@poet.de>
|
||||
|
||||
* glib/tmpl/markup.sgml: Remove excess listitem from long
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<!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-GParamSpec SYSTEM "sgml/gparamspec.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">
|
||||
@ -75,7 +75,7 @@
|
||||
&gobject-Generic-values;
|
||||
&gobject-Standard-value-types;
|
||||
&gobject-Varargs-Value-Collection;
|
||||
&gobject-Parameter-Specifications;
|
||||
&gobject-GParamSpec;
|
||||
&gobject-Standard-Parameter-Types;
|
||||
&gobject-Signals;
|
||||
&gobject-Closures;
|
||||
|
||||
@ -337,32 +337,35 @@ g_value_set_instance
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Parameter Specifications</TITLE>
|
||||
<FILE>param_specs</FILE>
|
||||
GParamSpec
|
||||
GParamSpecClass
|
||||
<TITLE>GParamSpec</TITLE>
|
||||
<FILE>gparamspec</FILE>
|
||||
G_PARAM_SPEC_TYPE
|
||||
G_PARAM_SPEC_TYPE_NAME
|
||||
G_TYPE_IS_PARAM
|
||||
G_PARAM_SPEC
|
||||
G_IS_PARAM_SPEC
|
||||
G_PARAM_SPEC_CLASS
|
||||
G_IS_PARAM_SPEC_CLASS
|
||||
G_PARAM_SPEC_GET_CLASS
|
||||
G_PARAM_SPEC_TYPE_NAME
|
||||
G_PARAM_SPEC_VALUE_TYPE
|
||||
G_TYPE_IS_PARAM
|
||||
GParamSpec
|
||||
GParamSpecClass
|
||||
GParamFlags
|
||||
G_PARAM_READWRITE
|
||||
G_PARAM_MASK
|
||||
G_PARAM_USER_SHIFT
|
||||
GParamFlags
|
||||
g_param_spec_ref
|
||||
g_param_spec_unref
|
||||
g_param_spec_sink
|
||||
g_param_value_set_default
|
||||
g_param_value_defaults
|
||||
g_param_value_validate
|
||||
g_param_value_convert
|
||||
g_param_values_cmp
|
||||
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
|
||||
GParamSpecTypeInfo
|
||||
g_param_type_register_static
|
||||
GParamSpecPool
|
||||
|
||||
@ -1,3 +1,23 @@
|
||||
<!-- ##### SECTION ./tmpl/param_specs.sgml:Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION ./tmpl/param_specs.sgml:See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION ./tmpl/param_specs.sgml:Short_Description ##### -->
|
||||
|
||||
|
||||
|
||||
<!-- ##### SECTION ./tmpl/param_specs.sgml:Title ##### -->
|
||||
Parameter Specifications
|
||||
|
||||
|
||||
<!-- ##### STRUCT GBoxed ##### -->
|
||||
<para>
|
||||
|
||||
|
||||
@ -1,82 +1,27 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Parameter Specifications
|
||||
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
Parameter Specifications
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
#GParamSpec is an object structure that encapsulates the meta data
|
||||
required to specify parameters, such as e.g. #GObject properties.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
g_object_class_install_property(), g_object_set(), g_object_get(),
|
||||
g_object_set_property(), g_object_get_property()
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GParamSpec ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_type_instance:
|
||||
@name:
|
||||
@flags:
|
||||
@value_type:
|
||||
@owner_type:
|
||||
|
||||
<!-- ##### STRUCT GParamSpecClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
Retrive the #GType of this @pspec.
|
||||
</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_PARAM_SPEC_VALUE_TYPE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### MACRO G_TYPE_IS_PARAM ##### -->
|
||||
@ -87,62 +32,181 @@ Parameter Specifications
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_READWRITE ##### -->
|
||||
<!-- ##### MACRO G_PARAM_SPEC ##### -->
|
||||
<para>
|
||||
Cast a derived #GParamSpec object (e.g. of type #GParamSpecInt) into
|
||||
a #GParamSpec object.
|
||||
</para>
|
||||
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### MACRO G_IS_PARAM_SPEC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_GET_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_TYPE_NAME ##### -->
|
||||
<para>
|
||||
Retrive the #GType name of this @pspec.
|
||||
</para>
|
||||
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_SPEC_VALUE_TYPE ##### -->
|
||||
<para>
|
||||
Retrive the #GType to intiialize a #GValue for this parameter.
|
||||
</para>
|
||||
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### STRUCT GParamSpec ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@g_type_instance: private #GTypeInstance portion
|
||||
@name: name of this parameter
|
||||
@flags: #GParamFlags flags for this parameter
|
||||
@value_type: the #GValue type for this parameter
|
||||
@owner_type: #GType type that uses (introduces) this paremeter
|
||||
|
||||
<!-- ##### STRUCT GParamSpecClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GParamFlags ##### -->
|
||||
<para>
|
||||
Through the #GParamFlags flag values, certain aspects of parameters
|
||||
can be configured.
|
||||
</para>
|
||||
|
||||
@G_PARAM_READABLE: the parameter is readable
|
||||
@G_PARAM_WRITABLE: the parameter is writable
|
||||
@G_PARAM_CONSTRUCT: the parameter will be set upon object construction
|
||||
@G_PARAM_CONSTRUCT_ONLY: the parameter will only be set upon object construction
|
||||
@G_PARAM_LAX_VALIDATION: upon parameter conversion (see g_param_value_convert())
|
||||
strict validation is not required
|
||||
@G_PARAM_PRIVATE:
|
||||
|
||||
<!-- ##### MACRO G_PARAM_READWRITE ##### -->
|
||||
<para>
|
||||
#GParamFlags value alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_MASK ##### -->
|
||||
<para>
|
||||
|
||||
Mask containing the bits of #GParamSpec.flags which are reserved for GLib.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO G_PARAM_USER_SHIFT ##### -->
|
||||
<para>
|
||||
|
||||
Minimum shift count to be used for user defined flags, to be stored in
|
||||
#GParamSpec.flags.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### ENUM GParamFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@G_PARAM_READABLE:
|
||||
@G_PARAM_WRITABLE:
|
||||
@G_PARAM_CONSTRUCT:
|
||||
@G_PARAM_CONSTRUCT_ONLY:
|
||||
@G_PARAM_LAX_VALIDATION:
|
||||
@G_PARAM_PRIVATE:
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_ref ##### -->
|
||||
<para>
|
||||
|
||||
Increment the reference count of @pspec.
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@Returns:
|
||||
@pspec: a valid #GParamSpec
|
||||
@Returns: the #GParamSpec that was passed into this function
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_unref ##### -->
|
||||
<para>
|
||||
|
||||
Decrement the reference count of a @pspec.
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_sink ##### -->
|
||||
<para>
|
||||
The initial reference count of a newly created #GParamSpec is 1,
|
||||
eventhough no one has explicitely called g_param_spec_ref() on it yet.
|
||||
So the einital reference count is flagged as "floating", untill someone
|
||||
calls: g_param_spec_ref (@pspec); g_param_spec_sink (@pspec);
|
||||
in sequence on it, taking over the initial reference count (thus
|
||||
ending up with a @pspec that has a reference count of 1 still, but is
|
||||
not flagged "floating" anymore).
|
||||
</para>
|
||||
|
||||
@pspec: a valid #GParamSpec
|
||||
|
||||
|
||||
<!-- ##### 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_value_convert ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest_value_spec:
|
||||
@src_value:
|
||||
@dest_value:
|
||||
@strict_validation:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_values_cmp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION g_param_spec_get_qdata ##### -->
|
||||
@ -186,46 +250,6 @@ Parameter Specifications
|
||||
@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:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GParamSpecTypeInfo ##### -->
|
||||
<para>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user