param_value_types.sgml

This GLib version 2.16.1. GLib is the low-level core library that forms the basis for projects such

<!-- ##### STRUCT GParamSpecEnum ##### -->
<para>
A #GParamSpec derived structure that contains the meta data for enum 
properties.
</para>

@parent_instance: private #GParamSpec portion
@enum_class: the #GEnumClass for the enum
@default_value:   default value for the property specified

<!-- ##### FUNCTION g_param_spec_enum ##### -->
<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>

@name:          canonical name of the property specified
@nick:          nick name for the property specified
@blurb:         description of the property specified
@enum_type:     a #GType derived from %G_TYPE_ENUM
@default_value: default value for the property specified
@flags:         flags for the property specified
@Returns:  a newly created parameter specification


<!-- ##### FUNCTION g_value_set_enum ##### -->
<para>
Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.
</para>

@value:  a valid #GValue whose type is derived from %G_TYPE_ENUM
@v_enum: enum value to be set


<!-- ##### FUNCTION g_value_get_enum ##### -->
<para>
Get the contents of a %G_TYPE_ENUM #GValue.
</para>

@value:   a valid #GValue whose type is derived from %G_TYPE_ENUM
@Returns: enum contents of @value


<!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS.
</para>

@pspec:  a valid #GParamSpec instance


<!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
<para>
Cast a #GParamSpec instance into a #GParamSpecFlags.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_VALUE_HOLDS_FLAGS ##### -->
<para>
Returns whether the given #GValue can hold values derived from type %G_TYPE_FLAGS.
</para>

@value: a valid #GValue structure


<!-- ##### MACRO G_TYPE_PARAM_FLAGS ##### -->
<para>
The #GType of #GParamSpecFlags.
</para>



<!-- ##### STRUCT GParamSpecFlags ##### -->
<para>
A #GParamSpec derived structure that contains the meta data for flags
properties.
</para>

@parent_instance: private #GParamSpec portion
@flags_class: the #GFlagsClass for the flags
@default_value:   default value for the property specified

<!-- ##### FUNCTION g_param_spec_flags ##### -->
<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>

@name:          canonical name of the property specified
@nick:          nick name for the property specified
@blurb:         description of the property specified
@flags_type:     a #GType derived from %G_TYPE_FLAGS
@default_value: default value for the property specified
@flags:         flags for the property specified
@Returns:  a newly created parameter specification


<!-- ##### FUNCTION g_value_set_flags ##### -->
<para>
Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.
</para>

@value:  a valid #GValue whose type is derived from %G_TYPE_FLAGS
@v_flags: flags value to be set


<!-- ##### FUNCTION g_value_get_flags ##### -->
<para>
Get the contents of a %G_TYPE_FLAGS #GValue.
</para>

@value:   a valid #GValue whose type is derived from %G_TYPE_FLAGS
@Returns: flags contents of @value


<!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_PARAM_SPEC_STRING ##### -->
<para>
Casts a #GParamSpec instance into a #GParamSpecString.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_VALUE_HOLDS_STRING ##### -->
<para>
Return whether the given #GValue can hold values of type %G_TYPE_STRING.
</para>

@value: a valid #GValue structure


<!-- ##### MACRO G_TYPE_PARAM_STRING ##### -->
<para>
The #GType of #GParamSpecString.
</para>



<!-- ##### STRUCT GParamSpecString ##### -->
<para>
A #GParamSpec derived structure that contains the meta data for string
properties.
</para>

@parent_instance: private #GParamSpec portion
@default_value:   default value for the property specified
@cset_first: a string containing the allowed values for the first byte
@cset_nth: a string containing the allowed values for the subsequent bytes
@substitutor: the replacement byte for bytes which don't match @cset_first or @cset_nth.
@null_fold_if_empty: replace empty string by %NULL
@ensure_non_null:  replace %NULL strings by an empty string

<!-- ##### TYPEDEF gchararray ##### -->
<para>
A C representable type name for #G_TYPE_STRING.
</para>


<!-- ##### FUNCTION g_param_spec_string ##### -->
<para>
Creates a new #GParamSpecString instance.
</para>
<para> 
See g_param_spec_internal() for details on property names.
</para>

@name:          canonical name of the property specified
@nick:          nick name for the property specified
@blurb:         description of the property specified
@default_value: default value for the property specified
@flags:         flags for the property specified
@Returns:  a newly created parameter specification


<!-- ##### FUNCTION g_value_set_string ##### -->
<para>
Set the contents of a %G_TYPE_STRING #GValue to @v_string.
</para>

@value:  a valid #GValue of type %G_TYPE_STRING
@v_string: string to be set


<!-- ##### FUNCTION g_value_set_static_string ##### -->
<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>

@value:  a valid #GValue of type %G_TYPE_STRING
@v_string: static string to be set


<!-- ##### FUNCTION g_value_take_string ##### -->
<para>
Sets the contents of a %G_TYPE_STRING #GValue to @v_string.
</para>

@value:   a valid #GValue of type %G_TYPE_STRING
@v_string: duplicated unowned string to be set
@Since: 2.4


<!-- ##### FUNCTION g_value_set_string_take_ownership ##### -->
<para>
This is an internal function introduced mainly for C marshallers.
</para>

@value:   a valid #GValue of type %G_TYPE_STRING
@v_string: duplicated unowned string to be set
@Deprecated: 2.4: Use g_value_take_string() instead.


<!-- ##### FUNCTION g_value_get_string ##### -->
<para>
Get the contents of a %G_TYPE_STRING #GValue.
</para>

@value:   a valid #GValue of type %G_TYPE_STRING
@Returns: string content of @value


<!-- ##### FUNCTION g_value_dup_string ##### -->
<para>
Get a copy the contents of a %G_TYPE_STRING #GValue.
</para>

@value:   a valid #GValue of type %G_TYPE_STRING
@Returns: a newly allocated copy of the string content of @value


<!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
<para>
Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
<para>
Casts a #GParamSpec instance into a #GParamSpecParam.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_VALUE_HOLDS_PARAM ##### -->
<para>
Return whether the given #GValue can hold values derived from type %G_TYPE_PARAM.
</para>

@value: a valid #GValue structure


<!-- ##### MACRO G_TYPE_PARAM_PARAM ##### -->
<para>
The #GType of #GParamSpecParam.
</para>



<!-- ##### STRUCT GParamSpecParam ##### -->
<para>
A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM
properties.
</para>

@parent_instance: private #GParamSpec portion

<!-- ##### FUNCTION g_param_spec_param ##### -->
<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>

@name:          canonical name of the property specified
@nick:          nick name for the property specified
@blurb:         description of the property specified
@param_type:    a #GType derived from %G_TYPE_PARAM
@flags:         flags for the property specified
@Returns:  a newly created parameter specification
<!-- # Unused Parameters # -->
@default_value: default value for the property specified


<!-- ##### FUNCTION g_value_set_param ##### -->
<para>
Set the contents of a %G_TYPE_PARAM #GValue to @param.
</para>

@value:  a valid #GValue of type %G_TYPE_PARAM
@param: the #GParamSpec to be set


<!-- ##### FUNCTION g_value_take_param ##### -->
<para>
Sets the contents of a %G_TYPE_PARAM #GValue to @param and
takes over the ownership of the callers reference to @param; 
the caller doesn't have to unref it any more.
</para>

@value:  a valid #GValue of type %G_TYPE_PARAM
@param: the #GParamSpec to be set
@Since: 2.4


<!-- ##### FUNCTION g_value_set_param_take_ownership ##### -->
<para>
This is an internal function introduced mainly for C marshallers.
</para>

@value:  a valid #GValue of type %G_TYPE_PARAM
@param: the #GParamSpec to be set
@Deprecated: 2.4: Use g_value_take_param() instead.


<!-- ##### FUNCTION g_value_get_param ##### -->
<para>
Get the contents of a %G_TYPE_PARAM #GValue.
</para>

@value: a valid #GValue whose type is derived from %G_TYPE_PARAM
@Returns: #GParamSpec content of @value


<!-- ##### FUNCTION g_value_dup_param ##### -->
<para>
Get the contents of a %G_TYPE_PARAM #GValue, increasing its reference count.
</para>

@value: a valid #GValue whose type is derived from %G_TYPE_PARAM
@Returns: #GParamSpec content of @value, should be unreferenced when no longer needed.


<!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### -->
<para>
Return whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_PARAM_SPEC_BOXED ##### -->
<para>
Cast a #GParamSpec instance into a #GParamSpecBoxed.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_VALUE_HOLDS_BOXED ##### -->
<para>
Return whether the given #GValue can hold values derived from type %G_TYPE_BOXED.
</para>

@value: a valid #GValue structure


<!-- ##### MACRO G_TYPE_PARAM_BOXED ##### -->
<para>
The #GType of #GParamSpecBoxed.
</para>



<!-- ##### STRUCT GParamSpecBoxed ##### -->
<para>
A #GParamSpec derived structure that contains the meta data for boxed properties.
</para>

@parent_instance: private #GParamSpec portion

<!-- ##### FUNCTION g_param_spec_boxed ##### -->
<para>
Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED 
derived property.
</para>
<para> 
See g_param_spec_internal() for details on property names.
</para>

@name:          canonical name of the property specified
@nick:          nick name for the property specified
@blurb:         description of the property specified
@boxed_type:    %G_TYPE_BOXED derived type of this property
@flags:         flags for the property specified
@Returns: a newly created parameter specification


<!-- ##### FUNCTION g_value_set_boxed ##### -->
<para>
Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
</para>

@value:   a valid #GValue of %G_TYPE_BOXED derived type
@v_boxed: boxed value to be set


<!-- ##### FUNCTION g_value_set_static_boxed ##### -->
<para>
Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
The boxed value is assumed to be static, and is thus not duplicated
when setting the #GValue.
</para>

@value:   a valid #GValue of %G_TYPE_BOXED derived type
@v_boxed: static boxed value to be set


<!-- ##### FUNCTION g_value_take_boxed ##### -->
<para>
Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed and
takes over the ownership of the callers reference to @v_boxed; 
the caller doesn't have to unref it any more.
</para>

@value: a valid #GValue of %G_TYPE_BOXED derived type
@v_boxed: duplicated unowned boxed value to be set
@Since: 2.4


<!-- ##### FUNCTION g_value_set_boxed_take_ownership ##### -->
<para>
This is an internal function introduced mainly for C marshallers.
</para>

@value:   a valid #GValue of %G_TYPE_BOXED derived type
@v_boxed: duplicated unowned boxed value to be set
@Deprecated: 2.4: Use g_value_take_boxed() instead.