| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GObject.Structs.SignalInvocationHint
Description
The SignalInvocationHint structure is used to pass on additional information
to callbacks during a signal emission.
Synopsis
- newtype SignalInvocationHint = SignalInvocationHint (ManagedPtr SignalInvocationHint)
- newZeroSignalInvocationHint :: MonadIO m => m SignalInvocationHint
- noSignalInvocationHint :: Maybe SignalInvocationHint
- getSignalInvocationHintDetail :: MonadIO m => SignalInvocationHint -> m Word32
- setSignalInvocationHintDetail :: MonadIO m => SignalInvocationHint -> Word32 -> m ()
- getSignalInvocationHintRunType :: MonadIO m => SignalInvocationHint -> m [SignalFlags]
- setSignalInvocationHintRunType :: MonadIO m => SignalInvocationHint -> [SignalFlags] -> m ()
- getSignalInvocationHintSignalId :: MonadIO m => SignalInvocationHint -> m Word32
- setSignalInvocationHintSignalId :: MonadIO m => SignalInvocationHint -> Word32 -> m ()
Exported types
newtype SignalInvocationHint Source #
Memory-managed wrapper type.
Constructors
| SignalInvocationHint (ManagedPtr SignalInvocationHint) |
Instances
| WrappedPtr SignalInvocationHint Source # | |
| tag ~ AttrSet => Constructible SignalInvocationHint tag Source # | |
Defined in GI.GObject.Structs.SignalInvocationHint Methods new :: MonadIO m => (ManagedPtr SignalInvocationHint -> SignalInvocationHint) -> [AttrOp SignalInvocationHint tag] -> m SignalInvocationHint # | |
newZeroSignalInvocationHint :: MonadIO m => m SignalInvocationHint Source #
Construct a SignalInvocationHint struct initialized to zero.
noSignalInvocationHint :: Maybe SignalInvocationHint Source #
A convenience alias for Nothing :: Maybe SignalInvocationHint.
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
setsignalInvocationHint [ #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] 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
setsignalInvocationHint [ #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
setsignalInvocationHint [ #signalId:=value ]