gi-gtk-4.0.5: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.SignalAction

Description

A GtkShortcutAction 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

Exported types

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

Instances details
(GObject o, IsDescendantOf SignalAction o) => IsSignalAction o Source # 
Instance details

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

getSignalName

signalActionGetSignalName Source #

Arguments

:: (HasCallStack, MonadIO m, IsSignalAction a) 
=> a

self: a signal action

-> m Text

Returns: the name of the signal to emit

Returns the name of the signal that will be emitted.

new

signalActionNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

signalName: name of the signal to emit

-> m SignalAction

Returns: a new GtkShortcutAction

Creates an action that when activated, emits the given action signal on the provided widget.

It will also unpack the 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