gdk4/auto/

seat.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, Device, DeviceTool, Display, SeatCapabilities};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Represents a collection of input devices that belong to a user.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `display`
    ///  [`Display`][crate::Display] of this seat.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// ## Signals
    ///
    ///
    /// #### `device-added`
    ///  Emitted when a new input device is related to this seat.
    ///
    ///
    ///
    ///
    /// #### `device-removed`
    ///  Emitted when an input device is removed (e.g. unplugged).
    ///
    ///
    ///
    ///
    /// #### `tool-added`
    ///  Emitted whenever a new tool is made known to the seat.
    ///
    /// The tool may later be assigned to a device (i.e. on
    /// proximity with a tablet). The device will emit the
    /// [`tool-changed`][struct@crate::Device#tool-changed] signal accordingly.
    ///
    /// A same tool may be used by several devices.
    ///
    ///
    ///
    ///
    /// #### `tool-removed`
    ///  Emitted whenever a tool is no longer known to this @seat.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`SeatExt`][trait@crate::prelude::SeatExt]
    #[doc(alias = "GdkSeat")]
    pub struct Seat(Object<ffi::GdkSeat>);

    match fn {
        type_ => || ffi::gdk_seat_get_type(),
    }
}

impl Seat {
    pub const NONE: Option<&'static Seat> = None;
}

/// Trait containing all [`struct@Seat`] methods.
///
/// # Implementors
///
/// [`Seat`][struct@crate::Seat]
pub trait SeatExt: IsA<Seat> + 'static {
    /// Returns the capabilities this [`Seat`][crate::Seat] currently has.
    ///
    /// # Returns
    ///
    /// the seat capabilities
    #[doc(alias = "gdk_seat_get_capabilities")]
    #[doc(alias = "get_capabilities")]
    fn capabilities(&self) -> SeatCapabilities {
        unsafe {
            from_glib(ffi::gdk_seat_get_capabilities(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns the devices that match the given capabilities.
    /// ## `capabilities`
    /// capabilities to get devices for
    ///
    /// # Returns
    ///
    /// A list
    ///   of `GdkDevices`. The list must be freed with g_list_free(),
    ///   the elements are owned by GTK and must not be freed.
    #[doc(alias = "gdk_seat_get_devices")]
    #[doc(alias = "get_devices")]
    fn devices(&self, capabilities: SeatCapabilities) -> Vec<Device> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::gdk_seat_get_devices(
                self.as_ref().to_glib_none().0,
                capabilities.into_glib(),
            ))
        }
    }

    /// Returns the [`Display`][crate::Display] this seat belongs to.
    ///
    /// # Returns
    ///
    /// a [`Display`][crate::Display]. This object
    ///   is owned by GTK and must not be freed.
    #[doc(alias = "gdk_seat_get_display")]
    #[doc(alias = "get_display")]
    fn display(&self) -> Display {
        unsafe { from_glib_none(ffi::gdk_seat_get_display(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the device that routes keyboard events.
    ///
    /// # Returns
    ///
    /// a [`Device`][crate::Device] with keyboard
    ///   capabilities. This object is owned by GTK and must not be freed.
    #[doc(alias = "gdk_seat_get_keyboard")]
    #[doc(alias = "get_keyboard")]
    fn keyboard(&self) -> Option<Device> {
        unsafe { from_glib_none(ffi::gdk_seat_get_keyboard(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the device that routes pointer events.
    ///
    /// # Returns
    ///
    /// a [`Device`][crate::Device] with pointer
    ///   capabilities. This object is owned by GTK and must not be freed.
    #[doc(alias = "gdk_seat_get_pointer")]
    #[doc(alias = "get_pointer")]
    fn pointer(&self) -> Option<Device> {
        unsafe { from_glib_none(ffi::gdk_seat_get_pointer(self.as_ref().to_glib_none().0)) }
    }

    /// Returns all `GdkDeviceTools` that are known to the application.
    ///
    /// # Returns
    ///
    ///
    ///   A list of tools. Free with g_list_free().
    #[doc(alias = "gdk_seat_get_tools")]
    #[doc(alias = "get_tools")]
    fn tools(&self) -> Vec<DeviceTool> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::gdk_seat_get_tools(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Emitted when a new input device is related to this seat.
    /// ## `device`
    /// the newly added [`Device`][crate::Device].
    #[doc(alias = "device-added")]
    fn connect_device_added<F: Fn(&Self, &Device) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn device_added_trampoline<P: IsA<Seat>, F: Fn(&P, &Device) + 'static>(
            this: *mut ffi::GdkSeat,
            device: *mut ffi::GdkDevice,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                Seat::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(device),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"device-added".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    device_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when an input device is removed (e.g. unplugged).
    /// ## `device`
    /// the just removed [`Device`][crate::Device].
    #[doc(alias = "device-removed")]
    fn connect_device_removed<F: Fn(&Self, &Device) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn device_removed_trampoline<
            P: IsA<Seat>,
            F: Fn(&P, &Device) + 'static,
        >(
            this: *mut ffi::GdkSeat,
            device: *mut ffi::GdkDevice,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                Seat::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(device),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"device-removed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    device_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted whenever a new tool is made known to the seat.
    ///
    /// The tool may later be assigned to a device (i.e. on
    /// proximity with a tablet). The device will emit the
    /// [`tool-changed`][struct@crate::Device#tool-changed] signal accordingly.
    ///
    /// A same tool may be used by several devices.
    /// ## `tool`
    /// the new [`DeviceTool`][crate::DeviceTool] known to the seat
    #[doc(alias = "tool-added")]
    fn connect_tool_added<F: Fn(&Self, &DeviceTool) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn tool_added_trampoline<
            P: IsA<Seat>,
            F: Fn(&P, &DeviceTool) + 'static,
        >(
            this: *mut ffi::GdkSeat,
            tool: *mut ffi::GdkDeviceTool,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                Seat::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(tool),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"tool-added".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    tool_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted whenever a tool is no longer known to this @seat.
    /// ## `tool`
    /// the just removed [`DeviceTool`][crate::DeviceTool]
    #[doc(alias = "tool-removed")]
    fn connect_tool_removed<F: Fn(&Self, &DeviceTool) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn tool_removed_trampoline<
            P: IsA<Seat>,
            F: Fn(&P, &DeviceTool) + 'static,
        >(
            this: *mut ffi::GdkSeat,
            tool: *mut ffi::GdkDeviceTool,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                Seat::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(tool),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"tool-removed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    tool_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Seat>> SeatExt for O {}