GI.Gtk.Objects.ShortcutAction

GtkShortcutAction encodes an action that can be triggered by a keyboard shortcut.

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 GtkShortcut object.

To activate a GtkShortcutAction manually, shortcutActionActivate can be called.

GTK provides various actions:

• MnemonicAction: a shortcut action that calls widgetMnemonicActivate
• CallbackAction: a shortcut action that invokes a given callback
• SignalAction: a shortcut action that emits a given signal
• ActivateAction: a shortcut action that calls widgetActivate
• NamedAction: a shortcut action that calls gtk_widget_activate_action()
• NothingAction: a shortcut action that does nothing

Exported types

newtype ShortcutAction

Memory-managed wrapper type.

Constructors

ShortcutAction (ManagedPtr ShortcutAction)

Instances

Eq ShortcutAction

Defined in GI.Gtk.Objects.ShortcutAction

Methods

(==) :: ShortcutAction -> ShortcutAction -> Bool

(/=) :: ShortcutAction -> ShortcutAction -> Bool

GObject ShortcutAction

Defined in GI.Gtk.Objects.ShortcutAction

ManagedPtrNewtype ShortcutAction

Defined in GI.Gtk.Objects.ShortcutAction

Methods

toManagedPtr :: ShortcutAction -> ManagedPtr ShortcutAction

TypedObject ShortcutAction

Defined in GI.Gtk.Objects.ShortcutAction

Methods

glibType :: IO GType

HasParentTypes ShortcutAction

Defined in GI.Gtk.Objects.ShortcutAction

IsGValue (Maybe ShortcutAction)

Convert ShortcutAction to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.ShortcutAction

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ShortcutAction -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ShortcutAction)

type ParentTypes ShortcutAction

Defined in GI.Gtk.Objects.ShortcutAction

type ParentTypes ShortcutAction = '[Object]

class (GObject o, IsDescendantOf ShortcutAction o) => IsShortcutAction o

Type class for types which can be safely cast to ShortcutAction, for instance with toShortcutAction.

Instances

(GObject o, IsDescendantOf ShortcutAction o) => IsShortcutAction o

Defined in GI.Gtk.Objects.ShortcutAction

toShortcutAction :: (MonadIO m, IsShortcutAction o) => o -> m ShortcutAction

Cast to ShortcutAction, 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.

Setters

setData, setDataFull, setProperty.

activate

shortcutActionActivate

Arguments

:: (HasCallStack, MonadIO m, IsShortcutAction a, IsWidget b)

=> a

self: a GtkShortcutAction

-> [ShortcutActionFlags]

flags: flags to activate with

-> b

widget: Target of the activation

-> Maybe GVariant

args: arguments to pass

-> m Bool

Returns: True if this action was activated successfully

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

Arguments

:: (HasCallStack, MonadIO m)

=> Text

string: the string to parse

-> m (Maybe ShortcutAction)

Returns: a new GtkShortcutAction

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, for GtkNothingAction
• activate, for GtkActivateAction
• mnemonic-activate, for GtkMnemonicAction
• action(NAME), for a GtkNamedAction for the action named NAME
• signal(NAME), for a GtkSignalAction for the signal NAME

print

shortcutActionPrint

Arguments

:: (HasCallStack, MonadIO m, IsShortcutAction a)

=> a

self: a GtkShortcutAction

-> String

string: a GString to print into

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

Arguments

:: (HasCallStack, MonadIO m, IsShortcutAction a)

=> a

self: a GtkShortcutAction

-> 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.