GI.Gtk.Structs.BindingSet

A binding set maintains a list of activatable key bindings. A single binding set can match multiple types of widgets. Similar to style contexts, can be matched by any information contained in a widgets WidgetPath. When a binding within a set is matched upon activation, an action signal is emitted on the target widget to carry out the actual activation.

Exported types

newtype BindingSet

Constructors

BindingSet (ManagedPtr BindingSet)

Instances

WrappedPtr BindingSet

Methods

wrappedPtrCalloc :: IO (Ptr BindingSet)

wrappedPtrCopy :: BindingSet -> IO BindingSet

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

(~) AttrOpTag tag AttrSet => Constructible BindingSet tag

Methods

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

newZeroBindingSet :: MonadIO m => m BindingSet

Construct a BindingSet struct initialized to zero.

noBindingSet :: Maybe BindingSet

Methods

activate

bindingSetActivate

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> BindingSet

bindingSet: a BindingSet set to activate

-> Word32

keyval: key value of the binding

-> [ModifierType]

modifiers: key modifier of the binding

-> a

object: object to activate when binding found

-> m Bool

Returns: True if a binding was found and activated

Find a key binding matching keyval and modifiers within bindingSet and activate the binding on object.

addPath

bindingSetAddPath

Arguments

:: (HasCallStack, MonadIO m)

=> BindingSet

bindingSet: a BindingSet to add a path to

-> PathType

pathType: path type the pattern applies to

-> Text

pathPattern: the actual match pattern

-> PathPriorityType

priority: binding priority

-> m ()

Deprecated: (Since version 3.0)

This function was used internally by the GtkRC parsing mechanism to assign match patterns to BindingSet structures.

In GTK+ 3, these match patterns are unused.

find

bindingSetFind

Arguments

:: (HasCallStack, MonadIO m)

=> Text

setName: unique binding set name

-> m (Maybe BindingSet)

Returns: Nothing or the specified binding set

Find a binding set by its globally unique name.

The setName can either be a name used for gtk_binding_set_new() or the type name of a class used in gtk_binding_set_by_class().

Properties

classBranchPspecs

clearBindingSetClassBranchPspecs :: MonadIO m => BindingSet -> m ()

getBindingSetClassBranchPspecs :: MonadIO m => BindingSet -> m [Ptr ()]

setBindingSetClassBranchPspecs :: MonadIO m => BindingSet -> Ptr (GSList (Ptr ())) -> m ()

current

clearBindingSetCurrent :: MonadIO m => BindingSet -> m ()

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

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

entries

clearBindingSetEntries :: MonadIO m => BindingSet -> m ()

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

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

parsed

getBindingSetParsed :: MonadIO m => BindingSet -> m Word32

setBindingSetParsed :: MonadIO m => BindingSet -> Word32 -> m ()

priority

getBindingSetPriority :: MonadIO m => BindingSet -> m Int32

setBindingSetPriority :: MonadIO m => BindingSet -> Int32 -> m ()

setName

clearBindingSetSetName :: MonadIO m => BindingSet -> m ()

getBindingSetSetName :: MonadIO m => BindingSet -> m (Maybe Text)

setBindingSetSetName :: MonadIO m => BindingSet -> CString -> m ()

widgetClassPspecs

clearBindingSetWidgetClassPspecs :: MonadIO m => BindingSet -> m ()

getBindingSetWidgetClassPspecs :: MonadIO m => BindingSet -> m [Ptr ()]

setBindingSetWidgetClassPspecs :: MonadIO m => BindingSet -> Ptr (GSList (Ptr ())) -> m ()

widgetPathPspecs

clearBindingSetWidgetPathPspecs :: MonadIO m => BindingSet -> m ()

getBindingSetWidgetPathPspecs :: MonadIO m => BindingSet -> m [Ptr ()]

setBindingSetWidgetPathPspecs :: MonadIO m => BindingSet -> Ptr (GSList (Ptr ())) -> m ()