gnome-control-center/panels/keyboard/cc-keyboard-shortcut-editor.c

717 lines
22 KiB
C
Raw Normal View History

/* cc-keyboard-shortcut-editor.h
*
* Copyright (C) 2016 Endless, Inc
*
* 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 2 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 <http://www.gnu.org/licenses/>.
*
* Authors: Georges Basile Stavracas Neto <georges.stavracas@gmail.com>
*/
#include <glib-object.h>
#include <glib/gi18n.h>
#include "cc-keyboard-shortcut-editor.h"
#include "keyboard-shortcuts.h"
struct _CcKeyboardShortcutEditor
{
GtkDialog parent;
GtkWidget *add_button;
GtkWidget *cancel_button;
GtkWidget *command_entry;
GtkWidget *custom_shortcut_accel_label;
GtkWidget *edit_button;
GtkWidget *headerbar;
GtkWidget *name_entry;
GtkWidget *remove_button;
GtkWidget *replace_button;
GtkWidget *shortcut_accel_label;
GtkWidget *stack;
GtkWidget *top_info_label;
CcShortcutEditorMode mode;
GdkDevice *grab_device;
CcKeyboardPanel *panel;
CcKeyboardItem *item;
/* Custom shortcuts */
GdkDevice *grab_pointer;
guint custom_keycode;
guint custom_keyval;
GdkModifierType custom_mask;
gboolean custom_is_modifier;
gboolean edited : 1;
};
static void command_entry_changed_cb (CcKeyboardShortcutEditor *self);
static void name_entry_changed_cb (CcKeyboardShortcutEditor *self);
G_DEFINE_TYPE (CcKeyboardShortcutEditor, cc_keyboard_shortcut_editor, GTK_TYPE_DIALOG)
enum
{
PROP_0,
PROP_KEYBOARD_ITEM,
PROP_PANEL,
N_PROPS
};
enum
{
ADD_CUSTOM_SHORTCUT,
REMOVE_CUSTOM_SHORTCUT,
LAST_SIGNAL
};
static GParamSpec *properties [N_PROPS] = { NULL, };
static guint signals[LAST_SIGNAL] = { 0, };
static void
apply_custom_item_fields (CcKeyboardShortcutEditor *self,
CcKeyboardItem *item)
{
/* Only setup the binding when it was actually edited */
if (self->edited)
{
gchar *binding;
item->keycode = self->custom_keycode;
item->keyval = self->custom_keyval;
item->mask = self->custom_mask;
if (item->keycode == 0 && item->keyval == 0 && item->mask == 0)
binding = g_strdup ("");
else
binding = gtk_accelerator_name_with_keycode (NULL,
item->keyval,
item->keycode,
item->mask);
g_object_set (G_OBJECT (item), "binding", binding, NULL);
g_free (binding);
}
/* Set the keyboard shortcut name and command for custom entries */
if (item->type == CC_KEYBOARD_ITEM_TYPE_GSETTINGS_PATH)
{
g_settings_set_string (item->settings, "name", gtk_entry_get_text (GTK_ENTRY (self->name_entry)));
g_settings_set_string (item->settings, "command", gtk_entry_get_text (GTK_ENTRY (self->command_entry)));
}
}
static void
clear_custom_entries (CcKeyboardShortcutEditor *self)
{
g_signal_handlers_block_by_func (self->command_entry, command_entry_changed_cb, self);
g_signal_handlers_block_by_func (self->name_entry, name_entry_changed_cb, self);
gtk_entry_set_text (GTK_ENTRY (self->name_entry), "");
gtk_entry_set_text (GTK_ENTRY (self->command_entry), "");
gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->custom_shortcut_accel_label), "");
self->custom_keycode = 0;
self->custom_keyval = 0;
self->custom_mask = 0;
self->custom_is_modifier = TRUE;
self->edited = FALSE;
g_signal_handlers_unblock_by_func (self->command_entry, command_entry_changed_cb, self);
g_signal_handlers_unblock_by_func (self->name_entry, name_entry_changed_cb, self);
}
static gboolean
is_custom_shortcut (CcKeyboardShortcutEditor *self)
{
return g_str_equal (gtk_stack_get_visible_child_name (GTK_STACK (self->stack)), "custom");
}
static void
grab_seat (CcKeyboardShortcutEditor *self,
GdkEvent *event)
{
GdkGrabStatus status;
GdkDevice *pointer;
GdkDevice *device;
GdkWindow *window;
if (!event)
event = gtk_get_current_event ();
device = gdk_event_get_device (event);
window = gtk_widget_get_window (GTK_WIDGET (self));
if (!device || !window)
return;
if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
pointer = gdk_device_get_associated_device (device);
else
pointer = device;
status = gdk_seat_grab (gdk_device_get_seat (pointer),
window,
GDK_SEAT_CAPABILITY_ALL,
FALSE,
NULL,
event,
NULL,
NULL);
if (status != GDK_GRAB_SUCCESS)
return;
self->grab_pointer = pointer;
gtk_grab_add (GTK_WIDGET (self));
}
static void
release_grab (CcKeyboardShortcutEditor *self)
{
if (self->grab_pointer)
{
gdk_seat_ungrab (gdk_device_get_seat (self->grab_pointer));
self->grab_pointer = NULL;
gtk_grab_remove (GTK_WIDGET (self));
}
}
static void
update_shortcut (CcKeyboardShortcutEditor *self)
{
if (!self->item)
return;
/* Setup the binding */
apply_custom_item_fields (self, self->item);
/* Cleanup whatever was set before */
clear_custom_entries (self);
cc_keyboard_shortcut_editor_set_item (self, NULL);
}
static GtkShortcutLabel*
get_current_shortcut_label (CcKeyboardShortcutEditor *self)
{
if (is_custom_shortcut (self))
return GTK_SHORTCUT_LABEL (self->custom_shortcut_accel_label);
return GTK_SHORTCUT_LABEL (self->shortcut_accel_label);
}
static void
setup_custom_shortcut (CcKeyboardShortcutEditor *self)
{
GtkShortcutLabel *shortcut_label;
gboolean valid;
gchar *accel;
valid = is_valid_binding (self->custom_keyval, self->custom_mask, self->custom_keycode) &&
gtk_accelerator_valid (self->custom_keyval, self->custom_mask) &&
!self->custom_is_modifier;
/* Additional checks for custom shortcuts */
if (is_custom_shortcut (self))
{
valid = valid &&
gtk_entry_get_text_length (GTK_ENTRY (self->name_entry)) > 0 &&
gtk_entry_get_text_length (GTK_ENTRY (self->command_entry)) > 0;
}
gtk_widget_set_sensitive (self->add_button, valid);
if (!valid)
return;
shortcut_label = get_current_shortcut_label (self);
accel = gtk_accelerator_name (self->custom_keyval, self->custom_mask);
/* Setup the accelerator label */
gtk_shortcut_label_set_accelerator (shortcut_label, accel);
/*
* When the user finishes typing the new shortcut, it gets immediately
* applied and the toggle button gets inactive.
*/
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
self->edited = TRUE;
release_grab (self);
g_free (accel);
}
static void
add_button_clicked_cb (CcKeyboardShortcutEditor *self)
{
CcKeyboardItem *item;
item = cc_keyboard_panel_create_custom_item (self->panel);
/* Apply the custom shortcut setup at the new item */
apply_custom_item_fields (self, item);
/* Cleanup everything once we're done */
clear_custom_entries (self);
g_signal_emit (self, signals[ADD_CUSTOM_SHORTCUT], 0, item);
gtk_widget_hide (GTK_WIDGET (self));
}
static void
cancel_button_clicked_cb (GtkWidget *button,
CcKeyboardShortcutEditor *self)
{
cc_keyboard_shortcut_editor_set_item (self, NULL);
clear_custom_entries (self);
gtk_widget_hide (GTK_WIDGET (self));
}
static void
command_entry_changed_cb (CcKeyboardShortcutEditor *self)
{
setup_custom_shortcut (self);
}
static void
edit_custom_shortcut_button_toggled_cb (CcKeyboardShortcutEditor *self,
GParamSpec *pspec,
GtkToggleButton *button)
{
if (gtk_toggle_button_get_active (button))
grab_seat (self, NULL);
else
release_grab (self);
}
static void
name_entry_changed_cb (CcKeyboardShortcutEditor *self)
{
setup_custom_shortcut (self);
}
static void
remove_button_clicked_cb (CcKeyboardShortcutEditor *self)
{
gtk_widget_hide (GTK_WIDGET (self));
g_signal_emit (self, signals[REMOVE_CUSTOM_SHORTCUT], 0, self->item);
}
static void
setup_keyboard_item (CcKeyboardShortcutEditor *self,
CcKeyboardItem *item)
{
gboolean is_custom;
gchar *accel;
gchar *text;
if (!item)
return;
is_custom = item->type == CC_KEYBOARD_ITEM_TYPE_GSETTINGS_PATH;
accel = gtk_accelerator_name (item->keyval, item->mask);
/* Headerbar */
gtk_header_bar_set_title (GTK_HEADER_BAR (self->headerbar), item->description);
gtk_header_bar_set_show_close_button (GTK_HEADER_BAR (self->headerbar), TRUE);
gtk_widget_hide (self->add_button);
gtk_widget_hide (self->cancel_button);
gtk_widget_hide (self->replace_button);
/* Setup the top label */
text = g_strdup_printf (_("Keyboard shortcut for <b>%s</b>. Enter new shortcut to change."), item->description);
gtk_label_set_markup (GTK_LABEL (self->top_info_label), text);
/* Accelerator labels */
gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->shortcut_accel_label), accel);
gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->custom_shortcut_accel_label), accel);
/* Setup the custom entries */
if (is_custom)
{
g_signal_handlers_block_by_func (self->command_entry, command_entry_changed_cb, self);
g_signal_handlers_block_by_func (self->name_entry, name_entry_changed_cb, self);
/* Name entry */
gtk_entry_set_text (GTK_ENTRY (self->name_entry), item->description);
gtk_widget_set_sensitive (self->name_entry, item->desc_editable);
/* Command entry */
gtk_entry_set_text (GTK_ENTRY (self->command_entry), item->command);
gtk_widget_set_sensitive (self->command_entry, item->cmd_editable);
gtk_widget_show (self->remove_button);
g_signal_handlers_unblock_by_func (self->command_entry, command_entry_changed_cb, self);
g_signal_handlers_unblock_by_func (self->name_entry, name_entry_changed_cb, self);
}
g_free (accel);
g_free (text);
/* Show the apropriate view */
gtk_stack_set_visible_child_name (GTK_STACK (self->stack), is_custom ? "custom" : "edit");
}
static void
cc_keyboard_shortcut_editor_finalize (GObject *object)
{
CcKeyboardShortcutEditor *self = (CcKeyboardShortcutEditor *)object;
g_clear_object (&self->item);
G_OBJECT_CLASS (cc_keyboard_shortcut_editor_parent_class)->finalize (object);
}
static void
cc_keyboard_shortcut_editor_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
CcKeyboardShortcutEditor *self = CC_KEYBOARD_SHORTCUT_EDITOR (object);
switch (prop_id)
{
case PROP_KEYBOARD_ITEM:
g_value_set_object (value, self->item);
break;
case PROP_PANEL:
g_value_set_pointer (value, self->panel);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static void
cc_keyboard_shortcut_editor_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
CcKeyboardShortcutEditor *self = CC_KEYBOARD_SHORTCUT_EDITOR (object);
switch (prop_id)
{
case PROP_KEYBOARD_ITEM:
cc_keyboard_shortcut_editor_set_item (self, g_value_get_object (value));
break;
case PROP_PANEL:
self->panel = g_value_get_pointer (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static gboolean
cc_keyboard_shortcut_editor_key_press_event (GtkWidget *widget,
GdkEventKey *event)
{
CcKeyboardShortcutEditor *self;
GdkModifierType real_mask;
gboolean editing;
self = CC_KEYBOARD_SHORTCUT_EDITOR (widget);
editing = !g_str_equal (gtk_stack_get_visible_child_name (GTK_STACK (self->stack)), "custom") ||
gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (self->edit_button));
if (!editing)
return GTK_WIDGET_CLASS (cc_keyboard_shortcut_editor_parent_class)->key_press_event (widget, event);
real_mask = event->state & gtk_accelerator_get_default_mod_mask ();
/* A single Escape press cancels the editing */
if (!event->is_modifier && real_mask == 0 && event->keyval == GDK_KEY_Escape)
{
self->edited = FALSE;
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
release_grab (self);
return GDK_EVENT_STOP;
}
/* Backspace disables the current shortcut */
if (!event->is_modifier && real_mask == 0 && event->keyval == GDK_KEY_BackSpace)
{
self->edited = TRUE;
self->custom_keycode = 0;
self->custom_keyval = 0;
self->custom_mask = 0;
if (self->item)
apply_custom_item_fields (self, self->item);
gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->custom_shortcut_accel_label), "");
gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->shortcut_accel_label), "");
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
release_grab (self);
self->edited = FALSE;
return GDK_EVENT_STOP;
}
self->custom_is_modifier = event->is_modifier;
self->custom_keycode = event->hardware_keycode;
self->custom_keyval = event->keyval;
self->custom_mask = real_mask;
/* CapsLock isn't supported as a keybinding modifier, so keep it from confusing us */
self->custom_mask &= ~GDK_LOCK_MASK;
if (!self->grab_pointer)
grab_seat (self, (GdkEvent*) event);
setup_custom_shortcut (self);
return GDK_EVENT_STOP;
}
static void
cc_keyboard_shortcut_editor_close (GtkDialog *dialog)
{
CcKeyboardShortcutEditor *self = CC_KEYBOARD_SHORTCUT_EDITOR (dialog);
if (self->mode == CC_SHORTCUT_EDITOR_EDIT)
update_shortcut (self);
GTK_DIALOG_CLASS (cc_keyboard_shortcut_editor_parent_class)->close (dialog);
}
static void
cc_keyboard_shortcut_editor_response (GtkDialog *dialog,
gint response_id)
{
CcKeyboardShortcutEditor *self = CC_KEYBOARD_SHORTCUT_EDITOR (dialog);
if (response_id == GTK_RESPONSE_DELETE_EVENT &&
self->mode == CC_SHORTCUT_EDITOR_EDIT)
{
update_shortcut (self);
}
}
static void
cc_keyboard_shortcut_editor_class_init (CcKeyboardShortcutEditorClass *klass)
{
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
GtkDialogClass *dialog_class = GTK_DIALOG_CLASS (klass);
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = cc_keyboard_shortcut_editor_finalize;
object_class->get_property = cc_keyboard_shortcut_editor_get_property;
object_class->set_property = cc_keyboard_shortcut_editor_set_property;
widget_class->key_press_event = cc_keyboard_shortcut_editor_key_press_event;
dialog_class->close = cc_keyboard_shortcut_editor_close;
dialog_class->response = cc_keyboard_shortcut_editor_response;
/**
* CcKeyboardShortcutEditor:keyboard-item:
*
* The current keyboard shortcut being edited.
*/
properties[PROP_KEYBOARD_ITEM] = g_param_spec_object ("keyboard-item",
"Keyboard item",
"The keyboard item being edited",
CC_TYPE_KEYBOARD_ITEM,
G_PARAM_READWRITE);
/**
* CcKeyboardShortcutEditor:panel:
*
* The current keyboard panel.
*/
properties[PROP_PANEL] = g_param_spec_pointer ("panel",
"Keyboard panel",
"The keyboard panel being edited",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
/**
* CcKeyboardShortcutEditor:add-custom-shortcut:
*
* Emited when the user asks to add a custom shortcut.
*/
signals[ADD_CUSTOM_SHORTCUT] = g_signal_new ("add-custom-shortcut",
CC_TYPE_KEYBOARD_SHORTCUT_EDITOR,
G_SIGNAL_RUN_FIRST,
0, NULL, NULL, NULL,
G_TYPE_NONE,
1,
CC_TYPE_KEYBOARD_ITEM);
/**
* CcKeyboardShortcutEditor:remove-custom-shortcut:
*
* Emited when the user asks to remove a custom shortcut.
*/
signals[REMOVE_CUSTOM_SHORTCUT] = g_signal_new ("remove-custom-shortcut",
CC_TYPE_KEYBOARD_SHORTCUT_EDITOR,
G_SIGNAL_RUN_FIRST,
0, NULL, NULL, NULL,
G_TYPE_NONE,
1,
CC_TYPE_KEYBOARD_ITEM);
g_object_class_install_properties (object_class, N_PROPS, properties);
gtk_widget_class_set_template_from_resource (widget_class, "/org/gnome/control-center/keyboard/shortcut-editor.ui");
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, add_button);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, cancel_button);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, command_entry);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, custom_shortcut_accel_label);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, edit_button);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, headerbar);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, name_entry);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, remove_button);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, replace_button);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, shortcut_accel_label);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, stack);
gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, top_info_label);
gtk_widget_class_bind_template_callback (widget_class, add_button_clicked_cb);
gtk_widget_class_bind_template_callback (widget_class, cancel_button_clicked_cb);
gtk_widget_class_bind_template_callback (widget_class, command_entry_changed_cb);
gtk_widget_class_bind_template_callback (widget_class, edit_custom_shortcut_button_toggled_cb);
gtk_widget_class_bind_template_callback (widget_class, name_entry_changed_cb);
gtk_widget_class_bind_template_callback (widget_class, remove_button_clicked_cb);
}
static void
cc_keyboard_shortcut_editor_init (CcKeyboardShortcutEditor *self)
{
gtk_widget_init_template (GTK_WIDGET (self));
self->mode = CC_SHORTCUT_EDITOR_EDIT;
self->custom_is_modifier = TRUE;
}
/**
* cc_keyboard_shortcut_editor_new:
*
* Creates a new #CcKeyboardShortcutEditor.
*
* Returns: (transfer full): a newly created #CcKeyboardShortcutEditor.
*/
GtkWidget*
cc_keyboard_shortcut_editor_new (CcKeyboardPanel *panel)
{
return g_object_new (CC_TYPE_KEYBOARD_SHORTCUT_EDITOR,
"panel", panel,
"use-header-bar", 1,
NULL);
}
/**
* cc_keyboard_shortcut_editor_get_item:
* @self: a #CcKeyboardShortcutEditor
*
* Retrieves the current keyboard shortcut being edited.
*
* Returns: (transfer none)(nullable): a #CcKeyboardItem
*/
CcKeyboardItem*
cc_keyboard_shortcut_editor_get_item (CcKeyboardShortcutEditor *self)
{
g_return_val_if_fail (CC_IS_KEYBOARD_SHORTCUT_EDITOR (self), NULL);
return self->item;
}
/**
* cc_keyboard_shortcut_editor_set_item:
* @self: a #CcKeyboardShortcutEditor
* @item: a #CcKeyboardItem
*
* Sets the current keyboard shortcut to be edited.
*/
void
cc_keyboard_shortcut_editor_set_item (CcKeyboardShortcutEditor *self,
CcKeyboardItem *item)
{
g_return_if_fail (CC_IS_KEYBOARD_SHORTCUT_EDITOR (self));
if (!g_set_object (&self->item, item))
return;
setup_keyboard_item (self, item);
g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_KEYBOARD_ITEM]);
}
CcShortcutEditorMode
cc_keyboard_shortcut_editor_get_mode (CcKeyboardShortcutEditor *self)
{
g_return_val_if_fail (CC_IS_KEYBOARD_SHORTCUT_EDITOR (self), 0);
return self->mode;
}
void
cc_keyboard_shortcut_editor_set_mode (CcKeyboardShortcutEditor *self,
CcShortcutEditorMode mode)
{
g_return_if_fail (CC_IS_KEYBOARD_SHORTCUT_EDITOR (self));
if (self->mode == mode)
return;
self->mode = mode;
if (mode == CC_SHORTCUT_EDITOR_CREATE)
{
/* Cleanup whatever was set before */
clear_custom_entries (self);
/* The 'Add' button is only sensitive when the shortcut is valid */
gtk_widget_set_sensitive (self->add_button, FALSE);
gtk_header_bar_set_show_close_button (GTK_HEADER_BAR (self->headerbar), FALSE);
gtk_header_bar_set_title (GTK_HEADER_BAR (self->headerbar), _("Add Custom Shortcut"));
gtk_stack_set_visible_child_name (GTK_STACK (self->stack), "custom");
gtk_widget_show (self->add_button);
gtk_widget_show (self->cancel_button);
gtk_widget_hide (self->remove_button);
gtk_widget_hide (self->replace_button);
}
}