GI.GObject.Structs.SignalInvocationHint

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

Exported types

newtype SignalInvocationHint

Memory-managed wrapper type.

Constructors

SignalInvocationHint (ManagedPtr SignalInvocationHint)

Instances

Eq SignalInvocationHint

Defined in GI.GObject.Structs.SignalInvocationHint

Methods

(==) :: SignalInvocationHint -> SignalInvocationHint -> Bool

(/=) :: SignalInvocationHint -> SignalInvocationHint -> Bool

BoxedPtr SignalInvocationHint

Defined in GI.GObject.Structs.SignalInvocationHint

Methods

boxedPtrCopy :: SignalInvocationHint -> IO SignalInvocationHint

boxedPtrFree :: SignalInvocationHint -> IO ()

CallocPtr SignalInvocationHint

Defined in GI.GObject.Structs.SignalInvocationHint

Methods

boxedPtrCalloc :: IO (Ptr SignalInvocationHint)

ManagedPtrNewtype SignalInvocationHint

Defined in GI.GObject.Structs.SignalInvocationHint

Methods

toManagedPtr :: SignalInvocationHint -> ManagedPtr SignalInvocationHint

tag ~ 'AttrSet => Constructible SignalInvocationHint tag

Defined in GI.GObject.Structs.SignalInvocationHint

Methods

new :: MonadIO m => (ManagedPtr SignalInvocationHint -> SignalInvocationHint) -> [AttrOp SignalInvocationHint tag] -> m SignalInvocationHint

newZeroSignalInvocationHint :: MonadIO m => m SignalInvocationHint

Construct a SignalInvocationHint struct initialized to zero.

Methods

Properties

detail

The detail passed on for this emission

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

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

get signalInvocationHint #detail

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

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]

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 ()

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

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 ()

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

set signalInvocationHint [ #signalId := value ]