From: Tim Janik Date: Tue, 9 Jan 2001 02:18:57 +0000 (+0000) Subject: added some function documentations. X-Git-Tag: GLIB_1_2_9PRE1~43 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=05122f286179241a54be561b46cc0288f1411529;p=platform%2Fupstream%2Fglib.git added some function documentations. Tue Jan 9 03:10:38 2001 Tim Janik * gobject/tmpl/types.sgml: added some function documentations. * gobject/gobject-sections.txt: buncha fixups. --- diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 4ff0629..624f878 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +Tue Jan 9 03:10:38 2001 Tim Janik + + * gobject/tmpl/types.sgml: added some function documentations. + + * gobject/gobject-sections.txt: buncha fixups. + Fri Jan 5 15:47:10 2001 Owen Taylor * glib/glib-sections.txt glib/tmpl/* glib/Makefile.am: Updated. diff --git a/docs/reference/glib/tmpl/glib-unused.sgml b/docs/reference/glib/tmpl/glib-unused.sgml index 10e64c4..687d7fe 100644 --- a/docs/reference/glib/tmpl/glib-unused.sgml +++ b/docs/reference/glib/tmpl/glib-unused.sgml @@ -1,60 +1,29 @@ - - -Checks if the given memory has already been freed. If it has it outputs -a warning message. -To use this function you must configure glib with the flag -'--enable-mem-check=yes' before compiling. - - -@mem: the memory to check. - - - -Removes a file descriptor from the list being polled. - - -@fd: the #GPollFD to remove. - - + @source: -@func: -@data: -@notify: - - - - - - - - - - - - -@loop: +@callback_data: +@callback_funcs: - + -@s1: -@s2: -@Returns: - + - +Checks if the given memory has already been freed. If it has it outputs +a warning message. +To use this function you must configure glib with the flag +'--enable-mem-check=yes' before compiling. -@Returns: +@mem: the memory to check. - + @@ -76,35 +45,13 @@ the results may be needed. See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH, #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW. - - - - - - - - - - - -@source: -@callback_data: -@callback_funcs: - - - -Turns the argument into a string literal by using the '#' stringizing operator. - - -@x: text to convert to a literal string. - - + - + @@ -123,13 +70,7 @@ priority are stored in the order in which they were added. type of source. @Returns: TRUE if an event source was found and removed. - - - - - - - + @@ -155,11 +96,24 @@ type of source. - + + + + + +@s1: +@s2: +@Returns: + + +@source: +@func: +@data: +@notify: @@ -167,12 +121,32 @@ type of source. - + + + +Removes a file descriptor from the list being polled. + + +@fd: the #GPollFD to remove. + + + + + + + + + +Turns the argument into a string literal by using the '#' stringizing operator. + + +@x: text to convert to a literal string. + @@ -180,3 +154,29 @@ type of source. @Returns: + + + + + + + + + + + +@loop: + + + + + + +@Returns: + + + + + + + diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml index a7768c7..994ffb7 100644 --- a/docs/reference/glib/tmpl/macros_misc.sgml +++ b/docs/reference/glib/tmpl/macros_misc.sgml @@ -66,6 +66,7 @@ only one statement is expected by the compiler. Portable way to copy va_list variables. + @ap1: the va_list variable to place a copy of @ap2 in. @ap2: a va_list. diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 13abe9b..80e6c13 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -9,27 +9,36 @@ G_TYPE_FUNDAMENTAL_MAX G_TYPE_DERIVE_ID G_TYPE_BRANCH_SEQNO G_TYPE_FUNDAMENTAL_LAST -GTypeFundamentals +G_TYPE_IS_ABSTRACT +G_TYPE_IS_DERIVED +G_TYPE_IS_FUNDAMENTAL +G_TYPE_IS_VALUE_TYPE G_TYPE_IS_CLASSED G_TYPE_IS_INSTANTIATABLE G_TYPE_IS_DERIVABLE G_TYPE_IS_DEEP_DERIVABLE G_TYPE_IS_INTERFACE +GTypeFundamentals GTypeInterface GTypeInstance GTypeInfo GTypeFundamentalInfo GInterfaceInfo GTypeValueTable + GType -G_TYPE_CHECK_INSTANCE_CAST -G_TYPE_CHECK_CLASS_CAST -G_TYPE_CHECK_INSTANCE_TYPE -G_TYPE_CHECK_CLASS_TYPE -G_TYPE_INSTANCE_GET_CLASS G_TYPE_FROM_INSTANCE G_TYPE_FROM_CLASS G_TYPE_FROM_INTERFACE +G_TYPE_INSTANCE_GET_CLASS +G_TYPE_INSTANCE_GET_INTERFACE +G_TYPE_CHECK_INSTANCE +G_TYPE_CHECK_INSTANCE_CAST +G_TYPE_CHECK_INSTANCE_TYPE +G_TYPE_CHECK_CLASS_CAST +G_TYPE_CHECK_CLASS_TYPE +G_TYPE_CHECK_VALUE +G_TYPE_CHECK_VALUE_TYPE g_type_init g_type_name g_type_qname @@ -37,7 +46,6 @@ g_type_from_name g_type_parent g_type_next_base g_type_is_a -g_type_conforms_to g_type_fundamental_branch_last g_type_class_ref g_type_class_peek @@ -57,29 +65,30 @@ GInterfaceInitFunc GInterfaceFinalizeFunc GTypeClassCacheFunc GTypeFlags +GTypeFundamentalFlags g_type_register_static g_type_register_dynamic g_type_register_fundamental g_type_add_interface_static g_type_add_interface_dynamic -g_type_class_is_a -g_type_check_class_cast -g_type_check_instance_cast -g_type_instance_conforms_to +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_value_table_peek g_type_add_class_cache_func g_type_remove_class_cache_func g_type_class_unref_uncached -g_type_get_plugin -g_type_fundamental_last g_type_check_instance +g_type_check_instance_cast +g_type_instance_is_a +g_type_check_class_cast +g_type_class_is_a g_type_check_value -g_type_value_conforms_to +g_type_value_is_a +g_type_value_table_peek -g_log_domain_gobject
@@ -128,6 +137,9 @@ G_TYPE_MODULE_GET_CLASS objects GObject GObjectClass +GObjectConstructParam +GObjectGetPropertyFunc +GObjectSetPropertyFunc G_OBJECT G_OBJECT_GET_CLASS G_OBJECT_TYPE @@ -139,31 +151,35 @@ G_TYPE_IS_OBJECT G_IS_OBJECT G_OBJECT_CLASS G_IS_OBJECT_CLASS -G_NOTIFY_PRIORITY -GObjectGetParamFunc -GObjectSetParamFunc GObjectFinalizeFunc -g_object_class_install_param -g_object_class_find_param_spec +g_object_class_install_property +g_object_class_find_property g_object_new g_object_new_valist g_object_set g_object_get g_object_set_valist g_object_get_valist -g_object_set_param -g_object_get_param -g_object_queue_param_changed +g_object_set_property +g_object_get_property +g_object_freeze_notify +g_object_notify +g_object_thaw_notify g_object_ref g_object_unref g_object_get_qdata g_object_set_qdata g_object_set_qdata_full g_object_steal_qdata +g_object_get_data +g_object_set_data +g_object_set_data_full +g_object_steal_data g_value_set_object g_value_get_object g_value_dup_object -G_WARN_INVALID_PARAM_ID +g_object_watch_closure +G_OBJECT_WARN_INVALID_PROPERTY_ID
@@ -183,7 +199,6 @@ G_FLAGS_CLASS_TYPE G_FLAGS_CLASS_TYPE_NAME G_IS_VALUE_ENUM G_IS_VALUE_FLAGS -G_IS_VALUE_POINTER GEnumValue GFlagsValue g_enum_get_value @@ -254,6 +269,9 @@ G_IS_VALUE_ULONG G_IS_VALUE_FLOAT G_IS_VALUE_DOUBLE G_IS_VALUE_STRING +G_IS_VALUE_POINTER +G_IS_VALUE_CCALLBACK +G_IS_VALUE_PARAM g_value_set_char g_value_get_char g_value_set_uchar @@ -273,8 +291,17 @@ g_value_get_float g_value_set_double g_value_get_double g_value_set_string +g_value_set_static_string g_value_get_string g_value_dup_string +g_value_set_param +g_value_get_param +g_value_dup_param +g_value_get_ccallback +g_value_get_pointer +g_value_set_pointer +g_value_set_ccallback +g_value_set_instance
@@ -287,12 +314,12 @@ G_PARAM_SPEC_TYPE_NAME G_PARAM_SPEC G_IS_PARAM_SPEC G_PARAM_SPEC_GET_CLASS -G_IS_PARAM_VALUE G_PARAM_SPEC_VALUE_TYPE G_TYPE_IS_PARAM GParamFlags g_param_spec_ref g_param_spec_unref +g_param_spec_sink g_param_spec_get_qdata g_param_spec_set_qdata g_param_spec_set_qdata_full @@ -302,10 +329,11 @@ g_param_value_defaults g_param_value_validate g_param_values_cmp g_param_spec_internal -g_param_spec_hash_table_new -g_param_spec_hash_table_insert -g_param_spec_hash_table_remove -g_param_spec_hash_table_lookup +g_param_spec_pool_new +g_param_spec_pool_insert +g_param_spec_pool_remove +g_param_spec_pool_lookup +g_param_type_register_static
@@ -335,6 +363,14 @@ G_IS_PARAM_SPEC_DOUBLE G_PARAM_SPEC_DOUBLE G_IS_PARAM_SPEC_STRING G_PARAM_SPEC_STRING +G_IS_PARAM_SPEC_POINTER +G_PARAM_SPEC_POINTER +G_IS_PARAM_SPEC_BOXED +G_PARAM_SPEC_BOXED +G_IS_PARAM_SPEC_CCALLBACK +G_PARAM_SPEC_CCALLBACK +G_IS_PARAM_SPEC_PARAM +G_PARAM_SPEC_PARAM G_IS_PARAM_SPEC_OBJECT G_PARAM_SPEC_OBJECT GParamSpecChar @@ -349,6 +385,10 @@ GParamSpecFlags GParamSpecFloat GParamSpecDouble GParamSpecString +GParamSpecBoxed +GParamSpecCCallback +GParamSpecParam +GParamSpecPointer GParamSpecObject g_param_spec_char g_param_spec_uchar @@ -363,6 +403,10 @@ g_param_spec_float g_param_spec_double g_param_spec_string g_param_spec_string_c +g_param_spec_boxed +g_param_spec_ccallback +g_param_spec_param +g_param_spec_pointer g_param_spec_object
@@ -384,12 +428,20 @@ GSignalEmissionHook GSignalFlags GSignalMatchType GSignalQuery +g_signal_newc g_signal_newv -g_signal_emitv +g_signal_new_valist +g_signal_query g_signal_lookup g_signal_name -g_signal_query g_signal_list_ids +g_signal_emit +g_signal_emit_by_name +g_signal_emitv +g_signal_emit_valist +g_signal_connect_data +g_signal_connect_object +g_signal_connect_closure g_signal_connect_closure_by_id g_signal_handler_block g_signal_handler_unblock @@ -400,10 +452,11 @@ g_signal_handlers_unblock_matched g_signal_handlers_disconnect_matched g_signal_has_handler_pending g_signal_stop_emission -g_signal_type_closure_new g_signal_add_emission_hook_full g_signal_remove_emission_hook g_signal_parse_name +g_signal_handlers_destroy +g_signal_type_cclosure_new
diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index bc8bb9e..971195e 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -122,14 +122,6 @@ Enumeration and Flag Types @value: - - - - - -@value: - - diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml index f1edbd4..9372f18 100644 --- a/docs/reference/gobject/tmpl/gobject-unused.sgml +++ b/docs/reference/gobject/tmpl/gobject-unused.sgml @@ -1,90 +1,88 @@ - + -@object: -@param_name: -@value: +@type: +@iface_type: +@Returns: - + -@hash_table: +@oclass: +@param_id: @pspec: - + +@hash_table: +@pspec: +@owner_type: - + -@plugin: - + -@itype: +@pspec: +@value: - + +@instance: +@iface_type: @Returns: - - - - - + -@plugin_ref: -@plugin_unref: -@complete_type_info: -@complete_interface_info: +@object: +@param_name: +@value: - + -@instance: -@signal_id: -@detail: -@closure: -@after: -@Returns: +@plugin: - + -@itype: -@struct_offset: -@Returns: +@object: +@param_name: +@value: - + @object: @param_id: +@value: @pspec: +@trailer: @@ -98,52 +96,59 @@ @G_SIGNAL_ACTION: @G_SIGNAL_NO_HOOKS: - + -@hash_table: -@pspec: -@owner_type: - + -@plugin: -@g_type: -@info: -@value_table: +@itype: +@struct_offset: +@Returns: - + +@oclass: +@param_name: +@Returns: - + -@plugin: +@object: +@param_name: + + +gtypemodule.sgml - + + -@instance: +@plugin: - + -@instance: -@iface_type: +@hash_table: +@param_name: +@owner_type: +@try_ancestors: +@trailer: @Returns: @@ -157,15 +162,6 @@ @pspec: @trailer: - - - - - -@type: -@flags: -@Returns: - @@ -175,57 +171,51 @@ @type: @Returns: - + -@hash_table: -@param_name: -@owner_type: -@try_ancestors: -@trailer: +@type: +@flags: @Returns: - -gtypemodule.sgml - - - + -@object: -@param_name: +@plugin: +@g_type: +@info: +@value_table: - + -@object: -@param_id: -@value: -@pspec: -@trailer: +@itype: - + -@pspec: -@value: +@plugin_ref: +@plugin_unref: +@complete_type_info: +@complete_interface_info: - + -@oclass: -@param_id: -@pspec: +@plugin: +@interface_type: +@instance_type: +@info: @@ -233,40 +223,31 @@ gtypemodule.sgml - + @object: -@param_name: -@value: +@param_id: +@pspec: - - + - -@type: -@iface_type: -@Returns: - + -@plugin: -@interface_type: -@instance_type: -@info: +@Returns: - + -@oclass: -@param_name: -@Returns: +@hash_table: +@pspec: diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml index a848bbb..9cb7851 100644 --- a/docs/reference/gobject/tmpl/objects.sgml +++ b/docs/reference/gobject/tmpl/objects.sgml @@ -27,6 +27,39 @@ The Base Object Type + + + + + +@pspec: +@value: +@trailer: + + + + + + +@object: +@property_id: +@value: +@pspec: +@trailer: + + + + + + + +@object: +@property_id: +@value: +@pspec: +@trailer: + + @@ -123,6 +156,26 @@ The Base Object Type @object: + + + + + +@oclass: +@property_id: +@pspec: + + + + + + + +@oclass: +@property_name: +@Returns: + + @@ -197,6 +250,51 @@ The Base Object Type @first_param_name: + + + + + +@object: +@property_name: +@value: + + + + + + + +@object: +@property_name: +@value: + + + + + + + +@object: + + + + + + + +@object: +@property_name: + + + + + + + +@object: + + @@ -255,6 +353,47 @@ The Base Object Type @Returns: + + + + + +@object: +@key: +@Returns: + + + + + + + +@object: +@key: +@data: + + + + + + + +@object: +@key: +@data: +@destroy: + + + + + + + +@object: +@key: +@Returns: + + @@ -282,3 +421,22 @@ The Base Object Type @Returns: + + + + + +@object: +@closure: + + + + + + + +@object: +@property_id: +@pspec: + + diff --git a/docs/reference/gobject/tmpl/param_specs.sgml b/docs/reference/gobject/tmpl/param_specs.sgml index bac9490..3ba8869 100644 --- a/docs/reference/gobject/tmpl/param_specs.sgml +++ b/docs/reference/gobject/tmpl/param_specs.sgml @@ -116,6 +116,14 @@ Parameter Specifications @pspec: + + + + + +@pspec: + + @@ -210,3 +218,54 @@ Parameter Specifications @Returns: + + + + + +@type_prefixing: +@Returns: + + + + + + + +@pool: +@pspec: +@owner_type: + + + + + + + +@pool: +@pspec: + + + + + + + +@pool: +@param_name: +@owner_type: +@walk_ancestors: +@trailer_p: +@Returns: + + + + + + + +@name: +@pspec_info: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml index d43a393..5512300 100644 --- a/docs/reference/gobject/tmpl/signals.sgml +++ b/docs/reference/gobject/tmpl/signals.sgml @@ -103,7 +103,11 @@ value returned by the last callback. - +This is the signature of marshaller functions, required to marshall +arrays of parameter values to signal emissions into C language callback +invocations. It is merely an alias to @GClosureMarshal since the @GClosure +mechanism takes over responsibility of actuall function invocation for the +signal system. @@ -124,16 +128,25 @@ value returned by the last callback. - +The signal flags are used to specify a signal's behaviour, the overrall +signal description outlines how especially the RUN flags controll the +stages of a signal emission. -@G_SIGNAL_RUN_FIRST: -@G_SIGNAL_RUN_LAST: -@G_SIGNAL_RUN_CLEANUP: -@G_SIGNAL_NO_RECURSE: -@G_SIGNAL_DETAILED: -@G_SIGNAL_ACTION: -@G_SIGNAL_NO_HOOKS: +@G_SIGNAL_RUN_FIRST: Invoke the object method handler in the first emission stage. +@G_SIGNAL_RUN_LAST: Invoke the object method handler in the third emission stage. +@G_SIGNAL_RUN_CLEANUP: Invoke the object method handler in the last emission stage. +@G_SIGNAL_NO_RECURSE: Signals being emitted for an object while currently being in + emission for this very object will not be emitted recursively, + but instead cause the first emission to be restarted. +@G_SIGNAL_DETAILED: This signal supports "::detail" appendixes to the signal name + upon hanlder connections and emissions. +@G_SIGNAL_ACTION: Action signals are signals that may freely be emitted on alive + objects from user code via g_signal_emit() and friends, without + the need of being embedded into extra code that performs pre or + post emission adjustments on the object. They can also be thought + of as by third-party code generically callable obejct methods. +@G_SIGNAL_NO_HOOKS: No emissions hooks are supported for this signal. @@ -168,7 +181,7 @@ filled in by the g_signal_query() function. @gpointer data2); - + @@ -176,42 +189,46 @@ filled in by the g_signal_query() function. @signal_name: @itype: @signal_flags: -@class_closure: +@class_offset: @accumulator: @c_marshaller: @return_type: @n_params: -@param_types: +@Varargs: @Returns: - - - - - -@instance_and_params: -@signal_id: -@detail: -@return_value: - - - + -@name: +@signal_name: @itype: +@signal_flags: +@class_closure: +@accumulator: +@c_marshaller: +@return_type: +@n_params: +@param_types: @Returns: - + -@signal_id: +@signal_name: +@itype: +@signal_flags: +@class_closure: +@accumulator: +@c_marshaller: +@return_type: +@n_params: +@args: @Returns: @@ -230,6 +247,25 @@ be considered constant and have to be left untouched. values upon success. + + + + + +@name: +@itype: +@Returns: + + + + + + + +@signal_id: +@Returns: + + List the signals by id, that a certain instance or interface type @@ -242,6 +278,93 @@ g_signal_query(). @Returns: Newly allocated array of signal ids + + + + + +@instance: +@signal_id: +@detail: +@Varargs: + + + + + + + +@instance: +@detailed_signal: +@Varargs: + + + + + + + +@instance_and_params: +@signal_id: +@detail: +@return_value: + + + + + + + +@instance: +@signal_id: +@detail: +@var_args: + + + + + + + +@instance: +@detailed_signal: +@c_handler: +@data: +@destroy_data: +@swapped: +@after: +@Returns: + + + + + + + +@instance: +@detailed_signal: +@c_handler: +@gobject: +@swapped: +@after: +@Returns: + + + + + + + +@instance: +@detailed_signal: +@closure: +@after: +@Returns: + +@signal_id: +@detail: + + @@ -452,3 +575,21 @@ and @detail quark. @signal_id_p and @detail_p contain valid return values. + + + + + +@instance: + + + + + + + +@itype: +@struct_offset: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/standard_params.sgml b/docs/reference/gobject/tmpl/standard_params.sgml index f31aa4c..ec7df7c 100644 --- a/docs/reference/gobject/tmpl/standard_params.sgml +++ b/docs/reference/gobject/tmpl/standard_params.sgml @@ -206,6 +206,70 @@ Standard Parameter Types @pspec: + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@pspec: + + + + + + + +@pspec: + + @@ -343,6 +407,34 @@ Standard Parameter Types @null_fold_if_empty: @ensure_non_null: + + + + + +@parent_instance: + + + + + + +@parent_instance: + + + + + + +@parent_instance: + + + + + + +@parent_instance: + @@ -537,6 +629,56 @@ Standard Parameter Types @Returns: + + + + + +@name: +@nick: +@blurb: +@boxed_type: +@flags: +@Returns: + + + + + + + +@name: +@nick: +@blurb: +@flags: +@Returns: + + + + + + + +@name: +@nick: +@blurb: +@param_type: +@flags: +@Returns: + + + + + + + +@name: +@nick: +@blurb: +@flags: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/types.sgml b/docs/reference/gobject/tmpl/types.sgml index 54cf7df..5adeac8 100644 --- a/docs/reference/gobject/tmpl/types.sgml +++ b/docs/reference/gobject/tmpl/types.sgml @@ -59,6 +59,78 @@ GType + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + + + + + + +@type: + + @@ -109,46 +181,6 @@ GType @G_TYPE_PARAM_BOXED: @G_TYPE_PARAM_OBJECT: - - - - - -@type: - - - - - - - -@type: - - - - - - - -@type: - - - - - - - -@type: - - - - - - - -@type: - - @@ -207,45 +239,59 @@ GType @lcopy_type: @lcopy_value: - + @instance: -@g_type: -@c_type: - + @g_class: + + + + + + + +@g_iface: + + + + + + + +@instance: @g_type: @c_type: - + @instance: @g_type: +@c_type: - + -@g_class: -@g_type: +@instance: - + @@ -255,91 +301,122 @@ GType @c_type: - + @instance: +@g_type: - + @g_class: +@g_type: +@c_type: - + -@g_iface: +@g_class: +@g_type: - + +@value: - + -@type: -@Returns: +@value: +@g_type: - + +Prior to any use of the type system, g_type_init() has to be called to initialize +the type system and assorted other code portions (such as the various fundamental +type implementations or the signal system). + + + + + +Return the unique name that is assigned to a type ID (this is the preferred method +to find out whether a specific type has been registered for the passed in ID yet). -@type: -@Returns: +@type: Type to return name for. +@Returns: Static type name or NULL. - + +Return the corresponding quark of the type IDs name. + + +@type: Type to return quark of type name for. +@Returns: The type names quark or 0. + + + +Lookup the type ID from a given type name, returns 0 if no type has been registered under this name +(this is the preferred method to find out by name whether a specific type has been registered yet). -@name: -@Returns: +@name: Type name to lookup. +@Returns: Corresponding type ID or 0. - +Return the direct parent type of the passed in type. +If the passed in type has no parent, i.e. is a fundamental type, 0 is returned. -@type: -@Returns: +@type: The derived type. +@Returns: The parent type. - +Given a @type and a @base_type which is contained in its anchestry, return +the type that @base_type is the direct parent type for. +In other words, for a given type branch, e.g. Root-Derived1-Derived2-Leaf, specified +through @type=Leaf, return the nextmost child of @base_type. In this example, for +@base_type=Derived1, the returned value would be Derived2, for @base_type=Root, the +returned value would be Derived1. -@type: -@base_type: -@Returns: +@type: Descendant of @base_type and the type to be returned. +@base_type: Direct parent of the returned type. +@Returns: Immediate child of @base_type and anchestor of @type. - +Check whether @type is a descendant of @is_a_type. -@type: -@is_a_type: -@Returns: +@type: Type to check anchestry for. +@is_a_type: Possible anchestor of @type. +@Returns: %TRUE if @type is_a @is_a_type holds true. @@ -398,22 +475,25 @@ GType - +Return a newly allocated and 0 terminated array of type IDs, listing the +child types of @type. The return value has to be g_free()ed after use. -@type: -@n_children: -@Returns: +@type: The parent type. +@n_children: Optional #guint pointer to contain the number of child types. +@Returns: Newly allocated and 0 terminated array of child types. - +Return a newly allocated and 0 terminated array of type IDs, listing the +interface types that @type conforms to. The return value has to be +g_free()ed after use. -@type: -@n_interfaces: -@Returns: +@type: The type to list interface types for. +@n_interfaces: Optional #guint pointer to contain the number of interface types. +@Returns: Newly allocated and 0 terminated array of interface types. @@ -514,6 +594,16 @@ GType @G_TYPE_FLAG_ABSTRACT: + + + + + +@G_TYPE_FLAG_CLASSED: +@G_TYPE_FLAG_INSTANTIATABLE: +@G_TYPE_FLAG_DERIVABLE: +@G_TYPE_FLAG_DEEP_DERIVABLE: + @@ -571,33 +661,30 @@ GType @plugin: - + -@g_class: -@is_a_type: +@type: @Returns: - + -@g_class: -@is_a_type: +@instance_type: +@implementation_type: @Returns: - + -@instance: -@iface_type: @Returns: @@ -628,15 +715,6 @@ GType @instance: - - - - - -@type: -@Returns: - - @@ -663,29 +741,52 @@ GType @g_class: - + -@type: +@instance: @Returns: - + +@instance: +@iface_type: @Returns: - + @instance: +@iface_type: +@Returns: + + + + + + + +@g_class: +@is_a_type: +@Returns: + + + + + + + +@g_class: +@is_a_type: @Returns: @@ -698,3 +799,22 @@ GType @Returns: + + + + + +@value: +@type: +@Returns: + + + + + + + +@type: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/value_types.sgml b/docs/reference/gobject/tmpl/value_types.sgml index e8b37f3..b7907b3 100644 --- a/docs/reference/gobject/tmpl/value_types.sgml +++ b/docs/reference/gobject/tmpl/value_types.sgml @@ -94,6 +94,30 @@ Standard value types @value: + + + + + +@value: + + + + + + + +@value: + + + + + + + +@value: + + @@ -265,6 +289,15 @@ Standard value types @v_string: + + + + + +@value: +@v_string: + + @@ -283,3 +316,77 @@ Standard value types @Returns: + + + + + +@value: +@param: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@callback_func: +@callback_data: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@v_pointer: + + + + + + + +@value: +@callback_func: +@callback_data: + + + + + + + +@value: +@instance: + + diff --git a/gobject/gtype.h b/gobject/gtype.h index 28a22c7..3fa186f 100644 --- a/gobject/gtype.h +++ b/gobject/gtype.h @@ -313,18 +313,18 @@ void g_type_class_unref_uncached (gpointer g_class); /*< private >*/ -GTypeClass* g_type_check_class_cast (GTypeClass *g_class, - GType is_a_type); -gboolean g_type_class_is_a (GTypeClass *g_class, - GType is_a_type); +gboolean g_type_check_instance (GTypeInstance *instance); GTypeInstance* g_type_check_instance_cast (GTypeInstance *instance, GType iface_type); gboolean g_type_instance_is_a (GTypeInstance *instance, GType iface_type); +GTypeClass* g_type_check_class_cast (GTypeClass *g_class, + GType is_a_type); +gboolean g_type_class_is_a (GTypeClass *g_class, + GType is_a_type); gboolean g_type_check_value (GValue *value); gboolean g_type_value_is_a (GValue *value, GType type); -gboolean g_type_check_instance (GTypeInstance *instance); GTypeValueTable* g_type_value_table_peek (GType type);