Struct animate::BindingPool [−][src]
pub struct BindingPool(_, _);
Implementations
impl BindingPool
[src]
pub fn new(name: &str) -> BindingPool
[src]
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
[src]
&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,
ModifierType 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)
[src]
pub fn find_action(
&self,
key_val: u32,
modifiers: ModifierType
) -> Option<GString>
[src]
&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
)
[src]
&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
)
[src]
&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)
[src]
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)
[src]
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>
[src]
The unique name of the BindingPool
.
pub fn find(name: &str) -> Option<BindingPool>
[src]
Trait Implementations
impl Clone for BindingPool
[src]
fn clone(&self) -> BindingPool
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for BindingPool
[src]
impl Display for BindingPool
[src]
impl Eq for BindingPool
[src]
impl Hash for BindingPool
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for BindingPool
[src]
fn cmp(&self, other: &BindingPool) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<T: ObjectType> PartialEq<T> for BindingPool
[src]
impl<T: ObjectType> PartialOrd<T> for BindingPool
[src]
fn partial_cmp(&self, other: &T) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StaticType for BindingPool
[src]
fn static_type() -> Type
[src]
Auto Trait Implementations
impl RefUnwindSafe for BindingPool
impl !Send for BindingPool
impl !Sync for BindingPool
impl Unpin for BindingPool
impl UnwindSafe for BindingPool
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<Super, Sub> CanDowncast<Sub> for Super where
Sub: IsA<Super>,
Super: IsA<Super>,
[src]
Sub: IsA<Super>,
Super: IsA<Super>,
impl<T> Cast for T where
T: ObjectType,
[src]
T: ObjectType,
pub fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType,
[src]
Self: IsA<T>,
T: ObjectType,
pub fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType,
[src]
Self: IsA<T>,
T: ObjectType,
pub fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType,
[src]
Self: CanDowncast<T>,
T: ObjectType,
pub fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType,
[src]
Self: CanDowncast<T>,
T: ObjectType,
pub fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,
[src]
T: ObjectType,
pub fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
[src]
T: ObjectType,
pub unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,
[src]
T: ObjectType,
pub unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,
[src]
T: ObjectType,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ObjectExt for T where
T: ObjectType,
[src]
T: ObjectType,
pub fn is<U>(&self) -> bool where
U: StaticType,
[src]
U: StaticType,
pub fn get_type(&self) -> Type
[src]
pub fn get_object_class(&self) -> &ObjectClass
[src]
pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
[src]
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
pub fn set_property<'a, N>(
&self,
property_name: N,
value: &dyn ToValue
) -> Result<(), BoolError> where
N: Into<&'a str>,
[src]
&self,
property_name: N,
value: &dyn ToValue
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>,
[src]
N: Into<&'a str>,
pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,
[src]
QD: 'static,
pub unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where
QD: 'static,
[src]
QD: 'static,
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,
[src]
QD: 'static,
pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,
[src]
QD: 'static,
pub unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where
QD: 'static,
[src]
QD: 'static,
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,
[src]
QD: 'static,
pub fn block_signal(&self, handler_id: &SignalHandlerId)
[src]
pub fn unblock_signal(&self, handler_id: &SignalHandlerId)
[src]
pub fn stop_signal_emission(&self, signal_name: &str)
[src]
pub fn disconnect(&self, handler_id: SignalHandlerId)
[src]
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
[src]
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
[src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>,
[src]
N: Into<&'a str>,
pub fn notify_by_pspec(&self, pspec: &ParamSpec)
[src]
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
[src]
N: Into<&'a str>,
pub fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>,
[src]
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
[src]
N: Into<&'a str>,
pub fn list_properties(&self) -> Vec<ParamSpec, Global>
[src]
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
[src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
[src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
[src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
pub fn emit<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
[src]
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
pub fn downgrade(&self) -> WeakRef<T>
[src]
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
[src]
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
pub fn ref_count(&self) -> u32
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToSendValue for T where
T: SetValue + Send + ToValue + ?Sized,
[src]
T: SetValue + Send + ToValue + ?Sized,
pub fn to_send_value(&self) -> SendValue
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T> ToValue for T where
T: SetValue + ?Sized,
[src]
T: SetValue + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,