501 lines
16 KiB
C
501 lines
16 KiB
C
/* PIKA - Photo and Image Kooker Application
|
|
* a rebranding of The GNU Image Manipulation Program (created with heckimp)
|
|
* A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
|
|
*
|
|
* Original copyright, applying to most contents (license remains unchanged):
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
*
|
|
* pikashortcutbutton.c
|
|
* Copyright (C) 2022 Jehan
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <gegl.h>
|
|
#include <gtk/gtk.h>
|
|
|
|
#include "libpikabase/pikabase.h"
|
|
#include "libpikawidgets/pikawidgets.h"
|
|
|
|
#include "widgets-types.h"
|
|
|
|
#include "pikashortcutbutton.h"
|
|
|
|
#include "pika-intl.h"
|
|
|
|
|
|
enum
|
|
{
|
|
ACCELERATOR_CHANGED,
|
|
LAST_SIGNAL
|
|
};
|
|
enum
|
|
{
|
|
PROP_0,
|
|
PROP_ACCELERATOR
|
|
};
|
|
|
|
struct _PikaShortcutButtonPrivate
|
|
{
|
|
guint keyval;
|
|
GdkModifierType modifiers;
|
|
|
|
GtkWidget *stack;
|
|
|
|
gboolean modifier_only_accepted;
|
|
gboolean single_modifier;
|
|
|
|
guint timer;
|
|
guint last_keyval;
|
|
GdkModifierType last_modifiers;
|
|
};
|
|
|
|
|
|
static void pika_shortcut_button_constructed (GObject *object);
|
|
static void pika_shortcut_button_finalize (GObject *object);
|
|
static void pika_shortcut_button_set_property (GObject *object,
|
|
guint property_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec);
|
|
static void pika_shortcut_button_get_property (GObject *object,
|
|
guint property_id,
|
|
GValue *value,
|
|
GParamSpec *pspec);
|
|
|
|
static gboolean pika_shortcut_button_key_press_event (GtkWidget *button,
|
|
GdkEventKey *event,
|
|
gpointer user_data);
|
|
static gboolean pika_shortcut_button_focus_out_event (PikaShortcutButton *button,
|
|
GdkEventFocus event,
|
|
gpointer user_data);
|
|
static void pika_shortcut_button_toggled (PikaShortcutButton *button,
|
|
gpointer user_data);
|
|
|
|
static void pika_shortcut_button_update_label (PikaShortcutButton *button);
|
|
|
|
static gboolean pika_shortcut_button_timeout (PikaShortcutButton *button);
|
|
|
|
static void pika_shortcut_button_keyval_to_modifiers (guint keyval,
|
|
GdkModifierType *modifiers);
|
|
|
|
|
|
G_DEFINE_TYPE_WITH_PRIVATE (PikaShortcutButton, pika_shortcut_button, GTK_TYPE_TOGGLE_BUTTON)
|
|
|
|
#define parent_class pika_shortcut_button_parent_class
|
|
|
|
static guint signals[LAST_SIGNAL] = { 0 };
|
|
|
|
static void
|
|
pika_shortcut_button_class_init (PikaShortcutButtonClass *klass)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (klass);
|
|
|
|
object_class->constructed = pika_shortcut_button_constructed;
|
|
object_class->finalize = pika_shortcut_button_finalize;
|
|
object_class->get_property = pika_shortcut_button_get_property;
|
|
object_class->set_property = pika_shortcut_button_set_property;
|
|
|
|
g_object_class_install_property (object_class, PROP_ACCELERATOR,
|
|
g_param_spec_string ("accelerator",
|
|
NULL, NULL, NULL,
|
|
PIKA_PARAM_READWRITE |
|
|
G_PARAM_EXPLICIT_NOTIFY));
|
|
|
|
signals[ACCELERATOR_CHANGED] = g_signal_new ("accelerator-changed",
|
|
G_TYPE_FROM_CLASS (klass),
|
|
G_SIGNAL_RUN_FIRST,
|
|
G_STRUCT_OFFSET (PikaShortcutButtonClass, accelerator_changed),
|
|
NULL, NULL, NULL,
|
|
G_TYPE_NONE, 1,
|
|
G_TYPE_STRING);
|
|
|
|
klass->accelerator_changed = NULL;
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_init (PikaShortcutButton *button)
|
|
{
|
|
GtkWidget *label;
|
|
|
|
button->priv = pika_shortcut_button_get_instance_private (button);
|
|
|
|
button->priv->timer = 0;
|
|
|
|
button->priv->stack = gtk_stack_new ();
|
|
gtk_container_add (GTK_CONTAINER (button), button->priv->stack);
|
|
gtk_widget_show (button->priv->stack);
|
|
|
|
label = gtk_shortcut_label_new (NULL);
|
|
gtk_stack_add_named (GTK_STACK (button->priv->stack), label,
|
|
"shortcut-label");
|
|
gtk_widget_show (label);
|
|
|
|
label = gtk_label_new (_("No shortcut"));
|
|
gtk_stack_add_named (GTK_STACK (button->priv->stack), label,
|
|
"label");
|
|
gtk_widget_show (label);
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_constructed (GObject *object)
|
|
{
|
|
G_OBJECT_CLASS (parent_class)->constructed (object);
|
|
|
|
g_signal_connect (object, "key-press-event",
|
|
G_CALLBACK (pika_shortcut_button_key_press_event),
|
|
NULL);
|
|
g_signal_connect (object, "focus-out-event",
|
|
G_CALLBACK (pika_shortcut_button_focus_out_event),
|
|
NULL);
|
|
g_signal_connect (object, "toggled",
|
|
G_CALLBACK (pika_shortcut_button_toggled),
|
|
NULL);
|
|
|
|
pika_shortcut_button_toggled (PIKA_SHORTCUT_BUTTON (object), NULL);
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_finalize (GObject *object)
|
|
{
|
|
PikaShortcutButton *button = PIKA_SHORTCUT_BUTTON (object);
|
|
|
|
G_OBJECT_CLASS (parent_class)->finalize (object);
|
|
|
|
if (button->priv->timer != 0)
|
|
{
|
|
g_source_remove (button->priv->timer);
|
|
button->priv->timer = 0;
|
|
}
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_set_property (GObject *object,
|
|
guint property_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
PikaShortcutButton *button = PIKA_SHORTCUT_BUTTON (object);
|
|
|
|
switch (property_id)
|
|
{
|
|
case PROP_ACCELERATOR:
|
|
pika_shortcut_button_set_accelerator (button, g_value_get_string (value), 0, 0);
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_get_property (GObject *object,
|
|
guint property_id,
|
|
GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
PikaShortcutButton *button = PIKA_SHORTCUT_BUTTON (object);
|
|
|
|
switch (property_id)
|
|
{
|
|
case PROP_ACCELERATOR:
|
|
{
|
|
gchar *name = gtk_accelerator_name (button->priv->keyval, button->priv->modifiers);
|
|
|
|
g_value_set_string (value, gtk_accelerator_name (button->priv->keyval, button->priv->modifiers));
|
|
g_free (name);
|
|
}
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* public functions */
|
|
|
|
GtkWidget *
|
|
pika_shortcut_button_new (const gchar *accelerator)
|
|
{
|
|
PikaShortcutButton *button;
|
|
|
|
button = g_object_new (PIKA_TYPE_SHORTCUT_BUTTON,
|
|
"accelerator", accelerator,
|
|
NULL);
|
|
|
|
return GTK_WIDGET (button);
|
|
}
|
|
|
|
gchar *
|
|
pika_shortcut_button_get_accelerator (PikaShortcutButton *button)
|
|
{
|
|
g_return_val_if_fail (PIKA_IS_SHORTCUT_BUTTON (button), NULL);
|
|
|
|
return gtk_accelerator_name (button->priv->keyval, button->priv->modifiers);
|
|
}
|
|
|
|
void
|
|
pika_shortcut_button_get_keys (PikaShortcutButton *button,
|
|
guint *keyval,
|
|
GdkModifierType *modifiers)
|
|
{
|
|
g_return_if_fail (PIKA_IS_SHORTCUT_BUTTON (button));
|
|
|
|
if (keyval)
|
|
*keyval = button->priv->keyval;
|
|
if (modifiers)
|
|
*modifiers = button->priv->modifiers;
|
|
}
|
|
|
|
void
|
|
pika_shortcut_button_set_accelerator (PikaShortcutButton *button,
|
|
const gchar *accelerator,
|
|
guint keyval,
|
|
GdkModifierType modifiers)
|
|
{
|
|
g_return_if_fail (PIKA_IS_SHORTCUT_BUTTON (button));
|
|
|
|
if (accelerator)
|
|
gtk_accelerator_parse (accelerator, &keyval, &modifiers);
|
|
|
|
if (button->priv->modifier_only_accepted && keyval != 0)
|
|
{
|
|
if (button->priv->single_modifier)
|
|
modifiers = 0;
|
|
pika_shortcut_button_keyval_to_modifiers (keyval, &modifiers);
|
|
keyval = 0;
|
|
}
|
|
|
|
if (keyval != button->priv->keyval || modifiers != button->priv->modifiers)
|
|
{
|
|
GtkWidget *label;
|
|
gchar *previous_accel;
|
|
gchar *accel;
|
|
|
|
previous_accel = gtk_accelerator_name (button->priv->keyval, button->priv->modifiers);
|
|
button->priv->keyval = keyval;
|
|
button->priv->modifiers = modifiers;
|
|
|
|
label = gtk_stack_get_child_by_name (GTK_STACK (button->priv->stack),
|
|
"shortcut-label");
|
|
|
|
accel = gtk_accelerator_name (keyval, modifiers);
|
|
gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (label), accel);
|
|
g_free (accel);
|
|
|
|
g_object_notify (G_OBJECT (button), "accelerator");
|
|
|
|
g_signal_emit (button, signals[ACCELERATOR_CHANGED], 0,
|
|
previous_accel);
|
|
g_free (previous_accel);
|
|
|
|
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), keyval != 0 || modifiers == 0);
|
|
pika_shortcut_button_toggled (PIKA_SHORTCUT_BUTTON (button), NULL);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* pika_shortcut_button_accepts_modifier:
|
|
* @accepted: are shortcuts with only modifiers accepted?
|
|
* @unique: if @only and @unique are both %TRUE, then the button will
|
|
* grab a single modifier
|
|
*
|
|
* By default, the shortcut button will accept shortcuts such as `a` or
|
|
* `Ctrl-a` or `Shift-Ctrl-a`. A modifier-only shortcut such as `Ctrl`
|
|
* will not be recorded.
|
|
* If @accepted is %TRUE, then it is the opposite. In such case, 2 cases
|
|
* are possible: if @unique is %FALSE, then single modifiers are
|
|
* recorded, such as `Ctrl` or `Shift`, but not `Ctrl-Shift`; if @unique
|
|
* is %FALSE, it may record both `Ctrl` and `Ctrl-Shift` or any modifier
|
|
* combination.
|
|
*/
|
|
void
|
|
pika_shortcut_button_accepts_modifier (PikaShortcutButton *button,
|
|
gboolean accepted,
|
|
gboolean unique)
|
|
{
|
|
g_return_if_fail (PIKA_IS_SHORTCUT_BUTTON (button));
|
|
|
|
button->priv->modifier_only_accepted = accepted;
|
|
button->priv->single_modifier = unique;
|
|
|
|
pika_shortcut_button_update_label (button);
|
|
}
|
|
|
|
/* Private functions. */
|
|
|
|
static gboolean
|
|
pika_shortcut_button_key_press_event (GtkWidget *widget,
|
|
GdkEventKey *event,
|
|
gpointer user_data)
|
|
{
|
|
PikaShortcutButton *button = PIKA_SHORTCUT_BUTTON (widget);
|
|
|
|
if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)))
|
|
{
|
|
GdkModifierType accel_mods = 0;
|
|
|
|
accel_mods = event->state;
|
|
accel_mods &= gtk_accelerator_get_default_mod_mask ();
|
|
|
|
if (button->priv->modifier_only_accepted)
|
|
{
|
|
if (button->priv->single_modifier)
|
|
{
|
|
if (event->is_modifier)
|
|
{
|
|
pika_shortcut_button_set_accelerator (button, NULL, event->keyval, 0);
|
|
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), FALSE);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
button->priv->last_keyval = event->keyval;
|
|
button->priv->last_modifiers = accel_mods;
|
|
if ((event->is_modifier || accel_mods != 0) && button->priv->timer == 0)
|
|
{
|
|
button->priv->timer = g_timeout_add (250,
|
|
(GSourceFunc) pika_shortcut_button_timeout,
|
|
button);
|
|
}
|
|
}
|
|
}
|
|
else if (! event->is_modifier)
|
|
{
|
|
pika_shortcut_button_set_accelerator (button, NULL, event->keyval, event->state);
|
|
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), FALSE);
|
|
}
|
|
return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
static gboolean
|
|
pika_shortcut_button_focus_out_event (PikaShortcutButton* button,
|
|
GdkEventFocus event,
|
|
gpointer user_data)
|
|
{
|
|
/* On losing focus, we untoggle, so we don't have to grab anything.
|
|
* Let's avoid cases with several shortcut buttons all grabing the
|
|
* same shortcuts for instance.
|
|
*/
|
|
if (button->priv->timer != 0)
|
|
{
|
|
g_source_remove (button->priv->timer);
|
|
button->priv->timer = 0;
|
|
}
|
|
|
|
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), FALSE);
|
|
|
|
/* Propagate event further. */
|
|
return FALSE;
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_toggled (PikaShortcutButton* button,
|
|
gpointer user_data)
|
|
{
|
|
pika_shortcut_button_update_label (button);
|
|
|
|
if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)) ||
|
|
(button->priv->keyval == 0 && button->priv->modifiers == 0))
|
|
gtk_stack_set_visible_child_name (GTK_STACK (button->priv->stack), "label");
|
|
else
|
|
gtk_stack_set_visible_child_name (GTK_STACK (button->priv->stack), "shortcut-label");
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_update_label (PikaShortcutButton *button)
|
|
{
|
|
GtkWidget *label;
|
|
gchar *markup;
|
|
|
|
g_return_if_fail (PIKA_IS_SHORTCUT_BUTTON (button));
|
|
|
|
label = gtk_stack_get_child_by_name (GTK_STACK (button->priv->stack),
|
|
"label");
|
|
|
|
if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)))
|
|
{
|
|
if (button->priv->modifier_only_accepted)
|
|
markup = g_strdup_printf ("<b>%s</b>", _("Set modifier"));
|
|
else
|
|
markup = g_strdup_printf ("<b>%s</b>", _("Set shortcut"));
|
|
}
|
|
else
|
|
{
|
|
if (button->priv->modifier_only_accepted)
|
|
markup = g_strdup_printf ("<i>%s</i>", _("No modifier"));
|
|
else
|
|
markup = g_strdup_printf ("<i>%s</i>", _("No shortcut"));
|
|
}
|
|
gtk_label_set_markup (GTK_LABEL (label), markup);
|
|
g_free (markup);
|
|
}
|
|
|
|
static gboolean
|
|
pika_shortcut_button_timeout (PikaShortcutButton *button)
|
|
{
|
|
pika_shortcut_button_set_accelerator (button, NULL,
|
|
button->priv->last_keyval,
|
|
button->priv->last_modifiers);
|
|
|
|
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), FALSE);
|
|
|
|
button->priv->timer = 0;
|
|
|
|
return G_SOURCE_REMOVE;
|
|
}
|
|
|
|
static void
|
|
pika_shortcut_button_keyval_to_modifiers (guint keyval,
|
|
GdkModifierType *modifiers)
|
|
{
|
|
/* XXX I believe that more keysyms are considered modifiers, but let's
|
|
* start with this. This basic list is basically taken from GDK code
|
|
* in gdk/quartz/gdkevents-quartz.c file.
|
|
*/
|
|
GdkModifierType mask = 0;
|
|
|
|
switch (keyval)
|
|
{
|
|
case GDK_KEY_Meta_R:
|
|
case GDK_KEY_Meta_L:
|
|
mask = GDK_MOD2_MASK;
|
|
break;
|
|
case GDK_KEY_Shift_R:
|
|
case GDK_KEY_Shift_L:
|
|
mask = GDK_SHIFT_MASK;
|
|
break;
|
|
case GDK_KEY_Caps_Lock:
|
|
mask = GDK_LOCK_MASK;
|
|
break;
|
|
case GDK_KEY_Alt_R:
|
|
case GDK_KEY_Alt_L:
|
|
mask = GDK_MOD1_MASK;
|
|
break;
|
|
case GDK_KEY_Control_R:
|
|
case GDK_KEY_Control_L:
|
|
mask = GDK_CONTROL_MASK;
|
|
break;
|
|
default:
|
|
mask = 0;
|
|
}
|
|
|
|
*modifiers |= mask;
|
|
}
|
