Struct gdk::DeviceManager

source · [−]

#[repr(transparent)]
pub struct DeviceManager { /* private fields */ }

Expand description

In addition to a single pointer and keyboard for user interface input, GDK contains support for a variety of input devices, including graphics tablets, touchscreens and multiple pointers/keyboards interacting simultaneously with the user interface. Such input devices often have additional features, such as sub-pixel positioning information and additional device-dependent information.

In order to query the device hierarchy and be aware of changes in the device hierarchy (such as virtual devices being created or removed, or physical devices being plugged or unplugged), GDK provides DeviceManager.

By default, and if the platform supports it, GDK is aware of multiple keyboard/pointer pairs and multitouch devices. This behavior can be changed by calling gdk_disable_multidevice() before Display::open(). There should rarely be a need to do that though, since GDK defaults to a compatibility mode in which it will emit just one enter/leave event pair for all devices on a window. To enable per-device enter/leave events and other multi-pointer interaction features, Window::set_support_multidevice() must be called on GdkWindows (or gtk_widget_set_support_multidevice() on widgets). window. See the Window::set_support_multidevice() documentation for more information.

On X11, multi-device support is implemented through XInput 2. Unless gdk_disable_multidevice() is called, the XInput 2 DeviceManager implementation will be used as the input source. Otherwise either the core or XInput 1 implementations will be used.

For simple applications that don’t have any special interest in input devices, the so-called “client pointer” provides a reasonable approximation to a simple setup with a single pointer and keyboard. The device that has been set as the client pointer can be accessed via gdk_device_manager_get_client_pointer().

Conceptually, in multidevice mode there are 2 device types. Virtual devices (or master devices) are represented by the pointer cursors and keyboard foci that are seen on the screen. Physical devices (or slave devices) represent the hardware that is controlling the virtual devices, and thus have no visible cursor on the screen.

Virtual devices are always paired, so there is a keyboard device for every pointer device. Associations between devices may be inspected through Device::associated_device().

There may be several virtual devices, and several physical devices could be controlling each of these virtual devices. Physical devices may also be “floating”, which means they are not attached to any virtual device.

Master and slave devices

carlos@sacarino:~$ xinput list
⎡ Virtual core pointer                          id=2    [master pointer  (3)]
⎜   ↳ Virtual core XTEST pointer                id=4    [slave  pointer  (2)]
⎜   ↳ Wacom ISDv4 E6 Pen stylus                 id=10   [slave  pointer  (2)]
⎜   ↳ Wacom ISDv4 E6 Finger touch               id=11   [slave  pointer  (2)]
⎜   ↳ SynPS/2 Synaptics TouchPad                id=13   [slave  pointer  (2)]
⎜   ↳ TPPS/2 IBM TrackPoint                     id=14   [slave  pointer  (2)]
⎜   ↳ Wacom ISDv4 E6 Pen eraser                 id=16   [slave  pointer  (2)]
⎣ Virtual core keyboard                         id=3    [master keyboard (2)]
    ↳ Virtual core XTEST keyboard               id=5    [slave  keyboard (3)]
    ↳ Power Button                              id=6    [slave  keyboard (3)]
    ↳ Video Bus                                 id=7    [slave  keyboard (3)]
    ↳ Sleep Button                              id=8    [slave  keyboard (3)]
    ↳ Integrated Camera                         id=9    [slave  keyboard (3)]
    ↳ AT Translated Set 2 keyboard              id=12   [slave  keyboard (3)]
    ↳ ThinkPad Extra Buttons                    id=15   [slave  keyboard (3)]

By default, GDK will automatically listen for events coming from all master devices, setting the Device for all events coming from input devices. Events containing device information are EventType::MotionNotify, EventType::ButtonPress, [EventType::_2buttonPress][crate::EventType::_2buttonPress], [EventType::_3buttonPress][crate::EventType::_3buttonPress], EventType::ButtonRelease, EventType::Scroll, EventType::KeyPress, EventType::KeyRelease, EventType::EnterNotify, EventType::LeaveNotify, EventType::FocusChange, EventType::ProximityIn, EventType::ProximityOut, EventType::DragEnter, EventType::DragLeave, EventType::DragMotion, EventType::DragStatus, EventType::DropStart, EventType::DropFinished and EventType::GrabBroken. When dealing with an event on a master device, it is possible to get the source (slave) device that the event originated from via gdk_event_get_source_device().

On a standard session, all physical devices are connected by default to the “Virtual Core Pointer/Keyboard” master devices, hence routing all events through these. This behavior is only modified by device grabs, where the slave device is temporarily detached for as long as the grab is held, and more permanently by user modifications to the device hierarchy.

On certain application specific setups, it may make sense to detach a physical device from its master pointer, and mapping it to an specific window. This can be achieved by the combination of gdk_device_grab() and Device::set_mode().

In order to listen for events coming from devices other than a virtual device, Window::set_device_events() must be called. Generally, this function can be used to modify the event mask for any given device.

Input devices may also provide additional information besides X/Y. For example, graphics tablets may also provide pressure and X/Y tilt information. This information is device-dependent, and may be queried through gdk_device_get_axis(). In multidevice mode, virtual devices will change axes in order to always represent the physical device that is routing events through it. Whenever the physical device changes, the property::Device::n-axes property will be notified, and Device::list_axes() will return the new device axes.

Devices may also have associated “keys” or macro buttons. Such keys can be globally set to map into normal X keyboard events. The mapping is set using Device::set_key().

In GTK+ 3.20, a new Seat object has been introduced that supersedes DeviceManager and should be preferred in newly written code.

This is an Abstract Base Class, you cannot instantiate it.

Struct gdk::DeviceManager

Implementations

impl DeviceManager

pub fn display(&self) -> Option<Display>

pub fn connect_device_added<F: Fn(&Self, &Device) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_device_changed<F: Fn(&Self, &Device) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_device_removed<F: Fn(&Self, &Device) + 'static>( &self, f: F) -> SignalHandlerId

impl DeviceManager

pub fn disable_multidevice()

Trait Implementations

impl Clone for DeviceManager

fn clone(&self) -> Self

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

impl Debug for DeviceManager

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

impl Display for DeviceManager

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

impl Hash for DeviceManager

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

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

impl Ord for DeviceManager

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

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

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

const fn clamp(self, min: Self, max: Self) -> Selfwhere Self: PartialOrd<Self>,

impl ParentClassIs for DeviceManager

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DeviceManager

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

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

impl<OT: ObjectType> PartialOrd<OT> for DeviceManager

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

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

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

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

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

impl StaticType for DeviceManager

fn static_type() -> Type

impl Eq for DeviceManager

Auto Trait Implementations

impl RefUnwindSafe for DeviceManager

impl !Send for DeviceManager

impl !Sync for DeviceManager

impl Unpin for DeviceManager

impl UnwindSafe for DeviceManager

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Cast for Twhere T: ObjectType,

fn upcast<T>(self) -> Twhere T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &Twhere T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>where T: ObjectType, Self: CanDowncast<T>,

fn downcast_ref<T>(&self) -> Option<&T>where T: ObjectType, Self: CanDowncast<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> Twhere T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere T: ObjectType,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<U> IsSubclassableExt for Uwhere U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>)where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for Twhere T: ObjectType,

fn is<U>(&self) -> boolwhere U: StaticType,

fn type_(&self) -> Type

fn object_class(&self) -> &Class<Object>

fn class(&self) -> &Class<T>where T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>>where U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where U: IsInterface,

fn set_property<V>(&self, property_name: &str, value: V)where V: ToValue,

fn set_property_from_value(&self, property_name: &str, value: &Value)

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

fn property<V>(&self, property_name: &str) -> Vwhere V: 'static + for<'b> FromValue<'b>,

pub fn connect_device_added<F: Fn(&Self, &Device) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_device_changed<F: Fn(&Self, &Device) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_device_removed<F: Fn(&Self, &Device) + 'static>(
&self,
f: F
) -> SignalHandlerId

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

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

const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Cast for Twhere
T: ObjectType,

fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,

fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,

fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for Twhere
T: ObjectType,

fn is<U>(&self) -> boolwhere
U: StaticType,

fn class(&self) -> &Class<T>where
T: IsClass,

fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,

fn set_property<V>(&self, property_name: &str, value: V)where
V: ToValue,

fn property<V>(&self, property_name: &str) -> Vwhere
V: 'static + for<'b> FromValue<'b>,

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,

fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,

fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,

fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value>,

fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value>,

unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,

unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,

fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>

fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>

fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: 'static + Fn(&T, &ParamSpec),

unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec),

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
F: 'static + FnOnce() + Send,

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: 'static + FnOnce(),

fn bind_property<'f, 't, O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,

impl<T> StaticTypeExt for Twhere
T: StaticType,

impl<T> ToClosureReturnValue for Twhere
T: ToValue,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T> TryFromClosureReturnValue for Twhere
T: 'static + for<'a> FromValue<'a> + StaticType,