Back to Seed Clases

Clutter

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker Clutter.BindingPool

Class Clutter.BindingPool

Import line:	Clutter = imports.gi.Clutter;
GIR File:	Clutter-1.0.gir
C documentation:	ClutterBindingPool
Class :	BindingPool
Extends:	GObject.Object

Container of key bindings. The ClutterBindingPool struct is
private.

Properties
Properties		Defined By
	name : String The unique name of the ClutterBindingPool. The unique name of the ClutterBindingPool.	Clutter.BindingPool

Methods / Constructors
Method / Constructor		Defined By
	new Clutter.BindingPool (Object *properties) Create a new Clutter.BindingPool Create a new Clutter.BindingPool Parameters: Object properties*
	new Clutter.BindingPool.c_new (String *name) : Clutter.BindingPool Create a new Clutter.BindingPool Create a new Clutter.BindingPool Parameters: String name* Required (not null) the name of the binding pool Returns: Clutter.BindingPool the newly created binding pool with the given
	Clutter.BindingPool.find (String *name) : Clutter.BindingPool Finds the ClutterBindingPool* with name. Finds the ClutterBindingPool with name. Parameters: String name Required (not null) the name of the binding pool to find Returns: Clutter.BindingPool a pointer to the ClutterBindingPool, or NULL	Clutter.BindingPool
	Clutter.BindingPool.get_for_class (void* *klass) : Clutter.BindingPool Retrieves the ClutterBindingPool* for the given GObject class and, eventually, creates it. Retrieves the ClutterBindingPool for the given GObject class and, eventually, creates it. This function is a wrapper around clutter_binding_pool_new() and uses the class type name as the unique name for the binding pool. Calling this function multiple times will return the same ClutterBindingPool. A binding pool for a class can also be retrieved using clutter_binding_pool_find() with the class type name: \|[ pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance)); ]\| The returned ClutterBindingPool is owned by Clutter and should not be freed directly Parameters: void* klass Required (not null) a GObjectClass pointer Returns: Clutter.BindingPool the binding pool for the given class.	Clutter.BindingPool
	activate (guint32 *key_val, ModifierType modifiers, Object gobject) : gboolean Activates the callback associated to the action that is bound to the key_val* and modifiers pair. Activates the callback associated to the action that is bound to the key_val 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 GObject instance is gobject and the user data is the one passed when installing the action with clutter_binding_pool_install_action(). If the action bound to the key_val, modifiers pair has been blocked using clutter_binding_pool_block_action(), the callback will not be invoked, and this function will return FALSE. Parameters: guint32 key_val Required (not null) the key symbol Clutter.ModifierType modifiers Required (not null) bitmask for the modifiers GObject.Object gobject Required (not null) a GObject Returns: gboolean TRUE if an action was found and was activated	Clutter.BindingPool
	block_action (String *action_name) : none Blocks all the actions with name action_name* inside pool. Blocks all the actions with name action_name inside pool. Parameters: String action_name Required (not null) an action name Returns: none	Clutter.BindingPool
	find_action (guint32 *key_val, ModifierType modifiers) : String Retrieves the name of the action matching the given key symbol and modifiers bitmask. Retrieves the name of the action matching the given key symbol and modifiers bitmask. returned string is owned by the binding pool and should never be modified or freed Parameters: guint32 key_val* Required (not null) a key symbol Clutter.ModifierType modifiers Required (not null) a bitmask for the modifiers Returns: String the name of the action, if found, or NULL. The	Clutter.BindingPool
	install_action (String *action_name, guint32 key_val, ModifierType modifiers, Function callback, void *data, Function notify) : none Installs a new action inside a ClutterBindingPool. Installs a new action inside a ClutterBindingPool. The action is bound to key_val* and modifiers. The same action name can be used for multiple key_val, modifiers pairs. When an action has been activated using clutter_binding_pool_activate() the passed callback will be invoked (with data). Actions can be blocked with clutter_binding_pool_block_action() and then unblocked using clutter_binding_pool_unblock_action(). Parameters: String action_name Required (not null) the name of the action guint32 key_val Required (not null) key symbol Clutter.ModifierType modifiers Required (not null) bitmask of modifiers Function () : none Required (not null) function to be called when the action is activated void* data Required (not null) data to be passed to callback Function (void* *data*) : none Required (not null) function to be called when the action is removed from the pool Returns: none	Clutter.BindingPool
	install_closure (String *action_name, guint32 key_val, ModifierType modifiers, Closure closure) : none A GClosure* variant of clutter_binding_pool_install_action(). A GClosure variant of clutter_binding_pool_install_action(). Installs a new action inside a ClutterBindingPool. The action is bound to key_val and modifiers. The same action name can be used for multiple key_val, modifiers pairs. When an action has been activated using clutter_binding_pool_activate() the passed closure will be invoked. Actions can be blocked with clutter_binding_pool_block_action() and then unblocked using clutter_binding_pool_unblock_action(). Parameters: String action_name Required (not null) the name of the action guint32 key_val Required (not null) key symbol Clutter.ModifierType modifiers Required (not null) bitmask of modifiers GObject.Closure closure Required (not null) a GClosure Returns: none	Clutter.BindingPool
	override_action (guint32 *key_val, ModifierType modifiers, Function callback, void *data, Function notify) : none Allows overriding the action for key_val* and modifiers inside a ClutterBindingPool. Allows overriding the action for key_val and modifiers inside a ClutterBindingPool. See clutter_binding_pool_install_action(). When an action has been activated using clutter_binding_pool_activate() the passed callback will be invoked (with data). Actions can be blocked with clutter_binding_pool_block_action() and then unblocked using clutter_binding_pool_unblock_action(). Parameters: guint32 key_val Required (not null) key symbol Clutter.ModifierType modifiers Required (not null) bitmask of modifiers Function () : none Required (not null) function to be called when the action is activated void* data Required (not null) data to be passed to callback Function (void* *data*) : none Required (not null) function to be called when the action is removed from the pool Returns: none	Clutter.BindingPool
	override_closure (guint32 *key_val, ModifierType modifiers, Closure closure) : none A GClosure* variant of clutter_binding_pool_override_action(). A GClosure variant of clutter_binding_pool_override_action(). Allows overriding the action for key_val and modifiers inside a ClutterBindingPool. See clutter_binding_pool_install_closure(). When an action has been activated using clutter_binding_pool_activate() the passed callback will be invoked (with data). Actions can be blocked with clutter_binding_pool_block_action() and then unblocked using clutter_binding_pool_unblock_action(). Parameters: guint32 key_val Required (not null) key symbol Clutter.ModifierType modifiers Required (not null) bitmask of modifiers GObject.Closure closure Required (not null) a GClosure Returns: none	Clutter.BindingPool
	remove_action (guint32 *key_val, ModifierType modifiers) : none Removes the action matching the given key_val, modifiers* pair, if any exists. Removes the action matching the given key_val, modifiers pair, if any exists. Parameters: guint32 key_val Required (not null) a key symbol Clutter.ModifierType modifiers Required (not null) a bitmask for the modifiers Returns: none	Clutter.BindingPool
	unblock_action (String *action_name) : none Unblockes all the actions with name action_name* inside pool. Unblockes all the actions with name action_name inside pool. Unblocking an action does not cause the callback bound to it to be invoked in case clutter_binding_pool_activate() was called on an action previously blocked with clutter_binding_pool_block_action(). Parameters: String action_name Required (not null) an action name Returns: none	Clutter.BindingPool

Events
None

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:09:28 GMT+0800 (HKT)