| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.SignalAction
Description
A ShortcutAction that emits a signal.
Signals that are used in this way are referred to as keybinding signals,
and they are expected to be defined with the SignalFlagsAction flag.
Synopsis
- newtype SignalAction = SignalAction (ManagedPtr SignalAction)
- class (GObject o, IsDescendantOf SignalAction o) => IsSignalAction o
- toSignalAction :: (MonadIO m, IsSignalAction o) => o -> m SignalAction
- signalActionGetSignalName :: (HasCallStack, MonadIO m, IsSignalAction a) => a -> m Text
- signalActionNew :: (HasCallStack, MonadIO m) => Text -> m SignalAction
- constructSignalActionSignalName :: (IsSignalAction o, MonadIO m) => Text -> m (GValueConstruct o)
- getSignalActionSignalName :: (MonadIO m, IsSignalAction o) => o -> m Text
Exported types
newtype SignalAction Source #
Memory-managed wrapper type.
Constructors
| SignalAction (ManagedPtr SignalAction) |
Instances
| Eq SignalAction Source # | |
Defined in GI.Gtk.Objects.SignalAction | |
| GObject SignalAction Source # | |
Defined in GI.Gtk.Objects.SignalAction | |
| ManagedPtrNewtype SignalAction Source # | |
Defined in GI.Gtk.Objects.SignalAction Methods toManagedPtr :: SignalAction -> ManagedPtr SignalAction | |
| TypedObject SignalAction Source # | |
Defined in GI.Gtk.Objects.SignalAction | |
| HasParentTypes SignalAction Source # | |
Defined in GI.Gtk.Objects.SignalAction | |
| IsGValue (Maybe SignalAction) Source # | Convert |
Defined in GI.Gtk.Objects.SignalAction Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe SignalAction -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe SignalAction) | |
| type ParentTypes SignalAction Source # | |
Defined in GI.Gtk.Objects.SignalAction | |
class (GObject o, IsDescendantOf SignalAction o) => IsSignalAction o Source #
Type class for types which can be safely cast to SignalAction, for instance with toSignalAction.
Instances
| (GObject o, IsDescendantOf SignalAction o) => IsSignalAction o Source # | |
Defined in GI.Gtk.Objects.SignalAction | |
toSignalAction :: (MonadIO m, IsSignalAction o) => o -> m SignalAction Source #
Cast to SignalAction, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
activate, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, print, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, watchClosure.
Getters
getData, getProperty, getQdata, getSignalName.
Setters
getSignalName
signalActionGetSignalName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSignalAction a) | |
| => a |
|
| -> m Text | Returns: the name of the signal to emit |
Returns the name of the signal that will be emitted.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> m SignalAction | Returns: a new |
Creates an action that when activated, emits the given action signal on the provided widget unpacking the given args into arguments passed to the signal.
Properties
signalName
The name of the signal to emit.
constructSignalActionSignalName :: (IsSignalAction o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “signal-name” property. This is rarely needed directly, but it is used by new.
getSignalActionSignalName :: (MonadIO m, IsSignalAction o) => o -> m Text Source #
Get the value of the “signal-name” property.
When overloading is enabled, this is equivalent to
get signalAction #signalName