From 4abd166025f336f8b427e1e0a6faac103d96f87d Mon Sep 17 00:00:00 2001 From: Tim Janik Date: Wed, 14 Nov 2001 01:08:19 +0000 Subject: [PATCH] list parameter and value types. Tue Nov 13 21:31:58 2001 Tim Janik * gobject/tmp/param_value_types.sgml: list parameter and value types. * gobject/tmpl/gparamspec.sgml: more docs for g_param_spec*() functions. * gobject/*: section cleanups. --- docs/reference/ChangeLog | 10 + docs/reference/gobject/gobject-docs.sgml | 10 +- docs/reference/gobject/gobject-sections.txt | 317 +++--- .../reference/gobject/tmpl/enumerations_flags.sgml | 52 - docs/reference/gobject/tmpl/gboxed.sgml | 55 +- .../gobject/tmpl/{closures.sgml => gclosure.sgml} | 0 docs/reference/gobject/tmpl/generic_values.sgml | 229 +---- docs/reference/gobject/tmpl/gobject-unused.sgml | 111 ++ docs/reference/gobject/tmpl/gparamspec.sgml | 125 ++- .../gobject/tmpl/{types.sgml => gtype.sgml} | 269 +++-- docs/reference/gobject/tmpl/objects.sgml | 52 +- ...standard_params.sgml => param_value_types.sgml} | 1066 +++++++++++++++----- docs/reference/gobject/tmpl/signals.sgml | 34 +- docs/reference/gobject/tmpl/value_types.sgml | 373 ------- 14 files changed, 1514 insertions(+), 1189 deletions(-) rename docs/reference/gobject/tmpl/{closures.sgml => gclosure.sgml} (100%) rename docs/reference/gobject/tmpl/{types.sgml => gtype.sgml} (78%) rename docs/reference/gobject/tmpl/{standard_params.sgml => param_value_types.sgml} (53%) delete mode 100644 docs/reference/gobject/tmpl/value_types.sgml diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index cb60bf6..430cc0b 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,13 @@ +Tue Nov 13 21:31:58 2001 Tim Janik + + * gobject/tmp/param_value_types.sgml: list parameter and + value types. + + * gobject/tmpl/gparamspec.sgml: more docs for g_param_spec*() + functions. + + * gobject/*: section cleanups. + Tue Nov 13 19:49:16 2001 Tim Janik * gobject/tmpl/gparamspec.sgml: param spec updates. diff --git a/docs/reference/gobject/gobject-docs.sgml b/docs/reference/gobject/gobject-docs.sgml index b6d109b..7588b3e 100644 --- a/docs/reference/gobject/gobject-docs.sgml +++ b/docs/reference/gobject/gobject-docs.sgml @@ -1,17 +1,16 @@ + - + - - + ]> @@ -73,10 +72,9 @@ &gobject-Enumeration-and-Flag-Types; &gobject-Boxed-Types; &gobject-Generic-values; - &gobject-Standard-value-types; + &gobject-param-value-types; &gobject-Varargs-Value-Collection; &gobject-GParamSpec; - &gobject-Standard-Parameter-Types; &gobject-Signals; &gobject-Closures; &gobject-Value-Arrays; diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 86da504..f1af9b6 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -1,8 +1,8 @@ gobject.h
+gtype Type Information -types GType G_TYPE_FUNDAMENTAL G_TYPE_FUNDAMENTAL_MAX @@ -24,7 +24,7 @@ GTypeInstance GTypeInfo GTypeFundamentalInfo GInterfaceInfo - +GTypeValueTable GType G_TYPE_FROM_INSTANCE G_TYPE_FROM_CLASS @@ -54,6 +54,7 @@ g_type_class_peek g_type_class_unref g_type_class_peek_parent g_type_interface_peek +g_type_interface_peek_parent g_type_children g_type_interfaces g_type_set_qdata @@ -78,21 +79,24 @@ g_type_interface_add_prerequisite g_type_get_plugin g_type_interface_get_plugin g_type_fundamental_last -g_type_check_flags g_type_create_instance g_type_free_instance g_type_add_class_cache_func g_type_remove_class_cache_func g_type_class_unref_uncached +g_type_value_table_peek + g_type_check_instance g_type_check_instance_cast -g_type_instance_is_a +g_type_check_instance_is_a g_type_check_class_cast -g_type_class_is_a +g_type_check_class_is_a +g_type_check_is_value_type g_type_check_value -g_type_value_is_a -g_type_value_table_peek - +g_type_check_value_holds +g_type_test_flags +g_type_name_from_instance +g_type_name_from_class
@@ -141,7 +145,6 @@ G_TYPE_MODULE_GET_CLASS objects GObject GObjectClass -GObjectConstructParam GObjectGetPropertyFunc GObjectSetPropertyFunc GObjectFinalizeFunc @@ -155,7 +158,6 @@ G_OBJECT_TYPE G_OBJECT_TYPE_NAME G_OBJECT_CLASS_TYPE G_OBJECT_CLASS_NAME -G_VALUE_HOLDS_OBJECT g_object_class_install_property g_object_class_find_property g_object_class_list_properties @@ -163,6 +165,7 @@ g_object_new g_object_newv g_object_ref g_object_unref +GWeakNotify g_object_weak_ref g_object_weak_unref g_object_add_weak_pointer @@ -189,10 +192,9 @@ g_object_set_valist g_object_get_valist g_object_watch_closure g_object_run_dispose -g_value_set_object -g_value_get_object -g_value_dup_object G_OBJECT_WARN_INVALID_PROPERTY_ID + +GObjectConstructParam
@@ -210,8 +212,6 @@ G_FLAGS_CLASS G_IS_FLAGS_CLASS G_FLAGS_CLASS_TYPE G_FLAGS_CLASS_TYPE_NAME -G_VALUE_HOLDS_ENUM -G_VALUE_HOLDS_FLAGS GEnumValue GFlagsValue g_enum_get_value @@ -220,10 +220,6 @@ g_enum_get_value_by_nick g_flags_get_first_value g_flags_get_value_by_name g_flags_get_value_by_nick -g_value_set_enum -g_value_get_enum -g_value_set_flags -g_value_get_flags g_enum_register_static g_flags_register_static g_enum_complete_type_info @@ -233,20 +229,13 @@ g_flags_complete_type_info
gboxed Boxed Types -GBoxed -GBoxedInitFunc GBoxedCopyFunc GBoxedFreeFunc g_boxed_copy g_boxed_free -g_value_set_boxed -g_value_set_static_boxed -g_value_set_boxed_take_ownership -g_value_get_boxed -g_value_dup_boxed g_boxed_type_register_static +g_pointer_type_register_static -G_VALUE_HOLDS_BOXED G_TYPE_IS_BOXED
@@ -266,11 +255,11 @@ g_value_reset g_value_unset g_value_fits_pointer g_value_peek_pointer -g_value_convert -g_values_exchange -g_value_types_exchangable -g_value_register_exchange_func -GTypeValueTable +g_value_type_compatible +g_value_type_transformable +g_value_transform +GValueTransform +g_value_register_transform_func
@@ -281,7 +270,6 @@ g_value_array_get_nth g_value_array_new g_value_array_copy g_value_array_free -g_value_array_index g_value_array_append g_value_array_prepend g_value_array_insert @@ -291,61 +279,16 @@ g_value_array_sort_with_data
-Standard value types -value_types -G_VALUE_HOLDS_CHAR -G_VALUE_HOLDS_UCHAR -G_VALUE_HOLDS_BOOLEAN -G_VALUE_HOLDS_INT -G_VALUE_HOLDS_UINT -G_VALUE_HOLDS_LONG -G_VALUE_HOLDS_ULONG -G_VALUE_HOLDS_FLOAT -G_VALUE_HOLDS_DOUBLE -G_VALUE_HOLDS_STRING -G_VALUE_HOLDS_POINTER -G_VALUE_HOLDS_PARAM -g_value_set_char -g_value_get_char -g_value_set_uchar -g_value_get_uchar -g_value_set_boolean -g_value_get_boolean -g_value_set_int -g_value_get_int -g_value_set_uint -g_value_get_uint -g_value_set_long -g_value_get_long -g_value_set_ulong -g_value_get_ulong -g_value_set_float -g_value_get_float -g_value_set_double -g_value_get_double -g_value_set_string -g_value_set_static_string -g_value_set_string_take_ownership -g_value_get_string -g_value_dup_string -g_value_set_param -g_value_get_param -g_value_dup_param -g_value_get_pointer -g_value_set_pointer -g_value_set_instance -
- -
GParamSpec gparamspec -G_PARAM_SPEC_TYPE +G_TYPE_PARAM G_TYPE_IS_PARAM G_PARAM_SPEC G_IS_PARAM_SPEC G_PARAM_SPEC_CLASS G_IS_PARAM_SPEC_CLASS G_PARAM_SPEC_GET_CLASS +G_PARAM_SPEC_TYPE G_PARAM_SPEC_TYPE_NAME G_PARAM_SPEC_VALUE_TYPE GParamSpec @@ -366,6 +309,7 @@ g_param_spec_get_qdata g_param_spec_set_qdata g_param_spec_set_qdata_full g_param_spec_steal_qdata +g_param_spec_internal GParamSpecTypeInfo g_param_type_register_static GParamSpecPool @@ -373,86 +317,197 @@ g_param_spec_pool_new g_param_spec_pool_insert g_param_spec_pool_remove g_param_spec_pool_lookup -g_param_spec_internal +g_param_spec_pool_list
-Standard Parameter Types -standard_params +Standard Parameter and Value Types +param_value_types + + +G_IS_PARAM_SPEC_BOOLEAN +G_PARAM_SPEC_BOOLEAN +G_VALUE_HOLDS_BOOLEAN +GParamSpecBoolean +g_param_spec_boolean +g_value_set_boolean +g_value_get_boolean + + G_IS_PARAM_SPEC_CHAR G_PARAM_SPEC_CHAR +G_VALUE_HOLDS_CHAR +GParamSpecChar +g_param_spec_char +g_value_set_char +g_value_get_char + + G_IS_PARAM_SPEC_UCHAR G_PARAM_SPEC_UCHAR -G_IS_PARAM_SPEC_BOOLEAN -G_PARAM_SPEC_BOOLEAN +G_VALUE_HOLDS_UCHAR +GParamSpecUChar +g_param_spec_uchar +g_value_set_uchar +g_value_get_uchar + + G_IS_PARAM_SPEC_INT G_PARAM_SPEC_INT +G_VALUE_HOLDS_INT +GParamSpecInt +g_param_spec_int +g_value_set_int +g_value_get_int + + G_IS_PARAM_SPEC_UINT G_PARAM_SPEC_UINT +G_VALUE_HOLDS_UINT +GParamSpecUInt +g_param_spec_uint +g_value_set_uint +g_value_get_uint + + G_IS_PARAM_SPEC_LONG G_PARAM_SPEC_LONG +G_VALUE_HOLDS_LONG +GParamSpecLong +g_param_spec_long +g_value_set_long +g_value_get_long + + G_IS_PARAM_SPEC_ULONG G_PARAM_SPEC_ULONG -G_IS_PARAM_SPEC_ENUM -G_PARAM_SPEC_ENUM -G_IS_PARAM_SPEC_FLAGS -G_PARAM_SPEC_FLAGS +G_VALUE_HOLDS_ULONG +GParamSpecULong +g_param_spec_ulong +g_value_set_ulong +g_value_get_ulong + + +G_IS_PARAM_SPEC_INT64 +G_PARAM_SPEC_INT64 +G_VALUE_HOLDS_INT64 +GParamSpecInt64 +g_param_spec_int64 +g_value_set_int64 +g_value_get_int64 + + +G_IS_PARAM_SPEC_UINT64 +G_PARAM_SPEC_UINT64 +G_VALUE_HOLDS_UINT64 +GParamSpecUInt64 +g_param_spec_uint64 +g_value_set_uint64 +g_value_get_uint64 + + G_IS_PARAM_SPEC_FLOAT G_PARAM_SPEC_FLOAT +G_VALUE_HOLDS_FLOAT +GParamSpecFloat +g_param_spec_float +g_value_set_float +g_value_get_float + + G_IS_PARAM_SPEC_DOUBLE G_PARAM_SPEC_DOUBLE +G_VALUE_HOLDS_DOUBLE +GParamSpecDouble +g_param_spec_double +g_value_set_double +g_value_get_double + + +G_IS_PARAM_SPEC_ENUM +G_PARAM_SPEC_ENUM +G_VALUE_HOLDS_ENUM +GParamSpecEnum +g_param_spec_enum +g_value_set_enum +g_value_get_enum + + +G_IS_PARAM_SPEC_FLAGS +G_PARAM_SPEC_FLAGS +G_VALUE_HOLDS_FLAGS +GParamSpecFlags +g_param_spec_flags +g_value_set_flags +g_value_get_flags + + G_IS_PARAM_SPEC_STRING G_PARAM_SPEC_STRING +G_VALUE_HOLDS_STRING +GParamSpecString +g_param_spec_string +g_value_set_string +g_value_set_static_string +g_value_set_string_take_ownership +g_value_get_string +g_value_dup_string + + G_IS_PARAM_SPEC_PARAM G_PARAM_SPEC_PARAM +G_VALUE_HOLDS_PARAM +GParamSpecParam +g_param_spec_param +g_value_set_param +g_value_get_param +g_value_dup_param + + G_IS_PARAM_SPEC_BOXED G_PARAM_SPEC_BOXED +G_VALUE_HOLDS_BOXED +GParamSpecBoxed +g_param_spec_boxed +g_value_set_boxed +g_value_set_static_boxed +g_value_set_boxed_take_ownership +g_value_get_boxed +g_value_dup_boxed + + G_IS_PARAM_SPEC_POINTER G_PARAM_SPEC_POINTER -G_IS_PARAM_SPEC_VALUE_ARRAY -G_PARAM_SPEC_VALUE_ARRAY -G_IS_PARAM_SPEC_CLOSURE -G_PARAM_SPEC_CLOSURE +G_VALUE_HOLDS_POINTER +GParamSpecPointer +g_param_spec_pointer +g_value_set_pointer +g_value_get_pointer + + G_IS_PARAM_SPEC_OBJECT G_PARAM_SPEC_OBJECT -GParamSpecChar -GParamSpecUChar -GParamSpecBoolean -GParamSpecInt -GParamSpecUInt -GParamSpecLong -GParamSpecULong -GParamSpecUnichar -GParamSpecEnum -GParamSpecFlags -GParamSpecFloat -GParamSpecDouble -GParamSpecString -GParamSpecParam -GParamSpecBoxed -GParamSpecPointer -GParamSpecValueArray -GParamSpecClosure +G_VALUE_HOLDS_OBJECT GParamSpecObject -g_param_spec_char -g_param_spec_uchar -g_param_spec_boolean -g_param_spec_int -g_param_spec_uint -g_param_spec_long -g_param_spec_ulong +g_param_spec_object +g_value_set_object +g_value_get_object +g_value_dup_object + + +G_IS_PARAM_SPEC_UNICHAR +G_PARAM_SPEC_UNICHAR +GParamSpecUnichar g_param_spec_unichar -g_param_spec_enum -g_param_spec_flags -g_param_spec_float -g_param_spec_double -g_param_spec_string -g_param_spec_param -g_param_spec_boxed -g_param_spec_pointer + + +G_IS_PARAM_SPEC_VALUE_ARRAY +G_PARAM_SPEC_VALUE_ARRAY +GParamSpecValueArray g_param_spec_value_array -g_param_spec_closure -g_param_spec_object + + +g_value_set_instance
@@ -487,11 +542,12 @@ g_signal_emit g_signal_emit_by_name g_signal_emitv g_signal_emit_valist -g_signal_connect_data g_signal_connect g_signal_connect_after g_signal_connect_swapped g_signal_connect_object +GConnectFlags +g_signal_connect_data g_signal_connect_closure g_signal_connect_closure_by_id g_signal_handler_block @@ -509,7 +565,6 @@ g_signal_has_handler_pending g_signal_stop_emission g_signal_stop_emission_by_name g_signal_add_emission_hook -g_signal_add_emission_hook_full g_signal_remove_emission_hook g_signal_parse_name g_signal_handlers_destroy @@ -517,8 +572,8 @@ g_signal_type_cclosure_new
+gclosure Closures -closures G_CLOSURE_NEEDS_MARSHAL G_CCLOSURE_SWAP_DATA G_CALLBACK diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index 8c91f79..44cbe2c 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -105,22 +105,6 @@ Enumeration and flags types. @class: - - - - - -@value: - - - - - - - -@value: - - @@ -199,42 +183,6 @@ Enumeration and flags types. @Returns: - - - - - -@value: -@v_enum: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_flags: - - - - - - - -@value: -@Returns: - - diff --git a/docs/reference/gobject/tmpl/gboxed.sgml b/docs/reference/gobject/tmpl/gboxed.sgml index 1e6b288..3446569 100644 --- a/docs/reference/gobject/tmpl/gboxed.sgml +++ b/docs/reference/gobject/tmpl/gboxed.sgml @@ -52,52 +52,6 @@ Free the boxed structure @boxed which is of type @boxed_type. @boxed: The boxed structure to be freed. - - -Assign a #GValue which is initialized with a certain boxed type a -boxed structure of that very same type. - - -@value: The #GValue to be assigned a value to. -@boxed: The boxed structure which has to be of the same type the #GValue got initialized with. - - - - - - - -@value: -@boxed: - - - - -This is an internal function introduced mainly for C marshallers. - - -@value: -@boxed: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@Returns: - - This function creates a new %G_TYPE_BOXED derived type id for a new @@ -114,3 +68,12 @@ provided to copy and free opaque boxed structures of this type. @is_refcounted: + + + + + +@name: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/closures.sgml b/docs/reference/gobject/tmpl/gclosure.sgml similarity index 100% rename from docs/reference/gobject/tmpl/closures.sgml rename to docs/reference/gobject/tmpl/gclosure.sgml diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml index 18d2a86..759f1db 100644 --- a/docs/reference/gobject/tmpl/generic_values.sgml +++ b/docs/reference/gobject/tmpl/generic_values.sgml @@ -151,191 +151,52 @@ This is an internal function introduced mainly for C marshallers. @Returns: #TRUE if @value will fit inside a pointer value. - + -The #GTypeValueTable provides the functions required by the #GValue implementation, -to serve as a container for values of a type. + + + +@src_type: +@dest_type: +@Returns: + + + + + + + +@src_type: +@dest_type: +@Returns: + + + + + -@value_init: Default initialize @values contents by poking values - directly into the value->data array. The data array of - the #GValue passed into this function was zero-filled - with memset, so no care has to be taken to free any - old contents. E.g. for the implementation of a string - value that may never be NULL, the implementation might - look like: - -{ - value->data[0].v_pointer = g_strdup (""); -} - -@value_free: Free any old contents that might be left in the - data array of the passed in @value. No resources may - remain allocated through the #GValue contents after - this function returns. E.g. for our above string type: - -{ - /* only free strings without a specific flag for static storage */ - if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) - g_free (value->data[0].v_pointer); -} - -@value_copy: @dest_value is a #GValue with zero-filled data section - and @src_value is a properly setup #GValue of same or - derived type. - The purpose of this function is to copy the contents of - @src_value into @dest_value in a way, that even after - @src_value has been freed, the contents of @dest_value - remain valid. String type example: - -{ - dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); -} - -@value_peek_pointer: If the value contents fit into a pointer, such as objects - or strings, return this pointer, so the caller can peek at - the current contents. To extend on our above string example: - -{ - return value->data[0].v_pointer; -} - -@collect_format: A string format describing how to collect the contents of - this value, bit-by-bit. Each character in the format represents - an argument to be collected, the characters themselves indicate - the type of the argument. Currently supported arguments are: - - - 'i' - Integers. passed as collect_values[].v_int. - - - 'l' - Longs. passed as collect_values[].v_long. - - - 'd' - Doubles. passed as collect_values[].v_double. - - - 'p' - Pointers. passed as collect_values[].v_pointer. - - - It should be noted, that for variable argument list construction, - ANSI C promotes every type smaller than an integer to an int, and - floats to doubles. So for collection of short int or char, 'i' - needs to be used, and for collection of floats 'd'. -@collect_value: The collect_value() function is responsible for converting the - values collected from a variable argument list into contents - suitable for storage in a GValue. This function should setup - @value similar to value_init(), e.g. for a string value that - does not allow NULL pointers, it needs to either spew an error, - or do an implicit conversion by storing an empty string. - The @value passed in to this function has a zero-filled data - array, so just like for @value_init it is guaranteed to not - contain any old contents that might need freeing. - @n_collect_values is exactly the string length of @collect_format, - and @collect_values is an array of unions #GTypeCValue with - length @n_collect_values, containing the collected values - according to @collect_format. - @collect_flags is an argument provided as a hint by the caller, - which may contain the flag #G_VALUE_NOCOPY_CONTENTS indicating, - that the collected value contents may be considered "static" - for the duration of the #@value lifetime. - Thus an extra copy of the contents stored in @collect_values is - not required for assignment to @value. - For our above string example, we continue with: - -{ - if (!collect_values[0].v_pointer) - value->data[0].v_pointer = g_strdup (""); - else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) - { - value->data[0].v_pointer = collect_values[0].v_pointer; - /* keep a flag for the value_free() implementation to not free this string */ - value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS; - } - else - value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer); - - return NULL; -} - - It should be noted, that it is generally a bad idea to follow the - #G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to - reentrancy requirements and reference count assertions performed - by the GSignal code, reference counts should always be incremented - for reference counted contents stored in the value->data array. - To deviate from our string example for a moment, and taking a look - at an exemplary implementation for collect_value() of #GObject: - -{ - if (collect_values[0].v_pointer) - { - GObject *object = G_OBJECT (collect_values[0].v_pointer); - - /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */ - value->data[0].v_pointer = g_object_ref (object); - return NULL; - } - else - return g_strdup_printf ("Object passed as invalid NULL pointer"); -} - - The reference count for valid objects is always incremented, - regardless of @collect_flags. For invalid objects, the example - returns a newly allocated string without altering @value. - Upon success, collect_value() needs to return NULL, if however - a malicious condition occurred, collect_value() may spew an - error by returning a newly allocated non-NULL string, giving - a suitable description of the error condition. - The calling code makes no assumptions about the @value - contents being valid upon error returns, @value - is simply thrown away without further freeing. As such, it is - a good idea to not allocate #GValue contents, prior to returning - an error, however, collect_values() is not obliged to return - a correctly setup @value for error returns, simply because - any non-NULL return is considered a fatal condition so further - program behaviour is undefined. -@lcopy_format: Format description of the arguments to collect for @lcopy_value, - analogous to @collect_format. Usually, @lcopy_format string consists - only of 'p's to provide lcopy_value() with pointers to storage locations. -@lcopy_value: This function is responsible for storing the @value contents into - arguments passed through a variable argument list which got - collected into @collect_values according to @lcopy_format. - @n_collect_values equals the string length of @lcopy_format, - and @collect_flags may contain #G_VALUE_NOCOPY_CONTENTS. - In contrast to collect_value(), lcopy_value() is obliged to - always properly support #G_VALUE_NOCOPY_CONTENTS. - Similar to collect_value() the function may prematurely abort - by returning a newly allocated string describing an error condition. - To complete the string example: - -{ - gchar **string_p = collect_values[0].v_pointer; - - if (!string_p) - return g_strdup_printf ("string location passed as NULL"); - - if (collect_flags & G_VALUE_NOCOPY_CONTENTS) - *string_p = value->data[0].v_pointer; - else - *string_p = g_strdup (value->data[0].v_pointer); - -} - - And an exemplary version of lcopy_value() for - reference-counted types: - -{ - GObject **object_p = collect_values[0].v_pointer; - - if (!object_p) - return g_strdup_printf ("object location passed as NULL"); - if (!value->data[0].v_pointer) - *object_p = NULL; - else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) /* always honour */ - *object_p = value->data[0].v_pointer; - else - *object_p = g_object_ref (value->data[0].v_pointer); - return NULL; -} - +@src_value: +@dest_value: +@Returns: + + + + + + + +@src_value: +@dest_value: + + + + + + + +@src_type: +@dest_type: +@transform_func: + diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml index 64866a3..2b1e248 100644 --- a/docs/reference/gobject/tmpl/gobject-unused.sgml +++ b/docs/reference/gobject/tmpl/gobject-unused.sgml @@ -31,6 +31,35 @@ Parameter Specifications @Returns: + + + + + +@pspec: +@value: + + + + + + +@parent_instance: + + + + + + +@pspec: + + + + + + +@pspec: + @@ -67,6 +96,17 @@ Parameter Specifications @notify_data: @notify_func: + + + + + +@name: +@nick: +@blurb: +@flags: +@Returns: + @@ -105,6 +145,77 @@ Parameter Specifications @n_params: @Varargs: + + + + +@g_class: +@is_a_type: +@Returns: + + + +Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags +are set for @type. + + +@type: The type to check for flags. +@flags: Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags. +@Returns: #TRUE if all @flags are set for @type, #FALSE otherwise. + + + +Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE() +macro. + + +@instance: A valid #GTypeInstance structure. +@Returns: #TRUE if @instance is valid, #FALSE otherwise. + + + + + +@instance: +@iface_type: +@Returns: + + + + + +@value: +@Returns: + + + + + +@g_class: +@is_a_type: +@Returns: + + + +Determines if @instance adheres to the interface exported +by @iface_type. @iface_type is either a type that @instance +is derived from, or an interface type that is supported by +the anchestry of @instance. + + +@instance: A valid #GTypeInstance structure. +@iface_type: A #GType value. +@Returns: #TRUE if @instance conforms to @iface_type, #FALSE otherwise. + + + + + + +@type: +@flags: +@Returns: + Determines if @value is a #GValue whose type conforms to @type. diff --git a/docs/reference/gobject/tmpl/gparamspec.sgml b/docs/reference/gobject/tmpl/gparamspec.sgml index aa570e3..ebccd86 100644 --- a/docs/reference/gobject/tmpl/gparamspec.sgml +++ b/docs/reference/gobject/tmpl/gparamspec.sgml @@ -1,8 +1,8 @@ - +GParamSpec -Parameter Specifications +Meta data object for parameter specifications. @@ -13,23 +13,15 @@ required to specify parameters, such as e.g. #GObject properties. g_object_class_install_property(), g_object_set(), g_object_get(), -g_object_set_property(), g_object_get_property() - - - - -Retrive the #GType of this @pspec. +g_object_set_property(), g_object_get_property(), g_value_register_transform_func() -@pspec: a valid #GParamSpec - - - +Returns whether @type "is a" %G_TYPE_PARAM. -@type: +@type: a #GType ID @@ -43,15 +35,41 @@ a #GParamSpec object. +Check whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM +or derived. + + +@pspec: a #GParamSpec + + + +Cast a derived #GParamSpecClass structure into a #GParamSpecClass structure. -@pspec: a valid #GParamSpec +@pclass: a valid #GParamSpecClass + + + + +Check whether @pclass "is a" valid #GParamSpecClass structure of type %G_TYPE_PARAM +or derived. + + +@pclass: a #GParamSpecClass +Retrieve the #GParamSpecClass of a #GParamSpec. + + +@pspec: a valid #GParamSpec + + + +Retrive the #GType of this @pspec. @pspec: a valid #GParamSpec @@ -159,54 +177,68 @@ not flagged "floating" anymore). - +Set @value to its default value as specified in @pspec. -@pspec: -@value: +@pspec: a valid #GParamSpec +@value: a #GValue of correct type for @pspec - +Check whether @value contains the default value as specified in @pspec. -@pspec: -@value: -@Returns: +@pspec: a valid #GParamSpec +@value: a #GValue of correct type for @pspec +@Returns: whether @value contains the canonical defualt for this @pspec - +Ensure that the contents of @value comply with the specifications +set out by @pspec. For example, a #GParamSpecInt might require +that integers stored in @value may not be smaller than -42 and not be +greater than +42. If @value contains an integer outside of this range, +it is modified accordingly, so the resulting value will fit into the +range -42 .. +42. -@pspec: -@value: -@Returns: +@pspec: a valid #GParamSpec +@value: a #GValue of correct type for @pspec +@Returns: whether modifying @value was necessary to ensure validity +This function transforms @src_value into @dest_value if possible, +and then validates @dest_value, in order for it to conform to +@pspec. +If @strict_validation is %TRUE this function will only suceed if +the transformed @dest_value complied to @pspec without modifications. +See also g_value_type_transformable(), g_value_transform() and +g_param_value_validate(). -@dest_value_spec: -@src_value: -@dest_value: -@strict_validation: -@Returns: +@pspec: a valid #GParamSpec +@src_value: souce #GValue +@dest_value: destination #GValue of correct type for @pspec +@strict_validation: $TRUE requires @dest_value to conform to @pspec without modifications +@Returns: %TRUE if transformation and validation were successfull, + %FALSE otherwise and @dest_value is left untouched. - +Compare @value1 with @value2 according to @pspec, and return -1, 0 or +1, +if @value1 is found to be less than, equal to or greater than @value2, respectively. -@pspec: -@value1: -@value2: -@Returns: +@pspec: a valid #GParamSpec +@value1: a #GValue of correct type for @pspec +@value2: a #GValue of correct type for @pspec +@Returns: -1, 0 or +1, for a less than, equal to or greater than result @@ -250,6 +282,19 @@ not flagged "floating" anymore). @Returns: + + + + + +@param_type: +@name: +@nick: +@blurb: +@flags: +@Returns: + + @@ -322,16 +367,14 @@ not flagged "floating" anymore). @trailer_p: - + -@param_type: -@name: -@nick: -@blurb: -@flags: +@pool: +@owner_type: +@n_pspecs_p: @Returns: diff --git a/docs/reference/gobject/tmpl/types.sgml b/docs/reference/gobject/tmpl/gtype.sgml similarity index 78% rename from docs/reference/gobject/tmpl/types.sgml rename to docs/reference/gobject/tmpl/gtype.sgml index f6fb312..76c9d4b 100644 --- a/docs/reference/gobject/tmpl/types.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -283,6 +283,194 @@ used specifically for managing interface types. @interface_data: Location of user data passed to the @interface_init and @interface_finalize functions (optional). + + +The #GTypeValueTable provides the functions required by the #GValue implementation, +to serve as a container for values of a type. + + +@value_init: Default initialize @values contents by poking values + directly into the value->data array. The data array of + the #GValue passed into this function was zero-filled + with memset, so no care has to be taken to free any + old contents. E.g. for the implementation of a string + value that may never be NULL, the implementation might + look like: + +{ + value->data[0].v_pointer = g_strdup (""); +} + +@value_free: Free any old contents that might be left in the + data array of the passed in @value. No resources may + remain allocated through the #GValue contents after + this function returns. E.g. for our above string type: + +{ + /* only free strings without a specific flag for static storage */ + if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) + g_free (value->data[0].v_pointer); +} + +@value_copy: @dest_value is a #GValue with zero-filled data section + and @src_value is a properly setup #GValue of same or + derived type. + The purpose of this function is to copy the contents of + @src_value into @dest_value in a way, that even after + @src_value has been freed, the contents of @dest_value + remain valid. String type example: + +{ + dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); +} + +@value_peek_pointer: If the value contents fit into a pointer, such as objects + or strings, return this pointer, so the caller can peek at + the current contents. To extend on our above string example: + +{ + return value->data[0].v_pointer; +} + +@collect_format: A string format describing how to collect the contents of + this value, bit-by-bit. Each character in the format represents + an argument to be collected, the characters themselves indicate + the type of the argument. Currently supported arguments are: + + + 'i' - Integers. passed as collect_values[].v_int. + + + 'l' - Longs. passed as collect_values[].v_long. + + + 'd' - Doubles. passed as collect_values[].v_double. + + + 'p' - Pointers. passed as collect_values[].v_pointer. + + + It should be noted, that for variable argument list construction, + ANSI C promotes every type smaller than an integer to an int, and + floats to doubles. So for collection of short int or char, 'i' + needs to be used, and for collection of floats 'd'. +@collect_value: The collect_value() function is responsible for converting the + values collected from a variable argument list into contents + suitable for storage in a GValue. This function should setup + @value similar to value_init(), e.g. for a string value that + does not allow NULL pointers, it needs to either spew an error, + or do an implicit conversion by storing an empty string. + The @value passed in to this function has a zero-filled data + array, so just like for @value_init it is guaranteed to not + contain any old contents that might need freeing. + @n_collect_values is exactly the string length of @collect_format, + and @collect_values is an array of unions #GTypeCValue with + length @n_collect_values, containing the collected values + according to @collect_format. + @collect_flags is an argument provided as a hint by the caller, + which may contain the flag #G_VALUE_NOCOPY_CONTENTS indicating, + that the collected value contents may be considered "static" + for the duration of the #@value lifetime. + Thus an extra copy of the contents stored in @collect_values is + not required for assignment to @value. + For our above string example, we continue with: + +{ + if (!collect_values[0].v_pointer) + value->data[0].v_pointer = g_strdup (""); + else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) + { + value->data[0].v_pointer = collect_values[0].v_pointer; + /* keep a flag for the value_free() implementation to not free this string */ + value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS; + } + else + value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer); + + return NULL; +} + + It should be noted, that it is generally a bad idea to follow the + #G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to + reentrancy requirements and reference count assertions performed + by the GSignal code, reference counts should always be incremented + for reference counted contents stored in the value->data array. + To deviate from our string example for a moment, and taking a look + at an exemplary implementation for collect_value() of #GObject: + +{ + if (collect_values[0].v_pointer) + { + GObject *object = G_OBJECT (collect_values[0].v_pointer); + + /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */ + value->data[0].v_pointer = g_object_ref (object); + return NULL; + } + else + return g_strdup_printf ("Object passed as invalid NULL pointer"); +} + + The reference count for valid objects is always incremented, + regardless of @collect_flags. For invalid objects, the example + returns a newly allocated string without altering @value. + Upon success, collect_value() needs to return NULL, if however + a malicious condition occurred, collect_value() may spew an + error by returning a newly allocated non-NULL string, giving + a suitable description of the error condition. + The calling code makes no assumptions about the @value + contents being valid upon error returns, @value + is simply thrown away without further freeing. As such, it is + a good idea to not allocate #GValue contents, prior to returning + an error, however, collect_values() is not obliged to return + a correctly setup @value for error returns, simply because + any non-NULL return is considered a fatal condition so further + program behaviour is undefined. +@lcopy_format: Format description of the arguments to collect for @lcopy_value, + analogous to @collect_format. Usually, @lcopy_format string consists + only of 'p's to provide lcopy_value() with pointers to storage locations. +@lcopy_value: This function is responsible for storing the @value contents into + arguments passed through a variable argument list which got + collected into @collect_values according to @lcopy_format. + @n_collect_values equals the string length of @lcopy_format, + and @collect_flags may contain #G_VALUE_NOCOPY_CONTENTS. + In contrast to collect_value(), lcopy_value() is obliged to + always properly support #G_VALUE_NOCOPY_CONTENTS. + Similar to collect_value() the function may prematurely abort + by returning a newly allocated string describing an error condition. + To complete the string example: + +{ + gchar **string_p = collect_values[0].v_pointer; + + if (!string_p) + return g_strdup_printf ("string location passed as NULL"); + + if (collect_flags & G_VALUE_NOCOPY_CONTENTS) + *string_p = value->data[0].v_pointer; + else + *string_p = g_strdup (value->data[0].v_pointer); + +} + + And an exemplary version of lcopy_value() for + reference-counted types: + +{ + GObject **object_p = collect_values[0].v_pointer; + + if (!object_p) + return g_strdup_printf ("object location passed as NULL"); + if (!value->data[0].v_pointer) + *object_p = NULL; + else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) /* always honour */ + *object_p = value->data[0].v_pointer; + else + *object_p = g_object_ref (value->data[0].v_pointer); + return NULL; +} + + Returns the type identifier from a given @instance structure. @@ -563,6 +751,15 @@ g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class))); @Returns: + + + + + +@g_iface: +@Returns: + + Return a newly allocated and 0 terminated array of type IDs, listing the @@ -942,17 +1139,6 @@ i.e. the next fundamental type ID that may be registered. @Returns: The nextmost not registered fundamental type ID. - - -Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags -are set for @type. - - -@type: The type to check for flags. -@flags: Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags. -@Returns: #TRUE if all @flags are set for @type, #FALSE otherwise. - - Creates and initializes an instance of @type if @type is valid and can @@ -964,6 +1150,9 @@ fundamental types only. E.g. instances of the #GObject hierarchy should be created via g_object_new() and never directly through g_type_create_instance() which doesn't handle things like singleton objects or object construction. +Note: Do not use this function, unless you're +implementing a fundamental type. Also language bindings should not +use this function but g_object_new() instead. @type: An instantiabtable type to create an instance for. @@ -1004,64 +1193,6 @@ things like singleton objects or object construction. @g_class: - - -Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE() -macro. - - -@instance: A valid #GTypeInstance structure. -@Returns: #TRUE if @instance is valid, #FALSE otherwise. - - - - - - -@instance: -@iface_type: -@Returns: - - - - -Determines if @instance adheres to the interface exported -by @iface_type. @iface_type is either a type that @instance -is derived from, or an interface type that is supported by -the anchestry of @instance. - - -@instance: A valid #GTypeInstance structure. -@iface_type: A #GType value. -@Returns: #TRUE if @instance conforms to @iface_type, #FALSE otherwise. - - - - - - -@g_class: -@is_a_type: -@Returns: - - - - - - -@g_class: -@is_a_type: -@Returns: - - - - - - -@value: -@Returns: - - Returns the location of the #GTypeValueTable associated with @type. diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index 1c3da26..e24bb6a 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -28,14 +28,6 @@ and should never be accessed directly. - - - - - -@pspec: -@value: - @@ -155,14 +147,6 @@ Return the type id of an object. @class: - - - - - -@value: - - @@ -234,6 +218,15 @@ Return the type id of an object. @object: + + + + + +@data: +@where_the_object_was: + + @@ -497,33 +490,6 @@ to match the one used with g_object_add_weak_pointer(). @object: - - - - - -@value: -@v_object: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@Returns: - - diff --git a/docs/reference/gobject/tmpl/standard_params.sgml b/docs/reference/gobject/tmpl/param_value_types.sgml similarity index 53% rename from docs/reference/gobject/tmpl/standard_params.sgml rename to docs/reference/gobject/tmpl/param_value_types.sgml index 82b86c2..654cd48 100644 --- a/docs/reference/gobject/tmpl/standard_params.sgml +++ b/docs/reference/gobject/tmpl/param_value_types.sgml @@ -1,5 +1,5 @@ -Standard Parameter Types +Standard Parameter and Value Types @@ -14,7 +14,7 @@ Standard Parameter Types - + @@ -22,7 +22,7 @@ Standard Parameter Types @pspec: - + @@ -30,47 +30,54 @@ Standard Parameter Types @pspec: - + -@pspec: +@value: - + -@pspec: - +@parent_instance: +@default_value: - + -@pspec: +@name: +@nick: +@blurb: +@default_value: +@flags: +@Returns: - + -@pspec: +@value: +@v_boolean: - + -@pspec: +@value: +@Returns: - + @@ -78,7 +85,7 @@ Standard Parameter Types @pspec: - + @@ -86,47 +93,58 @@ Standard Parameter Types @pspec: - + -@pspec: +@value: - + -@pspec: - +@parent_instance: +@minimum: +@maximum: +@default_value: - + -@pspec: +@name: +@nick: +@blurb: +@minimum: +@maximum: +@default_value: +@flags: +@Returns: - + -@pspec: +@value: +@v_char: - + -@pspec: +@value: +@Returns: - + @@ -134,7 +152,7 @@ Standard Parameter Types @pspec: - + @@ -142,47 +160,58 @@ Standard Parameter Types @pspec: - + -@pspec: +@value: - + -@pspec: - +@parent_instance: +@minimum: +@maximum: +@default_value: - + -@pspec: +@name: +@nick: +@blurb: +@minimum: +@maximum: +@default_value: +@flags: +@Returns: - + -@pspec: +@value: +@v_uchar: - + -@pspec: +@value: +@Returns: - + @@ -190,7 +219,7 @@ Standard Parameter Types @pspec: - + @@ -198,47 +227,58 @@ Standard Parameter Types @pspec: - + -@pspec: +@value: - + -@pspec: - +@parent_instance: +@minimum: +@maximum: +@default_value: - + -@pspec: +@name: +@nick: +@blurb: +@minimum: +@maximum: +@default_value: +@flags: +@Returns: - + -@pspec: +@value: +@v_int: - + -@pspec: +@value: +@Returns: - + @@ -246,7 +286,7 @@ Standard Parameter Types @pspec: - + @@ -254,47 +294,58 @@ Standard Parameter Types @pspec: - + -@pspec: +@value: - + -@pspec: - +@parent_instance: +@minimum: +@maximum: +@default_value: - + -@pspec: +@name: +@nick: +@blurb: +@minimum: +@maximum: +@default_value: +@flags: +@Returns: - + -@pspec: +@value: +@v_uint: - + -@pspec: +@value: +@Returns: - + @@ -302,35 +353,23 @@ Standard Parameter Types @pspec: - + -@parent_instance: -@minimum: -@maximum: -@default_value: - - - - - +@pspec: -@parent_instance: -@minimum: -@maximum: -@default_value: - + -@parent_instance: -@default_value: +@value: - + + @@ -340,63 +379,64 @@ Standard Parameter Types @maximum: @default_value: - + -@parent_instance: +@name: +@nick: +@blurb: @minimum: @maximum: @default_value: +@flags: +@Returns: - + + -@parent_instance: -@minimum: -@maximum: -@default_value: +@value: +@v_long: - + + -@parent_instance: -@minimum: -@maximum: -@default_value: +@value: +@Returns: - + + -@parent_instance: -@default_value: +@pspec: - + + -@parent_instance: -@enum_class: -@default_value: +@pspec: - + + -@parent_instance: -@flags_class: -@default_value: +@value: - + + @@ -405,77 +445,75 @@ Standard Parameter Types @minimum: @maximum: @default_value: -@epsilon: - + -@parent_instance: +@name: +@nick: +@blurb: @minimum: @maximum: @default_value: -@epsilon: - - - - - +@flags: +@Returns: -@parent_instance: -@default_value: -@cset_first: -@cset_nth: -@substitutor: -@null_fold_if_empty: -@ensure_non_null: - + -@parent_instance: +@value: +@v_ulong: - + + -@parent_instance: +@value: +@Returns: - + + -@parent_instance: +@pspec: - + + -@parent_instance: -@element_spec: -@fixed_n_elements: +@pspec: - + + -@parent_instance: +@value: - + + @parent_instance: +@minimum: +@maximum: +@default_value: - + @@ -490,50 +528,59 @@ Standard Parameter Types @Returns: - + -@name: -@nick: -@blurb: -@minimum: -@maximum: -@default_value: -@flags: -@Returns: +@value: +@v_int64: - + -@name: -@nick: -@blurb: -@default_value: -@flags: +@value: @Returns: - + -@name: -@nick: -@blurb: +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: @minimum: @maximum: @default_value: -@flags: -@Returns: - - + @@ -548,22 +595,60 @@ Standard Parameter Types @Returns: - + -@name: -@nick: -@blurb: +@value: +@v_uint64: + + + + + + + +@value: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: @minimum: @maximum: @default_value: -@flags: -@Returns: - +@epsilon: - + @@ -578,61 +663,58 @@ Standard Parameter Types @Returns: - + -@name: -@nick: -@blurb: -@default_value: -@flags: -@Returns: +@value: +@v_float: - + -@name: -@nick: -@blurb: -@enum_type: -@default_value: -@flags: +@value: @Returns: - + -@name: -@nick: -@blurb: -@flags_type: -@default_value: -@flags: -@Returns: +@pspec: - + -@name: -@nick: -@blurb: +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: @minimum: @maximum: @default_value: -@flags: -@Returns: - +@epsilon: @@ -649,33 +731,58 @@ Standard Parameter Types @Returns: - + -@name: -@nick: -@blurb: -@default_value: -@flags: -@Returns: +@value: +@v_double: - + -@name: -@nick: -@blurb: -@param_type: -@flags: +@value: @Returns: - + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: +@enum_class: +@default_value: + + @@ -683,24 +790,64 @@ Standard Parameter Types @name: @nick: @blurb: -@boxed_type: +@enum_type: +@default_value: @flags: @Returns: - + -@name: -@nick: -@blurb: -@flags: +@value: +@v_enum: + + + + + + + +@value: @Returns: - + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: +@flags_class: +@default_value: + + @@ -708,32 +855,489 @@ Standard Parameter Types @name: @nick: @blurb: -@element_spec: +@flags_type: +@default_value: @flags: @Returns: - + -@name: -@nick: -@blurb: -@flags: +@value: +@v_flags: + + + + + + + +@value: @Returns: - + -@name: -@nick: -@blurb: -@object_type: +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: +@default_value: +@cset_first: +@cset_nth: +@substitutor: +@null_fold_if_empty: +@ensure_non_null: + + + + + + +@name: +@nick: +@blurb: +@default_value: +@flags: +@Returns: + + + + + + + +@value: +@v_string: + + + + + + + +@value: +@v_string: + + + + + + + +@value: +@v_string: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: + + + + + + +@name: +@nick: +@blurb: +@param_type: +@flags: +@Returns: + + + + + + + +@value: +@param: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: + + + + + + +@name: +@nick: +@blurb: +@boxed_type: +@flags: +@Returns: + + + + +Assign a #GValue which is initialized with a certain boxed type a +boxed structure of that very same type. + + +@value: The #GValue to be assigned a value to. +@boxed: The boxed structure which has to be of the same type the #GValue got initialized with. + + + + + + + +@value: +@boxed: + + + + +This is an internal function introduced mainly for C marshallers. + + +@value: +@boxed: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: + + + + + + +@name: +@nick: +@blurb: +@flags: +@Returns: + + + + + + + +@value: +@v_pointer: + + + + + + + +@value: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@value: + + + + + + + +@parent_instance: + + + + + + +@name: +@nick: +@blurb: +@object_type: +@flags: +@Returns: + + + + + + + +@value: +@v_object: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@parent_instance: +@default_value: + + + + + + +@name: +@nick: +@blurb: +@default_value: +@flags: +@Returns: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@parent_instance: +@element_spec: +@fixed_n_elements: + + + + + + +@name: +@nick: +@blurb: +@element_spec: @flags: @Returns: diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml index c800c12..3b2b139 100644 --- a/docs/reference/gobject/tmpl/signals.sgml +++ b/docs/reference/gobject/tmpl/signals.sgml @@ -350,7 +350,7 @@ g_signal_query(). @var_args: - + @@ -359,15 +359,9 @@ g_signal_query(). @detailed_signal: @c_handler: @data: -@destroy_data: -@connect_flags: -@Returns: - -@swapped: -@after: - + @@ -378,7 +372,7 @@ g_signal_query(). @data: - + @@ -389,7 +383,7 @@ g_signal_query(). @data: - + @@ -397,10 +391,23 @@ g_signal_query(). @instance: @detailed_signal: @c_handler: -@data: +@gobject: +@connect_flags: +@Returns: + +@swapped: +@after: - + + + + + +@G_CONNECT_AFTER: +@G_CONNECT_SWAPPED: + + @@ -408,7 +415,8 @@ g_signal_query(). @instance: @detailed_signal: @c_handler: -@gobject: +@data: +@destroy_data: @connect_flags: @Returns: diff --git a/docs/reference/gobject/tmpl/value_types.sgml b/docs/reference/gobject/tmpl/value_types.sgml deleted file mode 100644 index 62dc75a..0000000 --- a/docs/reference/gobject/tmpl/value_types.sgml +++ /dev/null @@ -1,373 +0,0 @@ - -Standard value types - - - - - - - - - - - - - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: - - - - - - - -@value: -@v_char: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_uchar: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_boolean: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_int: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_uint: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_long: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_ulong: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_float: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_double: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_string: - - - - - - - -@value: -@v_string: - - - - -This is an internal function introduced mainly for C marshallers. - - -@value: -@v_string: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@param: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@Returns: - - - - - - - -@value: -@v_pointer: - - - - - - - -@value: -@instance: - - -- 2.7.4