From 89e16ea9c7f2d30e4a26d1d557061c3d2c6f538d Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Fri, 12 Sep 2003 20:37:29 +0000 Subject: [PATCH] Add docs for g_signal_accumulator_true_handled. Fri Sep 12 16:29:29 2003 Owen Taylor * gobject/tmpl/signals.sgml: Add docs for g_signal_accumulator_true_handled. --- docs/reference/ChangeLog | 5 +++++ docs/reference/gobject/gobject-sections.txt | 1 + docs/reference/gobject/tmpl/signals.sgml | 18 ++++++++++++++++++ 3 files changed, 24 insertions(+) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index c662f2f..e1a7c1d 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Fri Sep 12 16:29:29 2003 Owen Taylor + + * gobject/tmpl/signals.sgml: Add docs for + g_signal_accumulator_true_handled. + 2003-09-12 Matthias Clasen * gobject/gobject-sections.txt: Add new g_value_take_x() functions. diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 9d6df0a..0d00a41 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -661,6 +661,7 @@ g_signal_remove_emission_hook g_signal_parse_name g_signal_get_invocation_hint g_signal_type_cclosure_new +g_signal_accumulator_true_handled g_signal_handlers_destroy diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml index e648c28..6a3486c 100644 --- 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: + + +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 handled the signal, +and no further handling is needed. + + +@ihint: standard #GSignalAccumulator parameter +@return_accu: standard #GSignalAccumulator parameter +@handler_return: standard #GSignalAccumulator parameter +@dummy: standard #GSignalAccumulator parameter +@Returns: standard #GSignalAccumulator result + + -- 2.7.4