2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
Standard Parameter Types
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_CHAR ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_CHAR ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_UCHAR ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_UCHAR ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_BOOLEAN ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_BOOLEAN ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_INT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_INT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_UINT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_UINT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_LONG ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_LONG ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_ULONG ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_ULONG ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_ENUM ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_ENUM ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_FLOAT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_FLOAT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_DOUBLE ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_DOUBLE ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_STRING ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
2001-01-09 03:18:57 +01:00
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_POINTER ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_POINTER ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_BOXED ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO G_PARAM_SPEC_OBJECT ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pspec:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecChar ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecUChar ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecBoolean ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecInt ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecUInt ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecLong ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecULong ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecEnum ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@enum_class:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecFlags ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@flags_class:
|
|
|
|
@default_value:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecFloat ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@epsilon:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecDouble ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@epsilon:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecString ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
@default_value:
|
|
|
|
@cset_first:
|
|
|
|
@cset_nth:
|
|
|
|
@substitutor:
|
|
|
|
@null_fold_if_empty:
|
|
|
|
@ensure_non_null:
|
|
|
|
|
2001-01-09 03:18:57 +01:00
|
|
|
<!-- ##### STRUCT GParamSpecBoxed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecParam ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GParamSpecPointer ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
|
2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### STRUCT GParamSpecObject ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent_instance:
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_char ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_uchar ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_boolean ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_int ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_uint ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_long ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_ulong ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_enum ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@enum_type:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_flags ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@flags_type:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_float ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_double ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@minimum:
|
|
|
|
@maximum:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@default_value:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-01-09 03:18:57 +01:00
|
|
|
<!-- ##### FUNCTION g_param_spec_boxed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@boxed_type:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_param ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@param_type:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION g_param_spec_pointer ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-09-06 06:32:45 +02:00
|
|
|
<!-- ##### FUNCTION g_param_spec_object ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@name:
|
|
|
|
@nick:
|
|
|
|
@blurb:
|
|
|
|
@object_type:
|
|
|
|
@flags:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|