Struct InputDevice

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

Implementations

impl InputDevice

pub fn get_associated_device(&self) -> Option<InputDevice>

Retrieves a pointer to the InputDevice that has been associated to self.

If the InputDevice:device-mode property of self is set to InputMode::Master, this function will return None.

Returns

a InputDevice, or None

pub fn get_axis(&self, index_: u32) -> InputAxis

Retrieves the type of axis on self at the given index.

index_

the index of the axis

Returns

the axis type

pub fn get_device_id(&self) -> i32

Retrieves the unique identifier of self

Returns

the identifier of the device

pub fn get_device_mode(&self) -> InputMode

Retrieves the InputMode of self.

Returns

the device mode

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

Retrieves the name of the self

Returns

the name of the device, or None. The returned string is owned by the InputDevice and should never be modified or freed

pub fn get_device_type(&self) -> InputDeviceType

Retrieves the type of self

Returns

the type of the device

pub fn get_enabled(&self) -> bool

Retrieves whether self is enabled.

Returns

true if the device is enabled

pub fn get_grabbed_actor(&self) -> Option<Actor>

Retrieves a pointer to the Actor currently grabbing all the events coming from self.

Returns

a Actor, or None

pub fn get_has_cursor(&self) -> bool

Retrieves whether self has a pointer that follows the device motion.

Returns

true if the device has a cursor

pub fn get_key(&self, index_: u32) -> Option<(u32, ModifierType)>

Retrieves the key set using InputDevice::set_key

index_

the index of the key

keyval

return location for the keyval at index_

modifiers

return location for the modifiers at index_

Returns

true if a key was set at the given index

pub fn get_modifier_state(&self) -> ModifierType

Retrieves the current modifiers state of the device, as seen by the last event Clutter processed.

Returns

the last known modifier state

pub fn get_n_axes(&self) -> u32

Retrieves the number of axes available on self.

Returns

the number of axes on the device

pub fn get_n_keys(&self) -> u32

Retrieves the number of keys registered for self.

Returns

the number of registered keys

pub fn get_pointer_actor(&self) -> Option<Actor>

Retrieves the Actor underneath the pointer of self

Returns

a pointer to the Actor or None

pub fn get_pointer_stage(&self) -> Option<Stage>

Retrieves the Stage underneath the pointer of self

Returns

a pointer to the Stage or None

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

Gets the product ID of this device.

Returns

the product ID

pub fn get_slave_devices(&self) -> Vec<InputDevice>

Retrieves the slave devices attached to self.

Returns

a list of InputDevice, or None. The contents of the list are owned by the device. Use glib::List::free when done

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

Gets the vendor ID of this device.

Returns

the vendor ID

pub fn grab<P: IsA<Actor>>(&self, actor: &P)

Acquires a grab on actor for the given self.

Any event coming from self will be delivered to actor, bypassing the usual event delivery mechanism, until the grab is released by calling InputDevice::ungrab.

The grab is client-side: even if the windowing system used by the Clutter backend has the concept of “device grabs”, Clutter will not use them.

Only InputDevice of types InputDeviceType::PointerDevice and InputDeviceType::KeyboardDevice can hold a grab.

actor

a Actor

pub fn sequence_get_grabbed_actor( &self, sequence: &mut EventSequence, ) -> Option<Actor>

Retrieves a pointer to the Actor currently grabbing the touch events coming from self given the sequence.

sequence

a EventSequence

Returns

a Actor, or None

pub fn sequence_grab<P: IsA<Actor>>( &self, sequence: &mut EventSequence, actor: &P, )

Acquires a grab on actor for the given self and the given touch sequence.

Any touch event coming from self and from sequence will be delivered to actor, bypassing the usual event delivery mechanism, until the grab is released by calling InputDevice::sequence_ungrab.

The grab is client-side: even if the windowing system used by the Clutter backend has the concept of “device grabs”, Clutter will not use them.

sequence

a EventSequence

actor

a Actor

pub fn sequence_ungrab(&self, sequence: &mut EventSequence)

Releases the grab on the self for the given sequence, if one is in place.

sequence

a EventSequence

pub fn set_enabled(&self, enabled: bool)

Enables or disables a InputDevice.

Only devices with a InputDevice:device-mode property set to InputMode::Slave or InputMode::Floating can be disabled.

enabled

true to enable the self

pub fn set_key(&self, index_: u32, keyval: u32, modifiers: ModifierType)

Sets the keyval and modifiers at the given index_ for self.

Clutter will use the keyval and modifiers set when filling out an event coming from the same input device.

index_

the index of the key

keyval

the keyval

modifiers

a bitmask of modifiers

pub fn ungrab(&self)

Releases the grab on the self, if one is in place.

pub fn update_from_event(&self, event: &mut Event, update_stage: bool)

Forcibly updates the state of the self using a ClutterEvent

This function should never be used by applications: it is meant for integration with embedding toolkits, like clutter-gtk

Embedding toolkits that disable the event collection inside Clutter need to use this function to update the state of input devices depending on a ClutterEvent that they are going to submit to the event handling code in Clutter though clutter_do_event. Since the input devices hold the state that is going to be used to fill in fields like the ButtonEvent click count, or to emit synthesized events like EventType::Enter and EventType::Leave, it is necessary for embedding toolkits to also be responsible of updating the input device state.

For instance, this might be the code to translate an embedding toolkit native motion notification into a Clutter MotionEvent and ask Clutter to process it:

  ClutterEvent c_event;

  translate_native_event_to_clutter (native_event, &c_event);

  clutter_do_event (&c_event);

Before letting clutter_do_event process the event, it is necessary to call InputDevice::update_from_event:

  ClutterEvent c_event;
  ClutterDeviceManager *manager;
  ClutterInputDevice *device;

  translate_native_event_to_clutter (native_event, &c_event);

  // get the device manager
  manager = clutter_device_manager_get_default ();

  // use the default Core Pointer that Clutter backends register by default
  device = clutter_device_manager_get_core_device (manager, %CLUTTER_POINTER_DEVICE);

  // update the state of the input device
  clutter_input_device_update_from_event (device, &c_event, FALSE);

  clutter_do_event (&c_event);

The update_stage boolean argument should be used when the input device enters and leaves a Stage; it will use the Stage field of the passed event to update the stage associated to the input device.

event

a ClutterEvent

update_stage

whether to update the Stage of the self using the stage of the event

pub fn get_property_backend(&self) -> Option<Backend>

The Backend that created the device.

pub fn get_property_device_manager(&self) -> Option<DeviceManager>

The DeviceManager instance which owns the device

pub fn get_property_id(&self) -> i32

The unique identifier of the device

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

The name of the device

pub fn connect_property_enabled_notify<F: Fn(&InputDevice) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_property_n_axes_notify<F: Fn(&InputDevice) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for InputDevice

fn clone(&self) -> InputDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputDevice

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

Formats the value using the given formatter.

impl Display for InputDevice

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

Formats the value using the given formatter.

impl Hash for InputDevice

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 InputDevice

fn cmp(&self, other: &InputDevice) -> 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 InputDevice

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 InputDevice

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 InputDevice

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for InputDevice