:right-sidebar: True

DevicePad
===================================================================

.. currentmodule:: gi.repository.Gdk





.. class:: DevicePad(*args, **kwargs)
   :no-contents-entry:






``GdkDevicePad`` is an interface implemented by devices of type
:const:`~gi.repository.Gdk.InputSource.TABLET_PAD`

It allows querying the features provided by the pad device.

Tablet pads may contain one or more groups, each containing a subset
of the buttons/rings/strips available. :obj:`~gi.repository.Gdk.DevicePad.get_n_groups`
can be used to obtain the number of groups, :obj:`~gi.repository.Gdk.DevicePad.get_n_features`
and :obj:`~gi.repository.Gdk.DevicePad.get_feature_group` can be combined to find out
the number of buttons/rings/strips the device has, and how are they grouped.

Each of those groups have different modes, which may be used to map each
individual pad feature to multiple actions. Only one mode is effective
(current) for each given group, different groups may have different
current modes. The number of available modes in a group can be found
out through :obj:`~gi.repository.Gdk.DevicePad.get_group_n_modes`\, and the current mode
for a given group will be notified through events of type ``GDK_PAD_GROUP_MODE``\.




Methods
-------

.. rst-class:: interim-class

.. class:: DevicePad
   :no-index:


   .. method:: get_feature_group(feature: ~gi.repository.Gdk.DevicePadFeature, feature_idx: int) -> int

      Returns the group the given ``feature`` and ``idx`` belong to.

      f the feature or index do not exist in ``pad``\, -1 is returned.






      :param feature: the feature type to get the group from

      :param feature_idx: the index of the feature to get the group from




   .. method:: get_group_n_modes(group_idx: int) -> int

      Returns the number of modes that ``group`` may have.






      :param group_idx: group to get the number of available modes from




   .. method:: get_n_features(feature: ~gi.repository.Gdk.DevicePadFeature) -> int

      Returns the number of features a tablet pad has.






      :param feature: a pad feature




   .. method:: get_n_groups() -> int

      Returns the number of groups this pad device has.

      Pads have at least one group. A pad group is a subcollection of
      buttons/strip/rings that is affected collectively by a same
      current mode.