Add docs for g_signal_accumulator_true_handled.

[platform/upstream/glib.git] / docs / reference / gobject / tmpl / signals.sgml

diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml
index e648c28..6a3486c 100644 (file)
--- a/docs/reference/gobject/tmpl/signals.sgml
+++ b/docs/reference/gobject/tmpl/signals.sgml
@@ -870,3 +870,21 @@ Returns the invocation hint of the innermost signal emission of instance.
 @Returns: 
 
 
+<!-- ##### FUNCTION g_signal_accumulator_true_handled ##### -->
+<para>
+A predefined #GSignalAccumulator for signals that return a
+boolean values. The behavior that this accumulator gives is
+that a return of %TRUE stops the signal emission: no further
+callbacks will be invokced, while a return of %FALSE allows
+the emission to coninue. The idea here is that a %TRUE return
+indicates that the callback <emphasis>handled</emphasis> the signal,
+and no further handling is needed.
+</para>
+
+@ihint: standard #GSignalAccumulator parameter
+@return_accu: standard #GSignalAccumulator parameter
+@handler_return: standard #GSignalAccumulator parameter
+@dummy: standard #GSignalAccumulator parameter
+@Returns: standard #GSignalAccumulator result
+
+