PadControllerProtocol

public protocol PadControllerProtocol : EventControllerProtocol

GtkPadController 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. GtkPadController is provided to map those to GAction 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 [methodGdk.DevicePad.get_n_groups] and [methodGdk.DevicePad.get_group_n_modes].

Each of the actions that a given button/strip/ring performs for a given mode is defined by a [structGtk.PadActionEntry]. It contains an action name that will be looked up in the given GActionGroup and activated whenever the specified input element and mode are triggered.

A simple example of GtkPadController usage: Assigning button 1 in all modes and pad devices to an “invert-selection” action:

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.

The PadControllerProtocol protocol exposes the methods and properties of an underlying GtkPadController instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see PadController. Alternatively, use PadControllerRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkPadController instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • pad_controller_ptr Default implementation

    Typed pointer to the underlying GtkPadController instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkPadController instance.

    Declaration

    Swift

    var pad_controller_ptr: UnsafeMutablePointer<GtkPadController>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to PadControllerProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

PadController Class

  • Bind a PadControllerPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: PadControllerPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a PadController property

    Declaration

    Swift

    @inlinable
func get(property: PadControllerPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a PadController property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: PadControllerPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

PadController Class: PadControllerProtocol extension (methods and fields)

  • Adds an individual action to controller.

    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.

    Declaration

    Swift

    @inlinable
func setAction(type: GtkPadActionType, index: Int, mode: Int, label: UnsafePointer<CChar>!, actionName: UnsafePointer<CChar>!)
    Show on GitHub
  • setAction(entries:nEntries:) Extension method

    A convenience function to add a group of action entries on controller.

    See [structGtk.PadActionEntry] and [methodGtk.PadController.set_action].

    Declaration

    Swift

    @inlinable
func setAction(entries: UnsafePointer<GtkPadActionEntry>!, nEntries: Int)
    Show on GitHub