gtk4/auto/

pad_controller.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, EventController, PadActionEntry, PadActionType, PropagationLimit, PropagationPhase,
};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// [`PadController`][crate::PadController] is an event controller for the pads found in drawing
    /// tablets.
    ///
    /// Pads are the collection of buttons and tactile sensors often found around
    /// the stylus-sensitive area.
    ///
    /// These buttons and sensors have no implicit meaning, and by default they
    /// perform no action. [`PadController`][crate::PadController] is provided to map those to
    /// [`gio::Action`][crate::gio::Action] objects, thus letting the application give them a more
    /// semantic meaning.
    ///
    /// Buttons and sensors are not constrained to triggering a single action,
    /// some `GDK_SOURCE_TABLET_PAD` devices feature multiple "modes". All these
    /// input elements have one current mode, which may determine the final action
    /// being triggered.
    ///
    /// Pad devices often divide buttons and sensors into groups. All elements
    /// in a group share the same current mode, but different groups may have
    /// different modes. See `Gdk::DevicePad::get_n_groups()` and
    /// `Gdk::DevicePad::get_group_n_modes()`.
    ///
    /// Each of the actions that a given button/strip/ring performs for a given mode
    /// is defined by a [`PadActionEntry`][crate::PadActionEntry]. It contains an action name that
    /// will be looked up in the given [`gio::ActionGroup`][crate::gio::ActionGroup] and activated whenever
    /// the specified input element and mode are triggered.
    ///
    /// A simple example of [`PadController`][crate::PadController] usage: Assigning button 1 in all
    /// modes and pad devices to an "invert-selection" action:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// GtkPadActionEntry *pad_actions[] = {
    ///   { GTK_PAD_ACTION_BUTTON, 1, -1, "Invert selection", "pad-actions.invert-selection" },
    ///   …
    /// };
    ///
    /// …
    /// action_group = g_simple_action_group_new ();
    /// action = g_simple_action_new ("pad-actions.invert-selection", NULL);
    /// g_signal_connect (action, "activate", on_invert_selection_activated, NULL);
    /// g_action_map_add_action (G_ACTION_MAP (action_group), action);
    /// …
    /// pad_controller = gtk_pad_controller_new (action_group, NULL);
    /// ```
    ///
    /// The actions belonging to rings/strips will be activated with a parameter
    /// of type `G_VARIANT_TYPE_DOUBLE` bearing the value of the given axis, it
    /// is required that those are made stateful and accepting this `GVariantType`.
    ///
    /// ## Properties
    ///
    ///
    /// #### `action-group`
    ///  The action group of the controller.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `pad`
    ///  The pad of the controller.
    ///
    /// Readable | Writeable | Construct Only
    /// <details><summary><h4>EventController</h4></summary>
    ///
    ///
    /// #### `name`
    ///  The name for this controller, typically used for debugging purposes.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `propagation-limit`
    ///  The limit for which events this controller will handle.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `propagation-phase`
    ///  The propagation phase at which this controller will handle events.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `widget`
    ///  The widget receiving the `GdkEvents` that the controller will handle.
    ///
    /// Readable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkPadController")]
    pub struct PadController(Object<ffi::GtkPadController, ffi::GtkPadControllerClass>) @extends EventController;

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

impl PadController {
    /// Creates a new [`PadController`][crate::PadController] that will associate events from @pad to
    /// actions.
    ///
    /// A [`None`] pad may be provided so the controller manages all pad devices
    /// generically, it is discouraged to mix [`PadController`][crate::PadController] objects with
    /// [`None`] and non-[`None`] @pad argument on the same toplevel window, as execution
    /// order is not guaranteed.
    ///
    /// The [`PadController`][crate::PadController] is created with no mapped actions. In order to
    /// map pad events to actions, use [`set_action_entries()`][Self::set_action_entries()]
    /// or [`set_action()`][Self::set_action()].
    ///
    /// Be aware that pad events will only be delivered to [`Window`][crate::Window]s, so adding
    /// a pad controller to any other type of widget will not have an effect.
    /// ## `group`
    /// `GActionGroup` to trigger actions from
    /// ## `pad`
    /// A `GDK_SOURCE_TABLET_PAD` device, or [`None`] to handle all pads
    ///
    /// # Returns
    ///
    /// A newly created [`PadController`][crate::PadController]
    #[doc(alias = "gtk_pad_controller_new")]
    pub fn new(group: &impl IsA<gio::ActionGroup>, pad: Option<&gdk::Device>) -> PadController {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_pad_controller_new(
                group.as_ref().to_glib_none().0,
                pad.to_glib_none().0,
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`PadController`] objects.
    ///
    /// This method returns an instance of [`PadControllerBuilder`](crate::builders::PadControllerBuilder) which can be used to create [`PadController`] objects.
    pub fn builder() -> PadControllerBuilder {
        PadControllerBuilder::new()
    }

    /// Adds an individual action to @self.
    ///
    /// This action will only be activated if the given button/ring/strip number
    /// in @index is interacted while the current mode is @mode. -1 may be used
    /// for simple cases, so the action is triggered on all modes.
    ///
    /// The given @label should be considered user-visible, so internationalization
    /// rules apply. Some windowing systems may be able to use those for user
    /// feedback.
    /// ## `type_`
    /// the type of pad feature that will trigger this action
    /// ## `index`
    /// the 0-indexed button/ring/strip number that will trigger this action
    /// ## `mode`
    /// the mode that will trigger this action, or -1 for all modes.
    /// ## `label`
    /// Human readable description of this action, this string should
    ///   be deemed user-visible.
    /// ## `action_name`
    /// action name that will be activated in the `GActionGroup`
    #[doc(alias = "gtk_pad_controller_set_action")]
    pub fn set_action(
        &self,
        type_: PadActionType,
        index: i32,
        mode: i32,
        label: &str,
        action_name: &str,
    ) {
        unsafe {
            ffi::gtk_pad_controller_set_action(
                self.to_glib_none().0,
                type_.into_glib(),
                index,
                mode,
                label.to_glib_none().0,
                action_name.to_glib_none().0,
            );
        }
    }

    /// A convenience function to add a group of action entries on
    /// @self.
    ///
    /// See [`PadActionEntry`][crate::PadActionEntry] and [`set_action()`][Self::set_action()].
    /// ## `entries`
    /// the action entries to set on @self
    #[doc(alias = "gtk_pad_controller_set_action_entries")]
    pub fn set_action_entries(&self, entries: &[PadActionEntry]) {
        let n_entries = entries.len() as _;
        unsafe {
            ffi::gtk_pad_controller_set_action_entries(
                self.to_glib_none().0,
                entries.to_glib_none().0,
                n_entries,
            );
        }
    }

    /// The action group of the controller.
    #[doc(alias = "action-group")]
    pub fn action_group(&self) -> Option<gio::ActionGroup> {
        ObjectExt::property(self, "action-group")
    }

    /// The pad of the controller.
    pub fn pad(&self) -> Option<gdk::Device> {
        ObjectExt::property(self, "pad")
    }
}

impl Default for PadController {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`PadController`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct PadControllerBuilder {
    builder: glib::object::ObjectBuilder<'static, PadController>,
}

impl PadControllerBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The action group of the controller.
    pub fn action_group(self, action_group: &impl IsA<gio::ActionGroup>) -> Self {
        Self {
            builder: self
                .builder
                .property("action-group", action_group.clone().upcast()),
        }
    }

    /// The pad of the controller.
    pub fn pad(self, pad: &gdk::Device) -> Self {
        Self {
            builder: self.builder.property("pad", pad.clone()),
        }
    }

    /// The name for this controller, typically used for debugging purposes.
    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    /// The limit for which events this controller will handle.
    pub fn propagation_limit(self, propagation_limit: PropagationLimit) -> Self {
        Self {
            builder: self
                .builder
                .property("propagation-limit", propagation_limit),
        }
    }

    /// The propagation phase at which this controller will handle events.
    pub fn propagation_phase(self, propagation_phase: PropagationPhase) -> Self {
        Self {
            builder: self
                .builder
                .property("propagation-phase", propagation_phase),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`PadController`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> PadController {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}