Module: Gdk::DevicePad

Defined in:
(unknown)

Overview

Gdk::DevicePad is an interface implemented by devices of type %GDK_SOURCE_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. gdk_device_pad_get_n_groups() can be used to obtain the number of groups, gdk_device_pad_get_n_features() and gdk_device_pad_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 gdk_device_pad_get_group_n_modes(), and the current mode for a given group will be notified through the Gdk::EventPadGroupMode event.

Instance Method Summary collapse

Instance Method Details

#get_feature_group(feature, feature_idx) ⇒ Integer

Returns the group the given feature and idx belong to, or -1 if feature/index do not exist in pad.

Parameters:

  • feature (Gdk::DevicePadFeature) —

    the feature type to get the group from

  • feature_idx (Integer) —

    the index of the feature to get the group from

Returns:

  • (Integer) —

    The group number of the queried pad feature.

#get_group_n_modes(group_idx) ⇒ Integer

Returns the number of modes that group may have.

Parameters:

  • group_idx (Integer) —

    group to get the number of available modes from

Returns:

  • (Integer) —

    The number of modes available in group.

#get_n_features(feature) ⇒ Integer

Returns the number of features a tablet pad has.

Parameters:

Returns:

  • (Integer) —

    The amount of elements of type feature that this pad has.

#n_groups ⇒ Integer

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:

  • (Integer) —

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