Sync parameter names with docs and implementation.

* gsignal.h (g_signal_add_emission_hook):
	* gtype.h (g_type_interface_get_plugin): Sync parameter names with
	docs and implementation.

	* gtype.c (g_type_add_interface_dynamic):
	(g_type_interface_get_plugin):
	(g_type_interface_peek_parent):
	(g_type_query): Add docs.

	* gobject/tmpl/gtype.sgml: Add docs.

	* gobject/tmpl/signals.sgml: Regenerated.
This commit is contained in:
Matthias Clasen
2002-12-03 23:54:55 +00:00
parent 78afc275dc
commit 6df677db74
7 changed files with 98 additions and 33 deletions

View File

@@ -1,3 +1,14 @@
2002-12-04 Matthias Clasen <maclas@gmx.de>
* gsignal.h (g_signal_add_emission_hook):
* gtype.h (g_type_interface_get_plugin): Sync parameter names with
docs and implementation.
* gtype.c (g_type_add_interface_dynamic):
(g_type_interface_get_plugin):
(g_type_interface_peek_parent):
(g_type_query): Add docs.
2002-12-03 Matthias Clasen <maclas@gmx.de>
* gtype.c (g_type_get_qdata):

View File

@@ -161,7 +161,7 @@ void g_signal_stop_emission (gpointer instance,
void g_signal_stop_emission_by_name (gpointer instance,
const gchar *detailed_signal);
gulong g_signal_add_emission_hook (guint signal_id,
GQuark quark,
GQuark detail,
GSignalEmissionHook hook_func,
gpointer hook_data,
GDestroyNotify data_destroy);

View File

@@ -1961,6 +1961,16 @@ g_type_add_interface_static (GType instance_type,
G_WRITE_UNLOCK (&type_rw_lock);
}
/**
* g_type_add_interface_dynamic:
* @instance_type: the #GType value of an instantiable type.
* @interface_type: the #GType value of an interface type.
* @plugin: the #GTypePlugin structure to retrieve the #GInterfaceInfo from.
*
* Adds the dynamic @interface_type to @instantiable_type. The information
* contained in the #GTypePlugin structure pointed to by @plugin
* is used to manage the relationship.
**/
void
g_type_add_interface_dynamic (GType instance_type,
GType interface_type,
@@ -2151,6 +2161,19 @@ g_type_interface_peek (gpointer instance_class,
return vtable;
}
/**
* g_type_interface_peek_parent:
* @g_iface: A #GTypeInterface structure.
*
* Returns the corresponding #GTypeInterface structure of the parent type
* of the instance type to which @g_iface belongs. This is useful when
* deriving the implementation of an interface from the parent type and
* then possibly overriding some methods.
*
* Return value: The corresponding #GTypeInterface structure of the parent type
* of the instance type to which @g_iface belongs, or %NULL if the parent type
* doesn't conform to the interface.
**/
gpointer
g_type_interface_peek_parent (gpointer g_iface)
{
@@ -2550,6 +2573,18 @@ type_add_flags_W (TypeNode *node,
type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
}
/**
* g_type_query:
* @type: the #GType value of a static, classed type.
* @query: A user provided structure that is filled in with constant values
* upon success.
*
* Queries the type system for information about a specific type.
* This function will fill in a user-provided structure to hold type-specific
* information. If an invalid #GType is passed in, the @type member of the
* #GTypeQuery is 0. All members filled into the #GTypeQuery structure should
* be considered constant and have to be left untouched.
**/
void
g_type_query (GType type,
GTypeQuery *query)
@@ -2625,6 +2660,19 @@ g_type_get_plugin (GType type)
return node ? node->plugin : NULL;
}
/**
* g_type_interface_get_plugin:
* @instance_type: the #GType value of an instantiatable type.
* @interface_type: the #GType value of an interface type.
*
* Returns the #GTypePlugin structure for the dynamic interface
* @interface_type which has been added to @instance_type, or
* %NULL if @interface_type has not been added to @instance_type or does
* not have a #GTypePlugin structure. See g_type_add_interface_dynamic().
*
* Return value: the #GTypePlugin for the dynamic interface @interface_type
* of @instance_type.
**/
GTypePlugin*
g_type_interface_get_plugin (GType instance_type,
GType interface_type)

View File

@@ -302,7 +302,7 @@ GType *g_type_interface_prerequisites (GType interface_t
/* --- protected (for fundamental type implementations) --- */
GTypePlugin* g_type_get_plugin (GType type);
GTypePlugin* g_type_interface_get_plugin (GType instance_type,
GType implementation_type);
GType interface_type);
GType g_type_fundamental_next (void);
GType g_type_fundamental (GType type_id);
GTypeInstance* g_type_create_instance (GType type);