a0b9586465
This GdkEventController is a helper object to handle pad events, it allows setting a mapping to action names, to be triggered in the given action group. In order to help on places where advanced mapping/configurability of pad features is not desirable, this controller also allows passing a NULL pad device, meaning it will listen on all pads, and/or passing -1 on mode/index, so an action applies to all modes/features (eg. strips/rings). https://bugzilla.gnome.org/show_bug.cgi?id=770026
100 lines
3.8 KiB
C
100 lines
3.8 KiB
C
/* GTK - The GIMP Toolkit
|
|
* Copyright (C) 2016, Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Author(s): Carlos Garnacho <carlosg@gnome.org>
|
|
*/
|
|
|
|
#ifndef __GTK_PAD_CONTROLLER_H__
|
|
#define __GTK_PAD_CONTROLLER_H__
|
|
|
|
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
|
|
#error "Only <gtk/gtk.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gdk/gdk.h>
|
|
#include <gtk/gtkeventcontroller.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define GTK_TYPE_PAD_CONTROLLER (gtk_pad_controller_get_type ())
|
|
#define GTK_PAD_CONTROLLER(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_PAD_CONTROLLER, GtkPadController))
|
|
#define GTK_PAD_CONTROLLER_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_PAD_CONTROLLER, GtkPadControllerClass))
|
|
#define GTK_IS_PAD_CONTROLLER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_PAD_CONTROLLER))
|
|
#define GTK_IS_PAD_CONTROLLER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_PAD_CONTROLLER))
|
|
#define GTK_PAD_CONTROLLER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_PAD_CONTROLLER, GtkPadControllerClass))
|
|
|
|
typedef struct _GtkPadController GtkPadController;
|
|
typedef struct _GtkPadControllerClass GtkPadControllerClass;
|
|
typedef struct _GtkPadActionEntry GtkPadActionEntry;
|
|
|
|
/**
|
|
* GtkPadActionType:
|
|
* @GTK_PAD_ACTION_BUTTON: Action is triggered by a pad button
|
|
* @GTK_PAD_ACTION_RING: Action is triggered by a pad ring
|
|
* @GTK_PAD_ACTION_STRIP: Action is triggered by a pad strip
|
|
*
|
|
* The type of a pad action.
|
|
*/
|
|
typedef enum {
|
|
GTK_PAD_ACTION_BUTTON,
|
|
GTK_PAD_ACTION_RING,
|
|
GTK_PAD_ACTION_STRIP
|
|
} GtkPadActionType;
|
|
|
|
/**
|
|
* GtkPadActionEntry:
|
|
* @type: the type of pad feature that will trigger this action entry.
|
|
* @index: the 0-indexed button/ring/strip number that will trigger this action
|
|
* entry.
|
|
* @mode: the mode that will trigger this action entry, or -1 for all modes.
|
|
* @label: Human readable description of this action entry, this string should
|
|
* be deemed user-visible.
|
|
* @action_name: action name that will be activated in the #GActionGroup.
|
|
*
|
|
* Struct defining a pad action entry.
|
|
*/
|
|
struct _GtkPadActionEntry {
|
|
GtkPadActionType type;
|
|
gint index;
|
|
gint mode;
|
|
gchar *label;
|
|
gchar *action_name;
|
|
};
|
|
|
|
GDK_AVAILABLE_IN_3_22
|
|
GType gtk_pad_controller_get_type (void) G_GNUC_CONST;
|
|
|
|
GDK_AVAILABLE_IN_3_22
|
|
GtkPadController *gtk_pad_controller_new (GtkWindow *window,
|
|
GActionGroup *group,
|
|
GdkDevice *pad);
|
|
|
|
GDK_AVAILABLE_IN_3_22
|
|
void gtk_pad_controller_set_action_entries (GtkPadController *controller,
|
|
const GtkPadActionEntry *entries,
|
|
gint n_entries);
|
|
GDK_AVAILABLE_IN_3_22
|
|
void gtk_pad_controller_set_action (GtkPadController *controller,
|
|
GtkPadActionType type,
|
|
gint index,
|
|
gint mode,
|
|
const gchar *label,
|
|
const gchar *action_name);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GTK_PAD_CONTROLLER_H__ */
|