GI.Gtk.Objects.ShortcutController

ShortcutController is an event controller that manages shortcuts.

Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a Label, or by installing a key binding using gtk_widget_class_add_binding(), or by adding accelerators to global actions using applicationSetAccelsForAction.

But it is possible to create your own shortcut controller, and add shortcuts to it.

ShortcutController implements ListModel for querying the shortcuts that have been added to it.

GtkShortcutController as a GtkBuildable

GtkShortcutControllers can be creates in ui files to set up shortcuts in the same place as the widgets.

An example of a UI definition fragment with GtkShortcutController: > > class='GtkButton' > child > class='GtkShortcutController' > name='scope'managed/property > child > class='GtkShortcut' > name='trigger'<Control>k/property > name='action'activate/property > /object > /child > /object > /child > /object

Exported types

newtype ShortcutController

Memory-managed wrapper type.

Constructors

ShortcutController (ManagedPtr ShortcutController)

Instances

Eq ShortcutController

Defined in GI.Gtk.Objects.ShortcutController

Methods

(==) :: ShortcutController -> ShortcutController -> Bool

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

IsGValue ShortcutController

Convert ShortcutController to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.ShortcutController

Methods

toGValue :: ShortcutController -> IO GValue

fromGValue :: GValue -> IO ShortcutController

ManagedPtrNewtype ShortcutController

Defined in GI.Gtk.Objects.ShortcutController

Methods

toManagedPtr :: ShortcutController -> ManagedPtr ShortcutController

TypedObject ShortcutController

Defined in GI.Gtk.Objects.ShortcutController

Methods

glibType :: IO GType

GObject ShortcutController

Defined in GI.Gtk.Objects.ShortcutController

HasParentTypes ShortcutController

Defined in GI.Gtk.Objects.ShortcutController

type ParentTypes ShortcutController

Defined in GI.Gtk.Objects.ShortcutController

type ParentTypes ShortcutController = '[EventController, Object, ListModel, Buildable]

class (GObject o, IsDescendantOf ShortcutController o) => IsShortcutController o

Type class for types which can be safely cast to ShortcutController, for instance with toShortcutController.

Instances

(GObject o, IsDescendantOf ShortcutController o) => IsShortcutController o

Defined in GI.Gtk.Objects.ShortcutController

toShortcutController :: (MonadIO m, IsShortcutController o) => o -> m ShortcutController

Cast to ShortcutController, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

addShortcut

shortcutControllerAddShortcut

Arguments

:: (HasCallStack, MonadIO m, IsShortcutController a, IsShortcut b)

=> a

self: the controller

-> b

shortcut: a Shortcut

-> m ()

Adds shortcut to the list of shortcuts handled by self.

If this controller uses an external shortcut list, this function does nothing.

getMnemonicsModifiers

shortcutControllerGetMnemonicsModifiers

Arguments

:: (HasCallStack, MonadIO m, IsShortcutController a)

=> a

self: a ShortcutController

-> m [ModifierType]

Returns: the controller's mnemonics modifiers

Gets the mnemonics modifiers for when this controller activates its shortcuts. See shortcutControllerSetMnemonicsModifiers for details.

getScope

shortcutControllerGetScope

Arguments

:: (HasCallStack, MonadIO m, IsShortcutController a)

=> a

self: a ShortcutController

-> m ShortcutScope

Returns: the controller's scope

Gets the scope for when this controller activates its shortcuts. See shortcutControllerSetScope for details.

new

shortcutControllerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ShortcutController

Returns: a newly created shortcut controller

Creates a new shortcut controller.

newForModel

shortcutControllerNewForModel

Arguments

:: (HasCallStack, MonadIO m, IsListModel a)

=> a

model: a ListModel containing shortcuts

-> m ShortcutController

Returns: a newly created shortcut controller

Creates a new shortcut controller that takes its shortcuts from the given list model.

A controller created by this function does not let you add or remove individual shortcuts using the shortcut controller api, but you can change the contents of the model.

removeShortcut

shortcutControllerRemoveShortcut

Arguments

:: (HasCallStack, MonadIO m, IsShortcutController a, IsShortcut b)

=> a

self: the controller

-> b

shortcut: a Shortcut

-> m ()

Removes shortcut from the list of shortcuts handled by self.

If shortcut had not been added to controller or this controller uses an external shortcut list, this function does nothing.

setMnemonicsModifiers

shortcutControllerSetMnemonicsModifiers

Arguments

:: (HasCallStack, MonadIO m, IsShortcutController a)

=> a

self: a ShortcutController

-> [ModifierType]

modifiers: the new mnemonics_modifiers to use

-> m ()

Sets the controller to have the given mnemonicsModifiers.

The mnemonics modifiers determines which modifiers need to be pressed to allow activation of shortcuts with mnemonics triggers.

GTK normally uses the Alt modifier for mnemonics, except in GtkPopoverMenus, where mnemonics can be triggered without any modifiers. It should be very rarely necessary to change this, and doing so is likely to interfere with other shortcuts.

This value is only relevant for local shortcut controllers. Global and managed shortcut controllers will have their shortcuts activated from other places which have their own modifiers for activating mnemonics.

setScope

shortcutControllerSetScope

Arguments

:: (HasCallStack, MonadIO m, IsShortcutController a)

=> a

self: a ShortcutController

-> ShortcutScope

scope: the new scope to use

-> m ()

Sets the controller to have the given scope.

The scope allows shortcuts to be activated outside of the normal event propagation. In particular, it allows installing global keyboard shortcuts that can be activated even when a widget does not have focus.

With ShortcutScopeLocal, shortcuts will only be activated when the widget has focus.

Properties

mnemonicModifiers

The modifiers that need to be pressed to allow mnemonics activation.

constructShortcutControllerMnemonicModifiers :: (IsShortcutController o, MonadIO m) => [ModifierType] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “mnemonic-modifiers” property. This is rarely needed directly, but it is used by new.

getShortcutControllerMnemonicModifiers :: (MonadIO m, IsShortcutController o) => o -> m [ModifierType]

Get the value of the “mnemonic-modifiers” property. When overloading is enabled, this is equivalent to

get shortcutController #mnemonicModifiers

setShortcutControllerMnemonicModifiers :: (MonadIO m, IsShortcutController o) => o -> [ModifierType] -> m ()

Set the value of the “mnemonic-modifiers” property. When overloading is enabled, this is equivalent to

set shortcutController [ #mnemonicModifiers := value ]

model

A list model to take shortcuts from

constructShortcutControllerModel :: (IsShortcutController o, MonadIO m, IsListModel a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “model” property. This is rarely needed directly, but it is used by new.

scope

What scope the shortcuts will be handled in.

constructShortcutControllerScope :: (IsShortcutController o, MonadIO m) => ShortcutScope -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “scope” property. This is rarely needed directly, but it is used by new.

getShortcutControllerScope :: (MonadIO m, IsShortcutController o) => o -> m ShortcutScope

Get the value of the “scope” property. When overloading is enabled, this is equivalent to

get shortcutController #scope

setShortcutControllerScope :: (MonadIO m, IsShortcutController o) => o -> ShortcutScope -> m ()

Set the value of the “scope” property. When overloading is enabled, this is equivalent to

set shortcutController [ #scope := value ]