luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-12 10:45:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Additions.

Browse Source
This commit is contained in:
Matthias Clasen 2003-03-27 23:17:59 +00:00
parent d34ab625bc
commit 46ae53a931
2 changed files with 163 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,6 +1,9 @@
2003-03-28 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/param_value_types.sgml: Additions.
2003-03-25 Matthias Clasen <maclas@gmx.de> 2003-03-25 Matthias Clasen <maclas@gmx.de>
* gobject/tmpl/param_value_types.sgml:
* gobject/tmpl/objects.sgml: Additions. * gobject/tmpl/objects.sgml: Additions.
2003-03-24 Matthias Clasen <maclas@gmx.de> 2003-03-24 Matthias Clasen <maclas@gmx.de>

283
docs/reference/gobject/tmpl/param_value_types.sgml
View File

@ -894,43 +894,48 @@ The #GType of #GParamSpecEnum.
<!-- ##### STRUCT GParamSpecEnum ##### --> <!-- ##### STRUCT GParamSpecEnum ##### -->
<para> <para>
A #GParamSpec derived structure that contains the meta data for enum
properties.
</para> </para>
@parent_instance: @parent_instance: private #GParamSpec portion
@enum_class: @enum_class: the #GEnumClass for the enum
@default_value: @default_value: default value for the property specified
<!-- ##### FUNCTION g_param_spec_enum ##### --> <!-- ##### FUNCTION g_param_spec_enum ##### -->
<para> <para>
Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM
property.
</para>
<para>
See g_param_spec_internal() for details on property names.
</para> </para>
@name: @name: canonical name of the property specified
@nick: @nick: nick name for the property specified
@blurb: @blurb: description of the property specified
@enum_type: @enum_type: a #GType derived from %G_TYPE_ENUM
@default_value: @default_value: default value for the property specified
@flags: @flags: flags for the property specified
@Returns: @Returns: a newly created parameter specification
<!-- ##### FUNCTION g_value_set_enum ##### --> <!-- ##### FUNCTION g_value_set_enum ##### -->
<para> <para>
Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_ENUM
@v_enum: @v_enum: enum value to be set
<!-- ##### FUNCTION g_value_get_enum ##### --> <!-- ##### FUNCTION g_value_get_enum ##### -->
<para> <para>
Get the contents of a %G_TYPE_ENUM #GValue.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_ENUM
@Returns: @Returns: enum contents of @value
<!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
@ -943,7 +948,7 @@ Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS.
<!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### --> <!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
<para> <para>
Cast a #GParamSpec instance into a #GParamSpecChar. Cast a #GParamSpec instance into a #GParamSpecFlags.
</para> </para>
@pspec: a valid #GParamSpec instance @pspec: a valid #GParamSpec instance
@ -966,43 +971,49 @@ The #GType of #GParamSpecFlags.
<!-- ##### STRUCT GParamSpecFlags ##### --> <!-- ##### STRUCT GParamSpecFlags ##### -->
<para> <para>
A #GParamSpec derived structure that contains the meta data for flags
properties.
</para> </para>
@parent_instance: @parent_instance: private #GParamSpec portion
@flags_class: @flags_class: the #GFlagsClass for the flags
@default_value: @default_value: default value for the property specified
<!-- ##### FUNCTION g_param_spec_flags ##### --> <!-- ##### FUNCTION g_param_spec_flags ##### -->
<para> <para>
Creates a new #GParamSpecEnum instance specifying a %G_TYPE_FLAGS
property.
</para>
<para>
See g_param_spec_internal() for details on property names.
</para> </para>
@name: @name: canonical name of the property specified
@nick: @nick: nick name for the property specified
@blurb: @blurb: description of the property specified
@flags_type: @flags_type: a #GType derived from %G_TYPE_FLAGS
@default_value: @default_value: default value for the property specified
@flags: @flags: flags for the property specified
@Returns: @Returns: a newly created parameter specification
<!-- ##### FUNCTION g_value_set_flags ##### --> <!-- ##### FUNCTION g_value_set_flags ##### -->
<para> <para>
Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_FLAGS
@v_flags: @v_flags: flags value to be set
<!-- ##### FUNCTION g_value_get_flags ##### --> <!-- ##### FUNCTION g_value_get_flags ##### -->
<para> <para>
Get the contents of a %G_TYPE_FLAGS #GValue.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_FLAGS
@Returns: @Returns: flags contents of @value
<!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
@ -1038,16 +1049,17 @@ The #GType of #GParamSpecString.
<!-- ##### STRUCT GParamSpecString ##### --> <!-- ##### STRUCT GParamSpecString ##### -->
<para> <para>
A #GParamSpec derived structure that contains the meta data for string
properties.
</para> </para>
@parent_instance: @parent_instance: private #GParamSpec portion
@default_value: @default_value: default value for the property specified
@cset_first: @cset_first: a string containing the allowed values for the first byte
@cset_nth: @cset_nth: a string containing the allowed values for the subsequent bytes
@substitutor: @substitutor: the replacement byte for bytes which don't match @cset_first or @cset_nth.
@null_fold_if_empty: @null_fold_if_empty: replace empty string by %NULL
@ensure_non_null: @ensure_non_null: replace %NULL strings by an empty string
<!-- ##### TYPEDEF gchararray ##### --> <!-- ##### TYPEDEF gchararray ##### -->
<para> <para>
@ -1057,60 +1069,68 @@ The #GType of #GParamSpecString.
<!-- ##### FUNCTION g_param_spec_string ##### --> <!-- ##### FUNCTION g_param_spec_string ##### -->
<para> <para>
Creates a new #GParamSpecString instance.
</para>
<para>
See g_param_spec_internal() for details on property names.
</para> </para>
@name: @name: canonical name of the property specified
@nick: @nick: nick name for the property specified
@blurb: @blurb: description of the property specified
@default_value: @default_value: default value for the property specified
@flags: @flags: flags for the property specified
@Returns: @Returns: a newly created parameter specification
<!-- ##### FUNCTION g_value_set_string ##### --> <!-- ##### FUNCTION g_value_set_string ##### -->
<para> <para>
Set the contents of a %G_TYPE_STRING #GValue to @v_string.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_STRING
@v_string: @v_string: string to be set
<!-- ##### FUNCTION g_value_set_static_string ##### --> <!-- ##### FUNCTION g_value_set_static_string ##### -->
<para> <para>
Set the contents of a %G_TYPE_STRING #GValue to @v_string.
The string is assumed to be static, and is thus not duplicated
when setting the #GValue.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_STRING
@v_string: @v_string: static string to be set
<!-- ##### FUNCTION g_value_set_string_take_ownership ##### --> <!-- ##### FUNCTION g_value_set_string_take_ownership ##### -->
<para> <para>
This is an internal function introduced mainly for C marshallers.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_STRING
@v_string: @v_string: duplicated unowned string to be set
@value: a valid #GValue
@v_string: string to be set
<!-- ##### FUNCTION g_value_get_string ##### --> <!-- ##### FUNCTION g_value_get_string ##### -->
<para> <para>
Get the contents of a %G_TYPE_STRING #GValue.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_STRING
@Returns: @Returns: string content of @value
<!-- ##### FUNCTION g_value_dup_string ##### --> <!-- ##### FUNCTION g_value_dup_string ##### -->
<para> <para>
Get a copy the contents of a %G_TYPE_STRING #GValue.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_STRING
@Returns: @Returns: a newly allocated copy of the string content of @value
<!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
@ -1146,58 +1166,65 @@ The #GType of #GParamSpecParam.
<!-- ##### STRUCT GParamSpecParam ##### --> <!-- ##### STRUCT GParamSpecParam ##### -->
<para> <para>
A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM
properties.
</para> </para>
@parent_instance: @parent_instance: private #GParamSpec portion
<!-- ##### FUNCTION g_param_spec_param ##### --> <!-- ##### FUNCTION g_param_spec_param ##### -->
<para> <para>
Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM
property.
</para>
<para>
See g_param_spec_internal() for details on property names.
</para> </para>
@name: @name: canonical name of the property specified
@nick: @nick: nick name for the property specified
@blurb: @blurb: description of the property specified
@param_type: @param_type: a #GType derived from %G_TYPE_PARAM
@flags: @default_value: default value for the property specified
@Returns: @flags: flags for the property specified
@Returns: a newly created parameter specification
<!-- ##### FUNCTION g_value_set_param ##### --> <!-- ##### FUNCTION g_value_set_param ##### -->
<para> <para>
Set the contents of a %G_TYPE_PARAM #GValue to @param.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_PARAM
@param: @param: the #GParamSpec to be set
<!-- ##### FUNCTION g_value_set_param_take_ownership ##### --> <!-- ##### FUNCTION g_value_set_param_take_ownership ##### -->
<para> <para>
This is an internal function introduced mainly for C marshallers.
</para> </para>
@value: @value: a valid #GValue of type %G_TYPE_PARAM
@param: @param: the #GParamSpec to be set
<!-- ##### FUNCTION g_value_get_param ##### --> <!-- ##### FUNCTION g_value_get_param ##### -->
<para> <para>
Get the contents of a %G_TYPE_PARAM #GValue.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_PARAM
@Returns: @Returns: #GParamSpec content of @value
<!-- ##### FUNCTION g_value_dup_param ##### --> <!-- ##### FUNCTION g_value_dup_param ##### -->
<para> <para>
Get the contents of a %G_TYPE_PARAM #GValue, increasing its reference count.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_PARAM
@Returns: @Returns: #GParamSpec content of @value, should be unreferenced when no longer needed.
<!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### -->
@ -1322,7 +1349,6 @@ Casts a #GParamSpec instance into a #GParamSpecPointer.
<!-- ##### MACRO G_VALUE_HOLDS_POINTER ##### --> <!-- ##### MACRO G_VALUE_HOLDS_POINTER ##### -->
<para> <para>
Return whether the given #GValue can hold values of type %G_TYPE_POINTER. Return whether the given #GValue can hold values of type %G_TYPE_POINTER.
</para> </para>
@value: a valid #GValue structure @value: a valid #GValue structure
@ -1337,39 +1363,43 @@ The #GType of #GParamSpecPointer.
<!-- ##### STRUCT GParamSpecPointer ##### --> <!-- ##### STRUCT GParamSpecPointer ##### -->
<para> <para>
A #GParamSpec derived structure that contains the meta data for pointer properties.
</para> </para>
@parent_instance: @parent_instance: private #GParamSpec portion
<!-- ##### FUNCTION g_param_spec_pointer ##### --> <!-- ##### FUNCTION g_param_spec_pointer ##### -->
<para> <para>
Creates a new #GParamSpecPoiner instance specifying a pointer property.
</para>
<para>
See g_param_spec_internal() for details on property names.
</para> </para>
@name: @name: canonical name of the property specified
@nick: @nick: nick name for the property specified
@blurb: @blurb: description of the property specified
@flags: @flags: flags for the property specified
@Returns: @Returns: a newly created parameter specification
<!-- ##### FUNCTION g_value_set_pointer ##### --> <!-- ##### FUNCTION g_value_set_pointer ##### -->
<para> <para>
Set the contents of a pointer #GValue to @v_pointer.
</para> </para>
@value: @value: a valid #GValue of %G_TYPE_POINTER
@v_pointer: @v_pointer: pointer value to be set
<!-- ##### FUNCTION g_value_get_pointer ##### --> <!-- ##### FUNCTION g_value_get_pointer ##### -->
<para> <para>
Get the contents of a pointer #GValue.
</para> </para>
@value: @value: a valid #GValue of %G_TYPE_POINTER
@Returns: @Returns: pointer contents of @value
<!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
@ -1405,58 +1435,63 @@ The #GType of #GParamSpecObject.
<!-- ##### STRUCT GParamSpecObject ##### --> <!-- ##### STRUCT GParamSpecObject ##### -->
<para> <para>
A #GParamSpec derived structure that contains the meta data for object properties.
</para> </para>
@parent_instance: @parent_instance: private #GParamSpec portion
<!-- ##### FUNCTION g_param_spec_object ##### --> <!-- ##### FUNCTION g_param_spec_object ##### -->
<para> <para>
Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT
derived property.
</para>
<para>
See g_param_spec_internal() for details on property names.
</para> </para>
@name: @name: canonical name of the property specified
@nick: @nick: nick name for the property specified
@blurb: @blurb: description of the property specified
@object_type: @object_type: %G_TYPE_OBJECT derived type of this property
@flags: @flags: flags for the property specified
@Returns: @Returns: a newly created parameter specification
<!-- ##### FUNCTION g_value_set_object ##### --> <!-- ##### FUNCTION g_value_set_object ##### -->
<para> <para>
Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
</para> </para>
@value: @value: a valid #GValue of %G_TYPE_OBJECT derived type
@v_object: @v_object: object value to be set
<!-- ##### FUNCTION g_value_set_object_take_ownership ##### --> <!-- ##### FUNCTION g_value_set_object_take_ownership ##### -->
<para> <para>
This is an internal function introduced mainly for C marshallers.
</para> </para>
@value: @value: a valid #GValue of %G_TYPE_OBJECT derived type
@v_object: @v_object: object value to be set
<!-- ##### FUNCTION g_value_get_object ##### --> <!-- ##### FUNCTION g_value_get_object ##### -->
<para> <para>
Get the contents of a %G_TYPE_OBJECT derived #GValue.
</para> </para>
@value: @value: a valid #GValue of %G_TYPE_OBJECT derived type
@Returns: @Returns: object contents of @value
<!-- ##### FUNCTION g_value_dup_object ##### --> <!-- ##### FUNCTION g_value_dup_object ##### -->
<para> <para>
Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing its reference count.
</para> </para>
@value: @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
@Returns: @Returns: object content of @value, should be unreferenced when no longer needed.
<!-- ##### MACRO G_IS_PARAM_SPEC_UNICHAR ##### --> <!-- ##### MACRO G_IS_PARAM_SPEC_UNICHAR ##### -->