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

Memory-managed wrapper type.

Constructors

BindingSet (ManagedPtr BindingSet)

Instances

Eq BindingSet

Defined in GI.Gtk.Structs.BindingSet

Methods

(==) :: BindingSet -> BindingSet -> Bool

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

WrappedPtr BindingSet

Defined in GI.Gtk.Structs.BindingSet

Methods

wrappedPtrCalloc :: IO (Ptr BindingSet)

wrappedPtrCopy :: BindingSet -> IO BindingSet

wrappedPtrFree :: Maybe (GDestroyNotify BindingSet)

tag ~ 'AttrSet => Constructible BindingSet tag

Defined in GI.Gtk.Structs.BindingSet

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

A convenience alias for Nothing :: Maybe BindingSet.

Methods

Overloaded 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

unused

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

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 ()]

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 ()

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 ()

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)

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 ()

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 ()

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)

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 ()

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

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

get bindingSet #parsed

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

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

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

get bindingSet #priority

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

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 ()

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)

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 ()

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 ()

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 ()]

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 ()

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 ()

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 ()]

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 ()

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

set bindingSet [ #widgetPathPspecs := value ]