Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gtk.Structs.BindingSet

Contents

Exported types
Methods
Properties

Description

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.

Synopsis

newtype BindingSet = BindingSet (ManagedPtr BindingSet)
newZeroBindingSet :: MonadIO m => m BindingSet
bindingSetActivate :: (HasCallStack, MonadIO m, IsObject a) => BindingSet -> Word32 -> [ModifierType] -> a -> m Bool
bindingSetAddPath :: (HasCallStack, MonadIO m) => BindingSet -> PathType -> Text -> PathPriorityType -> m ()
bindingSetFind :: (HasCallStack, MonadIO m) => Text -> m (Maybe BindingSet)
clearBindingSetClassBranchPspecs :: MonadIO m => BindingSet -> m ()
getBindingSetClassBranchPspecs :: MonadIO m => BindingSet -> m [Ptr ()]
setBindingSetClassBranchPspecs :: MonadIO m => BindingSet -> Ptr (GSList (Ptr ())) -> m ()
clearBindingSetCurrent :: MonadIO m => BindingSet -> m ()
getBindingSetCurrent :: MonadIO m => BindingSet -> m (Maybe BindingEntry)
setBindingSetCurrent :: MonadIO m => BindingSet -> Ptr BindingEntry -> m ()
clearBindingSetEntries :: MonadIO m => BindingSet -> m ()
getBindingSetEntries :: MonadIO m => BindingSet -> m (Maybe BindingEntry)
setBindingSetEntries :: MonadIO m => BindingSet -> Ptr BindingEntry -> m ()
getBindingSetParsed :: MonadIO m => BindingSet -> m Word32
setBindingSetParsed :: MonadIO m => BindingSet -> Word32 -> m ()
getBindingSetPriority :: MonadIO m => BindingSet -> m Int32
setBindingSetPriority :: MonadIO m => BindingSet -> Int32 -> m ()
clearBindingSetSetName :: MonadIO m => BindingSet -> m ()
getBindingSetSetName :: MonadIO m => BindingSet -> m (Maybe Text)
setBindingSetSetName :: MonadIO m => BindingSet -> CString -> m ()
clearBindingSetWidgetClassPspecs :: MonadIO m => BindingSet -> m ()
getBindingSetWidgetClassPspecs :: MonadIO m => BindingSet -> m [Ptr ()]
setBindingSetWidgetClassPspecs :: MonadIO m => BindingSet -> Ptr (GSList (Ptr ())) -> m ()
clearBindingSetWidgetPathPspecs :: MonadIO m => BindingSet -> m ()
getBindingSetWidgetPathPspecs :: MonadIO m => BindingSet -> m [Ptr ()]
setBindingSetWidgetPathPspecs :: MonadIO m => BindingSet -> Ptr (GSList (Ptr ())) -> m ()

Exported types

newtype BindingSet Source #

Memory-managed wrapper type.

Constructors

BindingSet (ManagedPtr BindingSet)

Instances

Instances details

Eq BindingSet Source #
Instance details Defined in GI.Gtk.Structs.BindingSet Methods (==) :: BindingSet -> BindingSet -> Bool # (/=) :: BindingSet -> BindingSet -> Bool #
BoxedPtr BindingSet Source #
Instance details Defined in GI.Gtk.Structs.BindingSet Methods boxedPtrCopy :: BindingSet -> IO BindingSet boxedPtrFree :: BindingSet -> IO ()
CallocPtr BindingSet Source #
Instance details Defined in GI.Gtk.Structs.BindingSet Methods boxedPtrCalloc :: IO (Ptr BindingSet)
ManagedPtrNewtype BindingSet Source #
Instance details Defined in GI.Gtk.Structs.BindingSet Methods toManagedPtr :: BindingSet -> ManagedPtr BindingSet
tag ~ 'AttrSet => Constructible BindingSet tag Source #
Instance details Defined in GI.Gtk.Structs.BindingSet Methods new :: MonadIO m => (ManagedPtr BindingSet -> BindingSet) -> [AttrOp BindingSet tag] -> m BindingSet

newZeroBindingSet :: MonadIO m => m BindingSet Source #

Construct a BindingSet struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

activate, addPath.

Getters

None.

Setters

None.

activate

bindingSetActivate Source #

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

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

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

unused

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

Set the value of the “class_branch_pspecs” field to Nothing. When overloading is enabled, this is equivalent to

clear #classBranchPspecs

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

Get the value of the “class_branch_pspecs” field. When overloading is enabled, this is equivalent to

get bindingSet #classBranchPspecs

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

Set the value of the “class_branch_pspecs” field. When overloading is enabled, this is equivalent to

set bindingSet [ #classBranchPspecs := value ]

current

implementation detail

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

Set the value of the “current” field to Nothing. When overloading is enabled, this is equivalent to

clear #current

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

Get the value of the “current” field. When overloading is enabled, this is equivalent to

get bindingSet #current

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

Set the value of the “current” field. When overloading is enabled, this is equivalent to

set bindingSet [ #current := value ]

entries

the key binding entries in this binding set

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

Set the value of the “entries” field to Nothing. When overloading is enabled, this is equivalent to

clear #entries

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

Get the value of the “entries” field. When overloading is enabled, this is equivalent to

get bindingSet #entries

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

Set the value of the “entries” field. When overloading is enabled, this is equivalent to

set bindingSet [ #entries := value ]

parsed

whether this binding set stems from a CSS file and is reset upon theme changes

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

Get the value of the “parsed” field. When overloading is enabled, this is equivalent to

get bindingSet #parsed

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

Set the value of the “parsed” field. When overloading is enabled, this is equivalent to

set bindingSet [ #parsed := value ]

priority

unused

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

Get the value of the “priority” field. When overloading is enabled, this is equivalent to

get bindingSet #priority

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

Set the value of the “priority” field. When overloading is enabled, this is equivalent to

set bindingSet [ #priority := value ]

setName

unique name of this binding set

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

Set the value of the “set_name” field to Nothing. When overloading is enabled, this is equivalent to

clear #setName

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

Get the value of the “set_name” field. When overloading is enabled, this is equivalent to

get bindingSet #setName

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

Set the value of the “set_name” field. When overloading is enabled, this is equivalent to

set bindingSet [ #setName := value ]

widgetClassPspecs

unused

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

Set the value of the “widget_class_pspecs” field to Nothing. When overloading is enabled, this is equivalent to

clear #widgetClassPspecs

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

Get the value of the “widget_class_pspecs” field. When overloading is enabled, this is equivalent to

get bindingSet #widgetClassPspecs

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

Set the value of the “widget_class_pspecs” field. When overloading is enabled, this is equivalent to

set bindingSet [ #widgetClassPspecs := value ]

widgetPathPspecs

unused

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

Set the value of the “widget_path_pspecs” field to Nothing. When overloading is enabled, this is equivalent to

clear #widgetPathPspecs

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

Get the value of the “widget_path_pspecs” field. When overloading is enabled, this is equivalent to

get bindingSet #widgetPathPspecs

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

Set the value of the “widget_path_pspecs” field. When overloading is enabled, this is equivalent to

set bindingSet [ #widgetPathPspecs := value ]