Interface DevicePad

All Superinterfaces:
Proxy
All Known Implementing Classes:
DevicePad.DevicePad$Impl
@Generated("org.javagi.JavaGI") public interface DevicePad extends Proxy

An interface for tablet pad devices.

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. getNGroups() can be used to obtain the number of groups, getNFeatures(DevicePadFeature) and getFeatureGroup(DevicePadFeature, int) 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 getGroupNModes(int), and the current mode for a given group will be notified through events of type GDK_PAD_GROUP_MODE.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    DevicePad.DevicePad$Impl
    The DevicePad$Impl type represents a native instance of the DevicePad interface.
    static class 
    DevicePad.DevicePadInterface
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default int
    getFeatureGroup(DevicePadFeature feature, int featureIdx)
    Returns the group the given feature and idx belong to.
    default int
    getGroupNModes(int groupIdx)
    Returns the number of modes that group may have.
    default int
    getNFeatures(DevicePadFeature feature)
    Returns the number of features a tablet pad has.
    default int
    getNGroups()
    Returns the number of groups this pad device has.
    static @Nullable Type
    getType()
    Get the GType of the DevicePad class.

    Methods inherited from interface Proxy

    handle

  • Method Details

    • getType

      static @Nullable Type getType()
      Get the GType of the DevicePad class.
      Returns:
      the GType

    • getFeatureGroup

      default int getFeatureGroup(DevicePadFeature feature, int featureIdx)

      Returns the group the given feature and idx belong to.

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

      Parameters:
      feature - the feature type to get the group from
      featureIdx - the index of the feature to get the group from
      Returns:
      The group number of the queried pad feature.

    • getGroupNModes

      default int getGroupNModes(int groupIdx)
      Returns the number of modes that group may have.
      Parameters:
      groupIdx - group to get the number of available modes from
      Returns:
      The number of modes available in group.

    • getNFeatures

      default int getNFeatures(DevicePadFeature feature)
      Returns the number of features a tablet pad has.
      Parameters:
      feature - a pad feature
      Returns:
      The amount of elements of type feature that this pad has.

    • getNGroups

      default int getNGroups()

      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.

      Returns:
      The number of button/ring/strip groups in the pad.