diff options
| author | Tim Janik <timj@gtk.org> | 2002-02-07 11:09:26 +0000 |
|---|---|---|
| committer | Tim Janik <timj@src.gnome.org> | 2002-02-07 11:09:26 +0000 |
| commit | a1c162e123d5336ae2bc954f311b4883c860c1f0 (patch) | |
| tree | 4f9b8049ea2f87dc686f666bd3fd2e431ef870c0 /docs | |
| parent | 4e9073509f41818dc529421a160dd616ab9951a4 (diff) | |
document value transformation.
Thu Feb 7 12:07:06 2002 Tim Janik <timj@gtk.org>
* gobject/tmpl/generic_values.sgml: document value transformation.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/ChangeLog | 4 | ||||
| -rw-r--r-- | docs/reference/gobject/tmpl/generic_values.sgml | 24 |
2 files changed, 20 insertions, 8 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 8e04a1b96..eae9dfd5c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +Thu Feb 7 12:07:06 2002 Tim Janik <timj@gtk.org> + + * gobject/tmpl/generic_values.sgml: document value transformation. + Mon Feb 4 17:55:39 2002 Tim Janik <timj@gtk.org> * gobject/tmpl/closures.sgml: doc common functions like ref/ diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml index c0a179017..28222d238 100644 --- a/docs/reference/gobject/tmpl/generic_values.sgml +++ b/docs/reference/gobject/tmpl/generic_values.sgml @@ -185,22 +185,30 @@ This is an internal function introduced mainly for C marshallers. <!-- ##### FUNCTION g_value_type_transformable ##### --> <para> - +Check whether g_value_transform() is able to transform values +of type @src_type into values of type @dest_type. </para> -@src_type: -@dest_type: -@Returns: +@src_type: Source type. +@dest_type: Target type. +@Returns: %TRUE if the transformation is possible, %FALSE otherwise. <!-- ##### FUNCTION g_value_transform ##### --> <para> - +Tries to cast the contents of @src_value into a type apropriate +to store in @dest_value, e.g. to transform a %G_TYPE_INT value +into a %G_TYPE_FLOAT value. Performing transformations between +value types might incour precision lossage. Especially +transformations into strings might reveal seemingly arbitrary +results and shouldn't be relied upon for production code (such +as rcfile value or object property serialization). </para> -@src_value: -@dest_value: -@Returns: +@src_value: Source value. +@dest_value: Target value. +@Returns: Whether a transformation rule was found and could be applied. + Upon failing transformations, @dest_value is left untouched. <!-- ##### USER_FUNCTION GValueTransform ##### --> |