2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
2000-10-30 06:03:19 +01:00
|
|
|
Parameter Specifications
|
2000-09-06 06:32:45 +02:00
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpec ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
2000-12-29 16:11:03 +01:00
|
|
|
@g_type_instance:
|
2000-09-06 06:32:45 +02:00
|
|
|
@name:
|
|
|
|
|
@nick:
|
|
|
|
|
@blurb:
|
|
|
|
|
@flags:
|
2000-12-29 16:11:03 +01:00
|
|
|
@value_type:
|
2001-06-19 14:13:22 +02:00
|
|
|
@owner_type:
|
2000-09-06 06:32:45 +02:00
|
|
|
|
|
|
|
|
<!-- ##### 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_PARAM_SPEC_VALUE_TYPE ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_TYPE_IS_PARAM ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@type:
|
|
|
|
|
|
|
|
|
|
|
2001-01-31 07:27:41 +01:00
|
|
|
<!-- ##### MACRO G_PARAM_READWRITE ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_MASK ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_USER_SHIFT ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### ENUM GParamFlags ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@G_PARAM_READABLE:
|
|
|
|
|
@G_PARAM_WRITABLE:
|
2000-12-29 16:11:03 +01:00
|
|
|
@G_PARAM_CONSTRUCT:
|
|
|
|
|
@G_PARAM_CONSTRUCT_ONLY:
|
changed prototype of g_boxed_type_register_static() to contain an optional
Wed Mar 7 09:36:33 2001 Tim Janik <timj@gtk.org>
* gboxed.[hc]: changed prototype of g_boxed_type_register_static()
to contain an optional init function and a hint at whether the
boxed structure uses ref counting internally.
added g_value_set_boxed_take_ownership().
made G_TYPE_BOXED an abstract value type.
* genums.[hc]: made G_TYPE_ENUM and G_TYPE_FLAGS abstract value
types.
* glib-genmarshal.c: argument type changes, preparation for third-party
arg specification.
* gobject.[hc]: cleaned up get/set property code.
added g_strdup_value_contents() to improve warnings.
* gparam.[hc]: added g_param_value_convert(), taking over responsibility
of the old g_value_convert(). added G_PARAM_LAX_VALIDATION flag so
validation alterations may be valid a part of the property setting
process.
* gparamspecs.[hc]: made value comparisons stable (for sort applications).
added GParamSpecValueArray, a param spec for value arrays and
GParamSpecClosure. nuked the value exchange functions and
GParamSpecCCallback.
* gtype.[hc]: catch unintialized usages of the type system with
g_return_val_if_uninitialized(). introduced G_TYPE_FLAG_VALUE_ABSTRACT
to flag types that introduce a value table, but can't be used for
g_value_init(). cleaned up reserved type ids.
* gvalue.[hc]: code cleanups and saner checking.
nuked the value exchange API. implemented value transformations, we
can't really "convert" values, rather transforms are an anylogy to
C casts, real conversions need a param spec for validation, which is
why g_param_value_convert() does real conversions now.
* gvaluearray.[hc]: new files that implement a GValueArray, a struct
that can hold inhomogeneous arrays of value (to that extend that it
also allowes undefined values, i.e. G_VALUE_TYPE(value)==0).
this is exposed to the type system as a boxed type.
* gvaluetransform.c: new file implementing most of the former value
exchange functions as single-sided transformations.
* gvaluetypes.[hc]: nuked G_TYPE_CCALLBACK, added
g_value_set_string_take_ownership().
* *.h: s/G_IS_VALUE_/G_VALUE_HOLDS_/.
* *.[hc]: many fixes and cleanups.
* many warning improvements.
Tue Feb 27 18:35:15 2001 Tim Janik <timj@gtk.org>
* gobject.c (g_object_get_valist): urg, pass G_VALUE_NOCOPY_CONTENTS
into G_VALUE_LCOPY(), this needs proper documenting.
* gparam.c: fixed G_PARAM_USER_MASK.
* gtype.c (type_data_make_W):
(type_data_last_unref_Wm): fixed invalid memory freeing.
* gobject.c (g_object_last_unref): destroy signal handlers associated
with object, right before finalization.
* gsignal.c (g_signal_parse_name): catch destroyed nodes or signals
that don't actually support details.
* gobject.[hc]: got rid of property trailers. nuked GObject
properties "data" and the "signal" variants.
(g_object_connect): new convenience function to do multiple
signal connections at once.
(g_object_disconnect): likewise, for disconnections.
* gparam.[hc] (g_param_spec_pool_lookup): took out trailer support.
* gvalue.[hc]: marked g_value_fits_pointer() and g_value_peek_pointer()
as private (the latter got renamed from g_value_get_as_pointer()).
Wed Mar 7 09:32:06 2001 Tim Janik <timj@gtk.org>
* glib-object.h: add gvaluearray.h.
* gstring.[hc]: fixup naming of g_string_sprint*.
* gtypes.h: fixed GCompareDataFunc naming.
Wed Mar 7 09:33:27 2001 Tim Janik <timj@gtk.org>
* gobject/Makefile.am: shuffled rules to avoid excessive
rebuilds.
* gobject/gobject-sections.txt: updates.
* gobject/tmpl/*: bunch of updates, added another patch
from Eric Lemings <eric.b.lemings@lmco.com>.
2001-03-07 15:46:45 +01:00
|
|
|
@G_PARAM_LAX_VALIDATION:
|
2000-12-29 16:11:03 +01:00
|
|
|
@G_PARAM_PRIVATE:
|
2000-09-06 06:32:45 +02:00
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_ref ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_unref ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
2001-01-09 03:18:57 +01:00
|
|
|
<!-- ##### FUNCTION g_param_spec_sink ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
|
|
|
|
|
2001-01-31 07:27:41 +01:00
|
|
|
<!-- ##### STRUCT GParamSpecTypeInfo ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@instance_size:
|
|
|
|
|
@n_preallocs:
|
|
|
|
|
@instance_init:
|
|
|
|
|
@value_type:
|
|
|
|
|
@finalize:
|
|
|
|
|
@value_set_default:
|
|
|
|
|
@value_validate:
|
|
|
|
|
@values_cmp:
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_type_register_static ##### -->
|
2000-09-06 06:32:45 +02:00
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@name:
|
2001-01-31 07:27:41 +01:00
|
|
|
@pspec_info:
|
2000-09-06 06:32:45 +02:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
2001-01-31 07:27:41 +01:00
|
|
|
<!-- ##### STRUCT GParamSpecPool ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
2001-01-09 03:18:57 +01:00
|
|
|
<!-- ##### FUNCTION g_param_spec_pool_new ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@type_prefixing:
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_pool_insert ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pool:
|
|
|
|
|
@pspec:
|
|
|
|
|
@owner_type:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_pool_remove ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pool:
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_pool_lookup ##### -->
|
|
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
@pool:
|
|
|
|
|
@param_name:
|
|
|
|
|
@owner_type:
|
|
|
|
|
@walk_ancestors:
|
|
|
|
|
@Returns:
|
changed prototype of g_boxed_type_register_static() to contain an optional
Wed Mar 7 09:36:33 2001 Tim Janik <timj@gtk.org>
* gboxed.[hc]: changed prototype of g_boxed_type_register_static()
to contain an optional init function and a hint at whether the
boxed structure uses ref counting internally.
added g_value_set_boxed_take_ownership().
made G_TYPE_BOXED an abstract value type.
* genums.[hc]: made G_TYPE_ENUM and G_TYPE_FLAGS abstract value
types.
* glib-genmarshal.c: argument type changes, preparation for third-party
arg specification.
* gobject.[hc]: cleaned up get/set property code.
added g_strdup_value_contents() to improve warnings.
* gparam.[hc]: added g_param_value_convert(), taking over responsibility
of the old g_value_convert(). added G_PARAM_LAX_VALIDATION flag so
validation alterations may be valid a part of the property setting
process.
* gparamspecs.[hc]: made value comparisons stable (for sort applications).
added GParamSpecValueArray, a param spec for value arrays and
GParamSpecClosure. nuked the value exchange functions and
GParamSpecCCallback.
* gtype.[hc]: catch unintialized usages of the type system with
g_return_val_if_uninitialized(). introduced G_TYPE_FLAG_VALUE_ABSTRACT
to flag types that introduce a value table, but can't be used for
g_value_init(). cleaned up reserved type ids.
* gvalue.[hc]: code cleanups and saner checking.
nuked the value exchange API. implemented value transformations, we
can't really "convert" values, rather transforms are an anylogy to
C casts, real conversions need a param spec for validation, which is
why g_param_value_convert() does real conversions now.
* gvaluearray.[hc]: new files that implement a GValueArray, a struct
that can hold inhomogeneous arrays of value (to that extend that it
also allowes undefined values, i.e. G_VALUE_TYPE(value)==0).
this is exposed to the type system as a boxed type.
* gvaluetransform.c: new file implementing most of the former value
exchange functions as single-sided transformations.
* gvaluetypes.[hc]: nuked G_TYPE_CCALLBACK, added
g_value_set_string_take_ownership().
* *.h: s/G_IS_VALUE_/G_VALUE_HOLDS_/.
* *.[hc]: many fixes and cleanups.
* many warning improvements.
Tue Feb 27 18:35:15 2001 Tim Janik <timj@gtk.org>
* gobject.c (g_object_get_valist): urg, pass G_VALUE_NOCOPY_CONTENTS
into G_VALUE_LCOPY(), this needs proper documenting.
* gparam.c: fixed G_PARAM_USER_MASK.
* gtype.c (type_data_make_W):
(type_data_last_unref_Wm): fixed invalid memory freeing.
* gobject.c (g_object_last_unref): destroy signal handlers associated
with object, right before finalization.
* gsignal.c (g_signal_parse_name): catch destroyed nodes or signals
that don't actually support details.
* gobject.[hc]: got rid of property trailers. nuked GObject
properties "data" and the "signal" variants.
(g_object_connect): new convenience function to do multiple
signal connections at once.
(g_object_disconnect): likewise, for disconnections.
* gparam.[hc] (g_param_spec_pool_lookup): took out trailer support.
* gvalue.[hc]: marked g_value_fits_pointer() and g_value_peek_pointer()
as private (the latter got renamed from g_value_get_as_pointer()).
Wed Mar 7 09:32:06 2001 Tim Janik <timj@gtk.org>
* glib-object.h: add gvaluearray.h.
* gstring.[hc]: fixup naming of g_string_sprint*.
* gtypes.h: fixed GCompareDataFunc naming.
Wed Mar 7 09:33:27 2001 Tim Janik <timj@gtk.org>
* gobject/Makefile.am: shuffled rules to avoid excessive
rebuilds.
* gobject/gobject-sections.txt: updates.
* gobject/tmpl/*: bunch of updates, added another patch
from Eric Lemings <eric.b.lemings@lmco.com>.
2001-03-07 15:46:45 +01:00
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
|
@trailer_p:
|
2001-01-09 03:18:57 +01:00
|
|
|
|
|
|
|
|
|
2001-01-31 07:27:41 +01:00
|
|
|
<!-- ##### FUNCTION g_param_spec_internal ##### -->
|
2001-01-09 03:18:57 +01:00
|
|
|
<para>
|
|
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
2001-01-31 07:27:41 +01:00
|
|
|
@param_type:
|
2001-01-09 03:18:57 +01:00
|
|
|
@name:
|
2001-01-31 07:27:41 +01:00
|
|
|
@nick:
|
|
|
|
|
@blurb:
|
|
|
|
|
@flags:
|
2001-01-09 03:18:57 +01:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
