Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
ShortcutAction
is the object used to describe what a Shortcut
should
do when triggered. To activate a ShortcutAction
manually,
shortcutActionActivate
can be called.
GtkShortcutActions
contain functions that allow easy presentation to end
users as well as being printed for debugging.
All GtkShortcutActions
are immutable, you can only specify their properties
during construction. If you want to change a action, you have to replace it
with a new one. If you need to pass arguments to an action, these are specified
by the higher-level Shortcut
object.
GTK provides various actions:
MnemonicAction
: a shortcut action that callswidgetMnemonicActivate
CallbackAction
: a shortcut action that invokes a given callbackSignalAction
: a shortcut action that emits a given signalActivateAction
: a shortcut action that callswidgetActivate
NamedAction
: a shortcut action that callsgtk_widget_activate_action()
NothingAction
: a shortcut action that does nothing
GtkShortcutAction as GtkBuildable
GtkShortcut
Synopsis
- newtype ShortcutAction = ShortcutAction (ManagedPtr ShortcutAction)
- class (GObject o, IsDescendantOf ShortcutAction o) => IsShortcutAction o
- toShortcutAction :: (MonadIO m, IsShortcutAction o) => o -> m ShortcutAction
- shortcutActionActivate :: (HasCallStack, MonadIO m, IsShortcutAction a, IsWidget b) => a -> [ShortcutActionFlags] -> b -> Maybe GVariant -> m Bool
- shortcutActionParseString :: (HasCallStack, MonadIO m) => Text -> m (Maybe ShortcutAction)
- shortcutActionPrint :: (HasCallStack, MonadIO m, IsShortcutAction a) => a -> String -> m ()
- shortcutActionToString :: (HasCallStack, MonadIO m, IsShortcutAction a) => a -> m Text
Exported types
newtype ShortcutAction Source #
Memory-managed wrapper type.
Instances
Eq ShortcutAction Source # | |
Defined in GI.Gtk.Objects.ShortcutAction (==) :: ShortcutAction -> ShortcutAction -> Bool # (/=) :: ShortcutAction -> ShortcutAction -> Bool # | |
IsGValue ShortcutAction Source # | Convert |
Defined in GI.Gtk.Objects.ShortcutAction toGValue :: ShortcutAction -> IO GValue # fromGValue :: GValue -> IO ShortcutAction # | |
ManagedPtrNewtype ShortcutAction Source # | |
Defined in GI.Gtk.Objects.ShortcutAction | |
TypedObject ShortcutAction Source # | |
Defined in GI.Gtk.Objects.ShortcutAction | |
GObject ShortcutAction Source # | |
Defined in GI.Gtk.Objects.ShortcutAction | |
HasParentTypes ShortcutAction Source # | |
Defined in GI.Gtk.Objects.ShortcutAction | |
type ParentTypes ShortcutAction Source # | |
Defined in GI.Gtk.Objects.ShortcutAction |
class (GObject o, IsDescendantOf ShortcutAction o) => IsShortcutAction o Source #
Type class for types which can be safely cast to ShortcutAction
, for instance with toShortcutAction
.
Instances
(GObject o, IsDescendantOf ShortcutAction o) => IsShortcutAction o Source # | |
Defined in GI.Gtk.Objects.ShortcutAction |
toShortcutAction :: (MonadIO m, IsShortcutAction o) => o -> m ShortcutAction Source #
Cast to ShortcutAction
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
activate
shortcutActionActivate Source #
:: (HasCallStack, MonadIO m, IsShortcutAction a, IsWidget b) | |
=> a |
|
-> [ShortcutActionFlags] |
|
-> b |
|
-> Maybe GVariant |
|
-> m Bool | Returns: |
Activates the action on the widget
with the given args
.
Note that some actions ignore the passed in flags
, widget
or args
.
Activation of an action can fail for various reasons. If the action
is not supported by the widget
, if the args
don't match the action
or if the activation otherwise had no effect, False
will be returned.
parseString
shortcutActionParseString Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe ShortcutAction) | Returns: a new |
Tries to parse the given string into an action. On
success, the parsed action is returned. When parsing
failed, Nothing
is returned.
The accepted strings are:
nothing
, forNothingAction
activate
, forActivateAction
mnemonic-activate
, forMnemonicAction
action(NAME)
, for aNamedAction
for the action namedNAME
signal(NAME)
, for aSignalAction
for the signalNAME
:: (HasCallStack, MonadIO m, IsShortcutAction a) | |
=> a |
|
-> String |
|
-> m () |
Prints the given action into a string for the developer. This is meant for debugging and logging.
The form of the representation may change at any time and is not guaranteed to stay identical.
toString
shortcutActionToString Source #
:: (HasCallStack, MonadIO m, IsShortcutAction a) | |
=> a |
|
-> m Text | Returns: a new string |
Prints the given action into a human-readable string.
This is a small wrapper around shortcutActionPrint
to help
when debugging.