gsignal: improve g_signal_new docs.

Using 0 for class_offset is only a means to be able to add signal when running
out of slots in the lass structure.
This commit is contained in:
Stefan Kost 2010-03-06 14:15:25 +02:00
parent fa32ee5610
commit 3d98c449b1

View File

@ -1285,7 +1285,7 @@ g_signal_query (guint signal_id,
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_offset: The offset of the function pointer in the class structure * @class_offset: The offset of the function pointer in the class structure
* for this type. Used to invoke a class method generically. Pass 0 to * for this type. Used to invoke a class method generically. Pass 0 to
* not associate a class method with this signal. * not associate a class method slot with this signal.
* @accumulator: the accumulator for this signal; may be %NULL. * @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator. * @accu_data: user data for the @accumulator.
* @c_marshaller: the function to translate arrays of parameter values to * @c_marshaller: the function to translate arrays of parameter values to
@ -1305,6 +1305,11 @@ g_signal_query (guint signal_id,
* When registering a signal and looking up a signal, either separator can * When registering a signal and looking up a signal, either separator can
* be used, but they cannot be mixed. * be used, but they cannot be mixed.
* *
* If 0 is used for @class_offset subclasses cannot override the class handler
* in their <code>class_init</code> method by doing
* <code>super_class->signal_handler = my_signal_handler</code>. Instead they
* will have to use g_signal_override_class_handler().
*
* Returns: the signal id * Returns: the signal id
*/ */
guint guint