GI.Clutter.Objects.BindingPool

Container of key bindings. The BindingPool struct is private.

Since: 1.0

Exported types

newtype BindingPool

Memory-managed wrapper type.

Constructors

BindingPool (ManagedPtr BindingPool)

Instances

Eq BindingPool

Defined in GI.Clutter.Objects.BindingPool

Methods

(==) :: BindingPool -> BindingPool -> Bool

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

GObject BindingPool

Defined in GI.Clutter.Objects.BindingPool

ManagedPtrNewtype BindingPool

Defined in GI.Clutter.Objects.BindingPool

Methods

toManagedPtr :: BindingPool -> ManagedPtr BindingPool

TypedObject BindingPool

Defined in GI.Clutter.Objects.BindingPool

Methods

glibType :: IO GType

HasParentTypes BindingPool

Defined in GI.Clutter.Objects.BindingPool

IsGValue (Maybe BindingPool)

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

Defined in GI.Clutter.Objects.BindingPool

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BindingPool

Defined in GI.Clutter.Objects.BindingPool

type ParentTypes BindingPool = '[Object]

class (GObject o, IsDescendantOf BindingPool o) => IsBindingPool o

Type class for types which can be safely cast to BindingPool, for instance with toBindingPool.

Instances

(GObject o, IsDescendantOf BindingPool o) => IsBindingPool o

Defined in GI.Clutter.Objects.BindingPool

toBindingPool :: (MonadIO m, IsBindingPool o) => o -> m BindingPool

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

Methods

Click to display all available methods, including inherited ones

Methods

activate, bindProperty, bindPropertyFull, blockAction, findAction, forceFloating, freezeNotify, getv, installAction, installClosure, isFloating, notify, notifyByPspec, overrideAction, overrideClosure, ref, refSink, removeAction, runDispose, stealData, stealQdata, thawNotify, unblockAction, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

activate

bindingPoolActivate

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a, IsObject b)

=> a

pool: a BindingPool

-> Word32

keyVal: the key symbol

-> [ModifierType]

modifiers: bitmask for the modifiers

-> b

gobject: a Object

-> m Bool

Returns: True if an action was found and was activated

Activates the callback associated to the action that is bound to the keyVal and modifiers pair.

The callback has the following signature:

 void (* callback) (GObject             *gobject,
                    const gchar         *action_name,
                    guint                key_val,
                    ClutterModifierType  modifiers,
                    gpointer             user_data);

Where the Object instance is gobject and the user data is the one passed when installing the action with bindingPoolInstallAction.

If the action bound to the keyVal, modifiers pair has been blocked using bindingPoolBlockAction, the callback will not be invoked, and this function will return False.

Since: 1.0

blockAction

bindingPoolBlockAction

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Text

actionName: an action name

-> m ()

Blocks all the actions with name actionName inside pool.

Since: 1.0

find

bindingPoolFind

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the binding pool to find

-> m BindingPool

Returns: a pointer to the BindingPool, or Nothing

Finds the BindingPool with name.

Since: 1.0

findAction

bindingPoolFindAction

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Word32

keyVal: a key symbol

-> [ModifierType]

modifiers: a bitmask for the modifiers

-> m Text

Returns: the name of the action, if found, or Nothing. The returned string is owned by the binding pool and should never be modified or freed

Retrieves the name of the action matching the given key symbol and modifiers bitmask.

Since: 1.0

getForClass

bindingPoolGetForClass

Arguments

:: (HasCallStack, MonadIO m)

=> Ptr ()

klass: a ObjectClass pointer

-> m BindingPool

Returns: the binding pool for the given class. The returned BindingPool is owned by Clutter and should not be freed directly

Retrieves the BindingPool for the given Object class and, eventually, creates it. This function is a wrapper around bindingPoolNew and uses the class type name as the unique name for the binding pool.

Calling this function multiple times will return the same BindingPool.

A binding pool for a class can also be retrieved using bindingPoolFind with the class type name:

 pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance));

Since: 1.0

installAction

bindingPoolInstallAction

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Text

actionName: the name of the action

-> Word32

keyVal: key symbol

-> [ModifierType]

modifiers: bitmask of modifiers

-> BindingActionFunc

callback: function to be called when the action is activated

-> m ()

Installs a new action inside a BindingPool. The action is bound to keyVal and modifiers.

The same action name can be used for multiple keyVal, modifiers pairs.

When an action has been activated using bindingPoolActivate the passed callback will be invoked (with data).

Actions can be blocked with bindingPoolBlockAction and then unblocked using bindingPoolUnblockAction.

Since: 1.0

installClosure

bindingPoolInstallClosure

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Text

actionName: the name of the action

-> Word32

keyVal: key symbol

-> [ModifierType]

modifiers: bitmask of modifiers

-> GClosure b

closure: a Closure

-> m ()

A Closure variant of bindingPoolInstallAction.

Installs a new action inside a BindingPool. The action is bound to keyVal and modifiers.

The same action name can be used for multiple keyVal, modifiers pairs.

When an action has been activated using bindingPoolActivate the passed closure will be invoked.

Actions can be blocked with bindingPoolBlockAction and then unblocked using bindingPoolUnblockAction.

Since: 1.0

new

bindingPoolNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the binding pool

-> m BindingPool

Returns: the newly created binding pool with the given name. Use objectUnref when done.

Creates a new BindingPool that can be used to store key bindings for an actor. The name must be a unique identifier for the binding pool, so that bindingPoolFind will be able to return the correct binding pool.

Since: 1.0

overrideAction

bindingPoolOverrideAction

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Word32

keyVal: key symbol

-> [ModifierType]

modifiers: bitmask of modifiers

-> BindingActionFunc

callback: function to be called when the action is activated

-> m ()

Allows overriding the action for keyVal and modifiers inside a BindingPool. See bindingPoolInstallAction.

When an action has been activated using bindingPoolActivate the passed callback will be invoked (with data).

Actions can be blocked with bindingPoolBlockAction and then unblocked using bindingPoolUnblockAction.

Since: 1.0

overrideClosure

bindingPoolOverrideClosure

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Word32

keyVal: key symbol

-> [ModifierType]

modifiers: bitmask of modifiers

-> GClosure b

closure: a Closure

-> m ()

A Closure variant of bindingPoolOverrideAction.

Allows overriding the action for keyVal and modifiers inside a BindingPool. See bindingPoolInstallClosure.

When an action has been activated using bindingPoolActivate the passed callback will be invoked (with data).

Actions can be blocked with bindingPoolBlockAction and then unblocked using bindingPoolUnblockAction.

Since: 1.0

removeAction

bindingPoolRemoveAction

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Word32

keyVal: a key symbol

-> [ModifierType]

modifiers: a bitmask for the modifiers

-> m ()

Removes the action matching the given keyVal, modifiers pair, if any exists.

Since: 1.0

unblockAction

bindingPoolUnblockAction

Arguments

:: (HasCallStack, MonadIO m, IsBindingPool a)

=> a

pool: a BindingPool

-> Text

actionName: an action name

-> m ()

Unblockes all the actions with name actionName inside pool.

Unblocking an action does not cause the callback bound to it to be invoked in case bindingPoolActivate was called on an action previously blocked with bindingPoolBlockAction.

Since: 1.0

Properties

name

The unique name of the BindingPool.

Since: 1.0

constructBindingPoolName :: (IsBindingPool o, MonadIO m) => Text -> m (GValueConstruct o)

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

getBindingPoolName :: (MonadIO m, IsBindingPool o) => o -> m (Maybe Text)

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

get bindingPool #name