luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-15 12:08:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for g_signal_accumulator_true_handled.

Browse Source 
Fri Sep 12 16:29:29 2003  Owen Taylor  <otaylor@redhat.com>

        * gobject/tmpl/signals.sgml: Add docs for
        g_signal_accumulator_true_handled.
This commit is contained in:
Owen Taylor 2003-09-12 20:37:29 +00:00 committed by Owen Taylor
parent 4ec041d593
commit 89e16ea9c7
3 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
Fri Sep 12 16:29:29 2003 Owen Taylor <otaylor@redhat.com>
* gobject/tmpl/signals.sgml: Add docs for
g_signal_accumulator_true_handled.
2003-09-12 Matthias Clasen <maclas@gmx.de>
* gobject/gobject-sections.txt: Add new g_value_take_x() functions.

1
docs/reference/gobject/gobject-sections.txt
View File

@ -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
<SUBSECTION Private>
g_signal_handlers_destroy
</SECTION>

18
docs/reference/gobject/tmpl/signals.sgml
View File

@ -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