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

WrappedPtr SignalInvocationHint

Defined in GI.GObject.Structs.SignalInvocationHint

Methods

wrappedPtrCalloc :: IO (Ptr SignalInvocationHint)

wrappedPtrCopy :: SignalInvocationHint -> IO SignalInvocationHint

wrappedPtrFree :: Maybe (GDestroyNotify 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.

noSignalInvocationHint :: Maybe SignalInvocationHint

A convenience alias for Nothing :: Maybe SignalInvocationHint.

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.

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 ]