GI.Gtk.Structs.BindingEntry

Each key binding element of a binding sets binding list is represented by a GtkBindingEntry.

Exported types

newtype BindingEntry

Constructors

BindingEntry (ManagedPtr BindingEntry)

Instances

WrappedPtr BindingEntry

Methods

wrappedPtrCalloc :: IO (Ptr BindingEntry)

wrappedPtrCopy :: BindingEntry -> IO BindingEntry

wrappedPtrFree :: Maybe (FunPtr (Ptr BindingEntry -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible BindingEntry tag

Methods

new :: MonadIO m => (ManagedPtr BindingEntry -> BindingEntry) -> [AttrOp BindingEntry tag] -> m BindingEntry

newZeroBindingEntry :: MonadIO m => m BindingEntry

Construct a BindingEntry struct initialized to zero.

noBindingEntry :: Maybe BindingEntry

Methods

addSignalFromString

bindingEntryAddSignalFromString

Arguments

:: (HasCallStack, MonadIO m)

=> BindingSet

bindingSet: a BindingSet

-> Text

signalDesc: a signal description

-> m TokenType

Returns: TokenTypeNone if the signal was successfully parsed and added, the expected token otherwise

Parses a signal description from signalDesc and incorporates it into bindingSet.

Signal descriptions may either bind a key combination to one or more signals: > > bind "key" { > "signalname" (param, ...) > ... > }

Or they may also unbind a key combination: > > unbind "key"

Key combinations must be in a format that can be parsed by acceleratorParse.

Since: 3.0

addSignall

bindingEntryAddSignall

Arguments

:: (HasCallStack, MonadIO m)

=> BindingSet

bindingSet: a BindingSet to add a signal to

-> Word32

keyval: key value

-> [ModifierType]

modifiers: key modifier

-> Text

signalName: signal name to be bound

-> [BindingArg]

bindingArgs: list of BindingArg signal arguments

-> m ()

Override or install a new key binding for keyval with modifiers on bindingSet.

remove

bindingEntryRemove

Arguments

:: (HasCallStack, MonadIO m)

=> BindingSet

bindingSet: a BindingSet to remove an entry of

-> Word32

keyval: key value of binding to remove

-> [ModifierType]

modifiers: key modifier of binding to remove

-> m ()

Remove a binding previously installed via gtk_binding_entry_add_signal() on bindingSet.

skip

bindingEntrySkip

Arguments

:: (HasCallStack, MonadIO m)

=> BindingSet

bindingSet: a BindingSet to skip an entry of

-> Word32

keyval: key value of binding to skip

-> [ModifierType]

modifiers: key modifier of binding to skip

-> m ()

Install a binding on bindingSet which causes key lookups to be aborted, to prevent bindings from lower priority sets to be activated.

Since: 2.12

Properties

bindingSet

clearBindingEntryBindingSet :: MonadIO m => BindingEntry -> m ()

getBindingEntryBindingSet :: MonadIO m => BindingEntry -> m (Maybe BindingSet)

setBindingEntryBindingSet :: MonadIO m => BindingEntry -> Ptr BindingSet -> m ()

destroyed

getBindingEntryDestroyed :: MonadIO m => BindingEntry -> m Word32

setBindingEntryDestroyed :: MonadIO m => BindingEntry -> Word32 -> m ()

hashNext

clearBindingEntryHashNext :: MonadIO m => BindingEntry -> m ()

getBindingEntryHashNext :: MonadIO m => BindingEntry -> m (Maybe BindingEntry)

setBindingEntryHashNext :: MonadIO m => BindingEntry -> Ptr BindingEntry -> m ()

inEmission

getBindingEntryInEmission :: MonadIO m => BindingEntry -> m Word32

setBindingEntryInEmission :: MonadIO m => BindingEntry -> Word32 -> m ()

keyval

getBindingEntryKeyval :: MonadIO m => BindingEntry -> m Word32

setBindingEntryKeyval :: MonadIO m => BindingEntry -> Word32 -> m ()

marksUnbound

getBindingEntryMarksUnbound :: MonadIO m => BindingEntry -> m Word32

setBindingEntryMarksUnbound :: MonadIO m => BindingEntry -> Word32 -> m ()

modifiers

getBindingEntryModifiers :: MonadIO m => BindingEntry -> m [ModifierType]

setBindingEntryModifiers :: MonadIO m => BindingEntry -> [ModifierType] -> m ()

setNext

clearBindingEntrySetNext :: MonadIO m => BindingEntry -> m ()

getBindingEntrySetNext :: MonadIO m => BindingEntry -> m (Maybe BindingEntry)

setBindingEntrySetNext :: MonadIO m => BindingEntry -> Ptr BindingEntry -> m ()

signals

clearBindingEntrySignals :: MonadIO m => BindingEntry -> m ()

getBindingEntrySignals :: MonadIO m => BindingEntry -> m (Maybe BindingSignal)

setBindingEntrySignals :: MonadIO m => BindingEntry -> Ptr BindingSignal -> m ()