Struct KeyManipulator

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

KeyManipulator class is a key input manipulator that detects key gestures. Kanzi recognizes a key gesture when it receives an event with a key code and an optional key modifier. When Kanzi recognizes a key gesture, an input manipulator:

• Grabs the gesture.
• Enters the StateBegin state.
• Dispatches to an attached node the KeyPressedMessage with the logical key value and the pressed key modifiers.

The input manipulator that grabs a key gesture continues to stay in the StateBegin state until it receives a key up event with a logical key value, or a key modifier that forms a key gesture.

The key input manipulators are exclusive input manipulators. To handle different key gestures, you can add multiple key manipulators.

To handle the press and release of the A key:

To handle the Left Control modifier key as a key gesture:

To handle a key gesture composed of the Shift + A keys:

To handle the Left Alt + Left Control modifier keys, set the Left Alt as modifier key: The key press order matters. Pressing Left Control first and then Left Alt does not result in the same key gesture as pressing first Left Alt, then Left Control. To handle the Left Control + Left Alt key gesture:

Since

Kanzi 3.8.0

Implementations

impl KeyManipulator

pub fn create( domain: &Domain, anonymous: impl AsRef<KanziStr>, ) -> Result<KeyManipulator, Error>

Creates a KeyManipulator instance.

Arguments

• domain - The domain to which the KeyManipulator instance belongs.

impl KeyManipulator

pub fn create1( domain: &Domain, key: LogicalKey, modifier: KeyModifier, anonymous: impl AsRef<KanziStr>, ) -> Result<KeyManipulator, Error>

Creates a KeyManipulator instance.

Arguments

• domain - The domain to which the KeyManipulator instance belongs.
• key - The logical key value to handle.
• modifier - The key modifiers to handle. If no modifier is required, pass KeyModifier::Undefined.

Methods from Deref<Target = Object>

pub fn as_ptr(&self) -> *mut ObjectWrapper

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

1. Local value set with setProperty or loaded from kzb
2. Value set by a style affecting the property.
3. Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>

where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations

impl Clone for KeyManipulator

fn clone(&self) -> KeyManipulator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConcreteObjectConstraint for KeyManipulator

fn create_instance( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Self, Error>

impl Debug for KeyManipulator

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

Formats the value using the given formatter.

impl Deref for KeyManipulator

type Target = InputManipulator

The resulting type after dereferencing.

fn deref(&self) -> &<KeyManipulator as Deref>::Target

Dereferences the value.

impl Inheritable for KeyManipulator

unsafe fn downcast_unchecked<T>(self) -> T

where T: Inherits<Self>,

Downcast the object to a more specific type.

unsafe fn downcast_unchecked_ref<T>(&self) -> &T

where T: Inherits<Self>,

Downcast the object reference to a more specific type.

impl Inherits<InputManipulator> for KeyManipulator

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for KeyManipulator

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for KeyManipulator

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for KeyManipulator

fn downcast<T>(self) -> Result<Option<T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>

where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for KeyManipulator

where T: ObjectConstraint,

fn eq(&self, rhs: &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> PartialEq<Weak<T>> for KeyManipulator

where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<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 Eq for KeyManipulator