luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-11-05 10:38:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'ebassi/signal-flags-docs' into 'main'

Browse Source 
docs: Document GSignalFlags members added after 2.0

See merge request GNOME/glib!4553
This commit is contained in:
Philip Withnall
2025-03-12 11:16:06 +00:00
parent 34608c9426 3de213b622
commit 89983f33b0
1 changed files with 33 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
gobject/gsignal.h
View File

@@ -124,14 +124,6 @@ typedef gboolean (*GSignalAccumulator) (GSignalInvocationHint *ihint,
* of as object methods which can be called generically by * of as object methods which can be called generically by
* third-party code. * third-party code.
* @G_SIGNAL_NO_HOOKS: No emissions hooks are supported for this signal. * @G_SIGNAL_NO_HOOKS: No emissions hooks are supported for this signal.
* @G_SIGNAL_MUST_COLLECT: Varargs signal emission will always collect the
* arguments, even if there are no signal handlers connected. Since 2.30.
* @G_SIGNAL_DEPRECATED: The signal is deprecated and will be removed
* in a future version. A warning will be generated if it is connected while
* running with G_ENABLE_DIAGNOSTIC=1. Since 2.32.
* @G_SIGNAL_ACCUMULATOR_FIRST_RUN: Only used in #GSignalAccumulator accumulator
* functions for the #GSignalInvocationHint::run_type field to mark the first
* call to the accumulator function for a signal emission. Since 2.68.
* *
* The signal flags are used to specify a signal's behaviour. * The signal flags are used to specify a signal's behaviour.
*/ */
@@ -149,6 +141,39 @@ typedef enum
/* normal signal flags until 1 << 16 */ /* normal signal flags until 1 << 16 */
G_SIGNAL_ACCUMULATOR_FIRST_RUN = 1 << 17, G_SIGNAL_ACCUMULATOR_FIRST_RUN = 1 << 17,
} GSignalFlags; } GSignalFlags;
/**
* G_SIGNAL_MUST_COLLECT:
*
* Varargs signal emission will always collect the arguments, even if there
* are no signal handlers connected.
*
* Since: 2.30
*/
/**
* G_SIGNAL_DEPRECATED:
*
* The signal is deprecated and will be removed in a future version.
*
* A warning will be generated if it is connected while running with
* `G_ENABLE_DIAGNOSTIC=1`.
*
* Since: 2.32
*/
/**
* G_SIGNAL_ACCUMULATOR_FIRST_RUN:
*
* The signal accumulator was invoked for the first time.
*
* This flag is only used in [callback@GObject.SignalAccumulator][accumulator functions]
* for the `run_type` field of the [struct@GObject.SignalInvocationHint], to
* mark the first call to the accumulator function for a signal emission.
*
* Since: 2.68
*/
/** /**
* G_SIGNAL_FLAGS_MASK: * G_SIGNAL_FLAGS_MASK:
* *