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

GI.Gtk.Objects.KeyvalTrigger

Description

A ShortcutTrigger that triggers when a specific keyval and (optionally) modifiers are pressed.

Synopsis

Exported types

newtype KeyvalTrigger Source #

Memory-managed wrapper type.

Constructors

KeyvalTrigger (ManagedPtr KeyvalTrigger) 

Instances

Instances details
Eq KeyvalTrigger Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

GObject KeyvalTrigger Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

ManagedPtrNewtype KeyvalTrigger Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

Methods

toManagedPtr :: KeyvalTrigger -> ManagedPtr KeyvalTrigger

TypedObject KeyvalTrigger Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

Methods

glibType :: IO GType

HasParentTypes KeyvalTrigger Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

IsGValue (Maybe KeyvalTrigger) Source #

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

Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes KeyvalTrigger Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

type ParentTypes KeyvalTrigger = '[ShortcutTrigger, Object]

class (GObject o, IsDescendantOf KeyvalTrigger o) => IsKeyvalTrigger o Source #

Type class for types which can be safely cast to KeyvalTrigger, for instance with toKeyvalTrigger.

Instances

Instances details
(GObject o, IsDescendantOf KeyvalTrigger o) => IsKeyvalTrigger o Source # 
Instance details

Defined in GI.Gtk.Objects.KeyvalTrigger

toKeyvalTrigger :: (MonadIO m, IsKeyvalTrigger o) => o -> m KeyvalTrigger Source #

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

Methods

getKeyval

keyvalTriggerGetKeyval Source #

Arguments

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

self: a keyval ShortcutTrigger

-> m Word32

Returns: the keyval

Gets the keyval that must be pressed to succeed triggering self.

getModifiers

keyvalTriggerGetModifiers Source #

Arguments

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

self: a keyval ShortcutTrigger

-> m [ModifierType]

Returns: the modifiers

Gets the modifiers that must be present to succeed triggering self.

new

keyvalTriggerNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Word32

keyval: The keyval to trigger for

-> [ModifierType]

modifiers: the modifiers that need to be present

-> m KeyvalTrigger

Returns: A new ShortcutTrigger

Creates a ShortcutTrigger that will trigger whenever the key with the given keyval and modifiers is pressed.

Properties

keyval

The key value for the trigger.

constructKeyvalTriggerKeyval :: (IsKeyvalTrigger o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getKeyvalTriggerKeyval :: (MonadIO m, IsKeyvalTrigger o) => o -> m Word32 Source #

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

get keyvalTrigger #keyval

modifiers

The key modifiers for the trigger.

constructKeyvalTriggerModifiers :: (IsKeyvalTrigger o, MonadIO m) => [ModifierType] -> m (GValueConstruct o) Source #

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

getKeyvalTriggerModifiers :: (MonadIO m, IsKeyvalTrigger o) => o -> m [ModifierType] Source #

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

get keyvalTrigger #modifiers