gi-gobject-2.0.27: GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GObject.Structs.SignalInvocationHint

Description

The SignalInvocationHint structure is used to pass on additional information to callbacks during a signal emission.

Synopsis

Exported types

newZeroSignalInvocationHint :: MonadIO m => m SignalInvocationHint Source #

Construct a SignalInvocationHint struct initialized to zero.

Methods

Properties

detail

The detail passed on for this emission

getSignalInvocationHintDetail :: MonadIO m => SignalInvocationHint -> m Word32 Source #

Get the value of the “detail” field. When overloading is enabled, this is equivalent to

get signalInvocationHint #detail

setSignalInvocationHintDetail :: MonadIO m => SignalInvocationHint -> Word32 -> m () Source #

Set the value of the “detail” field. When overloading is enabled, this is equivalent to

set signalInvocationHint [ #detail := value ]

runType

The stage the signal emission is currently in, this field will contain one of SignalFlagsRunFirst, SignalFlagsRunLast or SignalFlagsRunCleanup and SignalFlagsAccumulatorFirstRun. SignalFlagsAccumulatorFirstRun is only set for the first run of the accumulator function for a signal emission.

getSignalInvocationHintRunType :: MonadIO m => SignalInvocationHint -> m [SignalFlags] Source #

Get the value of the “run_type” field. When overloading is enabled, this is equivalent to

get signalInvocationHint #runType

setSignalInvocationHintRunType :: MonadIO m => SignalInvocationHint -> [SignalFlags] -> m () Source #

Set the value of the “run_type” field. When overloading is enabled, this is equivalent to

set signalInvocationHint [ #runType := value ]

signalId

The signal id of the signal invoking the callback

getSignalInvocationHintSignalId :: MonadIO m => SignalInvocationHint -> m Word32 Source #

Get the value of the “signal_id” field. When overloading is enabled, this is equivalent to

get signalInvocationHint #signalId

setSignalInvocationHintSignalId :: MonadIO m => SignalInvocationHint -> Word32 -> m () Source #

Set the value of the “signal_id” field. When overloading is enabled, this is equivalent to

set signalInvocationHint [ #signalId := value ]