Struct BindingPool

pub struct BindingPool(/* private fields */);

Implementations

impl BindingPool

pub fn new(name: &str) -> BindingPool

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 BindingPool::find will be able to return the correct binding pool.

name

the name of the binding pool

Returns

the newly created binding pool with the given name. Use gobject::ObjectExt::unref when done.

pub fn activate<P: IsA<Object>>( &self, key_val: u32, modifiers: ModifierType, gobject: &P, ) -> bool

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::Object instance is gobject and the user data is the one passed when installing the action with BindingPool::install_action.

If the action bound to the key_val, modifiers pair has been blocked using BindingPool::block_action, the callback will not be invoked, and this function will return false.

key_val

the key symbol

modifiers

bitmask for the modifiers

gobject

a gobject::Object

Returns

true if an action was found and was activated

pub fn block_action(&self, action_name: &str)

Blocks all the actions with name action_name inside self.

action_name

an action name

pub fn find_action( &self, key_val: u32, modifiers: ModifierType, ) -> Option<GString>

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

key_val

a key symbol

modifiers

a bitmask for the modifiers

Returns

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

pub fn install_closure( &self, action_name: &str, key_val: u32, modifiers: ModifierType, closure: &Closure, )

A gobject::Closure variant of BindingPool::install_action.

Installs a new action inside a BindingPool. 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 BindingPool::activate the passed closure will be invoked.

Actions can be blocked with BindingPool::block_action and then unblocked using BindingPool::unblock_action.

action_name

the name of the action

key_val

key symbol

modifiers

bitmask of modifiers

closure

a gobject::Closure

pub fn override_closure( &self, key_val: u32, modifiers: ModifierType, closure: &Closure, )

A gobject::Closure variant of BindingPool::override_action.

Allows overriding the action for key_val and modifiers inside a BindingPool. See BindingPool::install_closure.

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

Actions can be blocked with BindingPool::block_action and then unblocked using BindingPool::unblock_action.

key_val

key symbol

modifiers

bitmask of modifiers

closure

a gobject::Closure

pub fn remove_action(&self, key_val: u32, modifiers: ModifierType)

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

key_val

a key symbol

modifiers

a bitmask for the modifiers

pub fn unblock_action(&self, action_name: &str)

Unblockes all the actions with name action_name inside self.

Unblocking an action does not cause the callback bound to it to be invoked in case BindingPool::activate was called on an action previously blocked with BindingPool::block_action.

action_name

an action name

pub fn get_property_name(&self) -> Option<GString>

The unique name of the BindingPool.

pub fn find(name: &str) -> Option<BindingPool>

Finds the BindingPool with name.

name

the name of the binding pool to find

Returns

a pointer to the BindingPool, or None

Trait Implementations

impl Clone for BindingPool

fn clone(&self) -> BindingPool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BindingPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BindingPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for BindingPool

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BindingPool

fn cmp(&self, other: &BindingPool) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for BindingPool

fn eq(&self, other: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ObjectType> PartialOrd<T> for BindingPool

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for BindingPool

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for BindingPool