param_value_types.sgml

GLib是GTK+和GNOME工程的基础底层核心程序库

@default_value: 
@cset_first: 
@cset_nth: 
@substitutor: 
@null_fold_if_empty: 
@ensure_non_null: 

<!-- ##### TYPEDEF gchararray ##### -->
<para>

</para>


<!-- ##### FUNCTION g_param_spec_string ##### -->
<para>

</para>

@name: 
@nick: 
@blurb: 
@default_value: 
@flags: 
@Returns: 


<!-- ##### FUNCTION g_value_set_string ##### -->
<para>

</para>

@value: 
@v_string: 


<!-- ##### FUNCTION g_value_set_static_string ##### -->
<para>

</para>

@value: 
@v_string: 


<!-- ##### FUNCTION g_value_set_string_take_ownership ##### -->
<para>

</para>

@value: 
@v_string: 


<!-- ##### FUNCTION g_value_get_string ##### -->
<para>

</para>

@value: 
@Returns: 


<!-- ##### FUNCTION g_value_dup_string ##### -->
<para>

</para>

@value: 
@Returns: 


<!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
<para>

</para>

@pspec: 


<!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
<para>

</para>

@pspec: 


<!-- ##### MACRO G_VALUE_HOLDS_PARAM ##### -->
<para>

</para>

@value: 


<!-- ##### MACRO G_TYPE_PARAM_PARAM ##### -->
<para>

</para>



<!-- ##### STRUCT GParamSpecParam ##### -->
<para>

</para>

@parent_instance: 

<!-- ##### FUNCTION g_param_spec_param ##### -->
<para>

</para>

@name: 
@nick: 
@blurb: 
@param_type: 
@flags: 
@Returns: 


<!-- ##### FUNCTION g_value_set_param ##### -->
<para>

</para>

@value: 
@param: 


<!-- ##### FUNCTION g_value_set_param_take_ownership ##### -->
<para>

</para>

@value: 
@param: 


<!-- ##### FUNCTION g_value_get_param ##### -->
<para>

</para>

@value: 
@Returns: 


<!-- ##### FUNCTION g_value_dup_param ##### -->
<para>

</para>

@value: 
@Returns: 


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

</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>
Create a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED derived property.
</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_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


<!-- ##### FUNCTION g_value_get_boxed ##### -->
<para>
Get the contents of a %G_TYPE_BOXED derived #GValue.
</para>

@value:   a valid #GValue of %G_TYPE_BOXED derived type
@Returns: boxed contents of @value


<!-- ##### FUNCTION g_value_dup_boxed ##### -->
<para>
Get the contents of a %G_TYPE_BOXED derived #GValue.
Upon getting, the boxed value is duplicated and needs to be
later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), return_value);
</para>

@value:   a valid #GValue of %G_TYPE_BOXED derived type
@Returns: boxed contents of @value


<!-- ##### MACRO G_IS_PARAM_SPEC_POINTER ##### -->
<para>

</para>

@pspec: 


<!-- ##### MACRO G_PARAM_SPEC_POINTER ##### -->
<para>

</para>

@pspec: 


<!-- ##### MACRO G_VALUE_HOLDS_POINTER ##### -->
<para>

</para>

@value: 


<!-- ##### MACRO G_TYPE_PARAM_POINTER ##### -->
<para>

</para>



<!-- ##### STRUCT GParamSpecPointer ##### -->
<para>

</para>

@parent_instance: 

<!-- ##### FUNCTION g_param_spec_pointer ##### -->
<para>

</para>

@name: 
@nick: 
@blurb: 
@flags: 
@Returns: 


<!-- ##### FUNCTION g_value_set_pointer ##### -->
<para>

</para>

@value: 
@v_pointer: 


<!-- ##### FUNCTION g_value_get_pointer ##### -->
<para>

</para>

@value: 
@Returns: 


<!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
<para>

</para>

@pspec: 


<!-- ##### MACRO G_PARAM_SPEC_OBJECT ##### -->
<para>

</para>

@pspec: 


<!-- ##### MACRO G_VALUE_HOLDS_OBJECT ##### -->
<para>

</para>

@value: 


<!-- ##### MACRO G_TYPE_PARAM_OBJECT ##### -->
<para>

</para>



<!-- ##### STRUCT GParamSpecObject ##### -->
<para>

</para>

@parent_instance: 

<!-- ##### FUNCTION g_param_spec_object ##### -->
<para>

</para>

@name: 
@nick: 
@blurb: 
@object_type: 
@flags: 
@Returns: 


<!-- ##### FUNCTION g_value_set_object ##### -->
<para>

</para>

@value: 
@v_object: 


<!-- ##### FUNCTION g_value_set_object_take_ownership ##### -->
<para>

</para>

@value: 
@v_object: 


<!-- ##### FUNCTION g_value_get_object ##### -->
<para>

</para>

@value: 
@Returns: 


<!-- ##### FUNCTION g_value_dup_object ##### -->
<para>

</para>

@value: 
@Returns: 


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

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_PARAM_SPEC_UNICHAR ##### -->
<para>
Cast a #GParamSpec instance into a #GParamSpecUnichar.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_TYPE_PARAM_UNICHAR ##### -->
<para>

</para>



<!-- ##### STRUCT GParamSpecUnichar ##### -->
<para>
A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.
</para>

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

<!-- ##### FUNCTION g_param_spec_unichar ##### -->
<para>
Create a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT property.
#GValue structures for this property
can be accessed with g_value_set_uint() and g_value_get_uint().
</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


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

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_PARAM_SPEC_VALUE_ARRAY ##### -->
<para>
Cast a #GParamSpec instance into a #GParamSpecValueArray.
</para>

@pspec: a valid #GParamSpec instance


<!-- ##### MACRO G_TYPE_PARAM_VALUE_ARRAY ##### -->
<para>

</para>



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

@parent_instance:  private #GParamSpec portion
@element_spec:     a #GParamSpec describing the elements contained in arrays of this property, may be %NULL
@fixed_n_elements: if greater than 0, arrays of this property will always have this many elements

<!-- ##### FUNCTION g_param_spec_value_array ##### -->
<para>
Create a new #GParamSpecValueArray instance specifying a %G_TYPE_VALUE_ARRAY property.
%G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED type, as such, #GValue structures for this property
can be accessed with g_value_set_boxed() and g_value_get_boxed().
</para>

@name:          canonical name of the property specified
@nick:          nick name for the property specified
@blurb:         description of the property specified
@element_spec:  a #GParamSpec describing the elements contained in arrays of this property, may be %NULL
@flags:         flags for the property specified
@Returns:       a newly created parameter specification