class ShortcutEditor(QDialog):
"""A dialog for entering key sequences."""
def __init__(self, parent, context, name, sequence, shortcuts):
super(ShortcutEditor, self).__init__(parent)
self._parent = parent
self.context = context
self.npressed = 0
self.keys = set()
self.key_modifiers = set()
self.key_non_modifiers = list()
self.key_text = list()
self.sequence = sequence
self.new_sequence = None
self.edit_state = True
self.shortcuts = shortcuts
# Widgets
self.label_info = QLabel()
self.label_info.setText(
_("Press the new shortcut and select 'Ok': \n"
"(Press 'Tab' once to switch focus between the shortcut entry \n"
"and the buttons below it)"))
self.label_current_sequence = QLabel(_("Current shortcut:"))
self.text_current_sequence = QLabel(sequence)
self.label_new_sequence = QLabel(_("New shortcut:"))
self.text_new_sequence = CustomLineEdit(self)
self.text_new_sequence.setPlaceholderText(sequence)
self.helper_button = HelperToolButton()
self.helper_button.hide()
self.label_warning = QLabel()
self.label_warning.hide()
bbox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
self.button_ok = bbox.button(QDialogButtonBox.Ok)
self.button_cancel = bbox.button(QDialogButtonBox.Cancel)
# Setup widgets
self.setWindowTitle(_('Shortcut: {0}').format(name))
self.button_ok.setFocusPolicy(Qt.NoFocus)
self.button_ok.setEnabled(False)
self.button_cancel.setFocusPolicy(Qt.NoFocus)
self.helper_button.setToolTip('')
self.helper_button.setFocusPolicy(Qt.NoFocus)
style = """
QToolButton {
margin:1px;
border: 0px solid grey;
padding:0px;
border-radius: 0px;
}"""
self.helper_button.setStyleSheet(style)
self.text_new_sequence.setFocusPolicy(Qt.NoFocus)
self.label_warning.setFocusPolicy(Qt.NoFocus)
# Layout
spacing = 5
layout_sequence = QGridLayout()
layout_sequence.addWidget(self.label_info, 0, 0, 1, 3)
layout_sequence.addItem(QSpacerItem(spacing, spacing), 1, 0, 1, 2)
layout_sequence.addWidget(self.label_current_sequence, 2, 0)
layout_sequence.addWidget(self.text_current_sequence, 2, 2)
layout_sequence.addWidget(self.label_new_sequence, 3, 0)
layout_sequence.addWidget(self.helper_button, 3, 1)
layout_sequence.addWidget(self.text_new_sequence, 3, 2)
layout_sequence.addWidget(self.label_warning, 4, 2, 1, 2)
layout = QVBoxLayout()
layout.addLayout(layout_sequence)
layout.addSpacing(spacing)
layout.addWidget(bbox)
self.setLayout(layout)
# Signals
bbox.accepted.connect(self.accept)
bbox.rejected.connect(self.reject)
def keyPressEvent(self, e):
"""Qt override."""
key = e.key()
# Check if valid keys
if key not in VALID_KEYS:
self.invalid_key_flag = True
return
self.npressed += 1
self.key_non_modifiers.append(key)
self.key_modifiers.add(key)
self.key_text.append(e.text())
self.invalid_key_flag = False
debug_print('key {0}, npressed: {1}'.format(key, self.npressed))
if key == Qt.Key_unknown:
return
# The user clicked just and only the special keys
# Ctrl, Shift, Alt, Meta.
if (key == Qt.Key_Control or key == Qt.Key_Shift or key == Qt.Key_Alt
or key == Qt.Key_Meta):
return
modifiers = e.modifiers()
if modifiers & Qt.ShiftModifier:
key += Qt.SHIFT
if modifiers & Qt.ControlModifier:
key += Qt.CTRL
if sys.platform == 'darwin':
self.npressed -= 1
debug_print('decrementing')
if modifiers & Qt.AltModifier:
key += Qt.ALT
if modifiers & Qt.MetaModifier:
key += Qt.META
self.keys.add(key)
def toggle_state(self):
"""Switch between shortcut entry and Accept/Cancel shortcut mode."""
self.edit_state = not self.edit_state
if not self.edit_state:
self.text_new_sequence.setEnabled(False)
if self.button_ok.isEnabled():
self.button_ok.setFocus()
else:
self.button_cancel.setFocus()
else:
self.text_new_sequence.setEnabled(True)
self.text_new_sequence.setFocus()
def nonedit_keyrelease(self, e):
"""Key release event for non-edit state."""
key = e.key()
if key in [Qt.Key_Escape]:
self.close()
return
if key in [Qt.Key_Left, Qt.Key_Right, Qt.Key_Up, Qt.Key_Down]:
if self.button_ok.hasFocus():
self.button_cancel.setFocus()
else:
self.button_ok.setFocus()
def keyReleaseEvent(self, e):
"""Qt override."""
self.npressed -= 1
if self.npressed <= 0:
key = e.key()
if len(self.keys) == 1 and key == Qt.Key_Tab:
self.toggle_state()
return
if len(self.keys) == 1 and key == Qt.Key_Escape:
self.set_sequence('')
self.label_warning.setText(
_("Please introduce a different "
"shortcut"))
if len(self.keys) == 1 and key in [Qt.Key_Return, Qt.Key_Enter]:
self.toggle_state()
return
if not self.edit_state:
self.nonedit_keyrelease(e)
else:
debug_print('keys: {}'.format(self.keys))
if self.keys and key != Qt.Key_Escape:
self.validate_sequence()
self.keys = set()
self.key_modifiers = set()
self.key_non_modifiers = list()
self.key_text = list()
self.npressed = 0
def check_conflicts(self):
"""Check shortcuts for conflicts."""
conflicts = []
for index, shortcut in enumerate(self.shortcuts):
sequence = str(shortcut.key)
if sequence == self.new_sequence and \
(shortcut.context == self.context or shortcut.context == '_' or
self.context == '_'):
conflicts.append(shortcut)
return conflicts
def update_warning(self, warning_type=NO_WARNING, conflicts=[]):
"""Update warning label to reflect conflict status of new shortcut"""
if warning_type == NO_WARNING:
warn = False
tip = 'This shortcut is correct!'
elif warning_type == SEQUENCE_CONFLICT:
template = '<i>{0}<b>{1}</b></i>'
tip_title = _('The new shorcut conflicts with:') + '<br>'
tip_body = ''
for s in conflicts:
tip_body += ' - {0}: {1}<br>'.format(s.context, s.name)
tip_body = tip_body[:-4] # Removing last <br>
tip = template.format(tip_title, tip_body)
warn = True
elif warning_type == IN_BLACKLIST:
template = '<i>{0}<b>{1}</b></i>'
tip_title = _('Forbidden key sequence!') + '<br>'
tip_body = ''
use = BLACKLIST[self.new_sequence]
if use is not None:
tip_body = use
tip = template.format(tip_title, tip_body)
warn = True
elif warning_type == SHIFT_BLACKLIST:
template = '<i>{0}<b>{1}</b></i>'
tip_title = _('Forbidden key sequence!') + '<br>'
tip_body = ''
use = BLACKLIST['Shift']
if use is not None:
tip_body = use
tip = template.format(tip_title, tip_body)
warn = True
elif warning_type == SEQUENCE_LENGTH:
# Sequences with 5 keysequences (i.e. Ctrl+1, Ctrl+2, Ctrl+3,
# Ctrl+4, Ctrl+5) are invalid
template = '<i>{0}</i>'
tip = _('A compound sequence can have {break} a maximum of '
'4 subsequences.{break}').format(**{'break': '<br>'})
warn = True
elif warning_type == INVALID_KEY:
template = '<i>{0}</i>'
tip = _('Invalid key entered') + '<br>'
warn = True
self.helper_button.show()
if warn:
self.label_warning.show()
self.helper_button.setIcon(get_std_icon('MessageBoxWarning'))
self.button_ok.setEnabled(False)
else:
self.helper_button.setIcon(get_std_icon('DialogApplyButton'))
self.label_warning.setText(tip)
def set_sequence(self, sequence):
"""Set the new shortcut and update buttons."""
if not sequence or self.sequence == sequence:
self.button_ok.setEnabled(False)
different_sequence = False
else:
self.button_ok.setEnabled(True)
different_sequence = True
if sys.platform == 'darwin':
if 'Meta+Ctrl' in sequence:
shown_sequence = sequence.replace('Meta+Ctrl', 'Ctrl+Cmd')
elif 'Ctrl+Meta' in sequence:
shown_sequence = sequence.replace('Ctrl+Meta', 'Cmd+Ctrl')
elif 'Ctrl' in sequence:
shown_sequence = sequence.replace('Ctrl', 'Cmd')
elif 'Meta' in sequence:
shown_sequence = sequence.replace('Meta', 'Ctrl')
else:
shown_sequence = sequence
else:
shown_sequence = sequence
self.text_new_sequence.setText(shown_sequence)
self.new_sequence = sequence
conflicts = self.check_conflicts()
blacklist = self.new_sequence in BLACKLIST
individual_keys = self.new_sequence.split('+')
if conflicts and different_sequence:
warning_type = SEQUENCE_CONFLICT
elif blacklist:
warning_type = IN_BLACKLIST
elif len(individual_keys) == 2 and individual_keys[0] == 'Shift':
warning_type = SHIFT_BLACKLIST
else:
warning_type = NO_WARNING
self.update_warning(warning_type=warning_type, conflicts=conflicts)
def validate_sequence(self):
"""Provide additional checks for accepting or rejecting shortcuts."""
if self.invalid_key_flag:
self.update_warning(warning_type=INVALID_KEY)
return
for mod in MODIFIERS:
non_mod = set(self.key_non_modifiers)
non_mod.discard(mod)
if mod in self.key_non_modifiers:
self.key_non_modifiers.remove(mod)
self.key_modifiers = self.key_modifiers - non_mod
while u'' in self.key_text:
self.key_text.remove(u'')
self.key_text = [k.upper() for k in self.key_text]
# Fix Backtab, Tab issue
if os.name == 'nt':
if Qt.Key_Backtab in self.key_non_modifiers:
idx = self.key_non_modifiers.index(Qt.Key_Backtab)
self.key_non_modifiers[idx] = Qt.Key_Tab
if len(self.key_modifiers) == 0:
# Filter single key allowed
if self.key_non_modifiers[0] not in VALID_SINGLE_KEYS:
return
# Filter
elif len(self.key_non_modifiers) > 1:
return
# QKeySequence accepts a maximum of 4 different sequences
if len(self.keys) > 4:
# Update warning
self.update_warning(warning_type=SEQUENCE_LENGTH)
return
keys = []
for i in range(len(self.keys)):
key_seq = 0
for m in self.key_modifiers:
key_seq += MODIFIERS[m]
key_seq += self.key_non_modifiers[i]
keys.append(key_seq)
sequence = QKeySequence(*keys)
self.set_sequence(sequence.toString())
class ShortcutEditor(QDialog):
"""A dialog for entering key sequences."""
def __init__(self, parent, context, name, sequence, shortcuts):
super(ShortcutEditor, self).__init__(parent)
self._parent = parent
self.context = context
self.npressed = 0
self.keys = set()
self.key_modifiers = set()
self.key_non_modifiers = list()
self.key_text = list()
self.sequence = sequence
self.new_sequence = None
self.edit_state = True
self.shortcuts = shortcuts
# Widgets
self.label_info = QLabel()
self.label_info.setText(_("Press the new shortcut and select 'Ok': \n"
"(Press 'Tab' once to switch focus between the shortcut entry \n"
"and the buttons below it)"))
self.label_current_sequence = QLabel(_("Current shortcut:"))
self.text_current_sequence = QLabel(sequence)
self.label_new_sequence = QLabel(_("New shortcut:"))
self.text_new_sequence = CustomLineEdit(self)
self.text_new_sequence.setPlaceholderText(sequence)
self.helper_button = HelperToolButton()
self.helper_button.hide()
self.label_warning = QLabel()
self.label_warning.hide()
bbox = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
self.button_ok = bbox.button(QDialogButtonBox.Ok)
self.button_cancel = bbox.button(QDialogButtonBox.Cancel)
# Setup widgets
self.setWindowTitle(_('Shortcut: {0}').format(name))
self.button_ok.setFocusPolicy(Qt.NoFocus)
self.button_ok.setEnabled(False)
self.button_cancel.setFocusPolicy(Qt.NoFocus)
self.helper_button.setToolTip('')
self.helper_button.setFocusPolicy(Qt.NoFocus)
style = """
QToolButton {
margin:1px;
border: 0px solid grey;
padding:0px;
border-radius: 0px;
}"""
self.helper_button.setStyleSheet(style)
self.text_new_sequence.setFocusPolicy(Qt.NoFocus)
self.label_warning.setFocusPolicy(Qt.NoFocus)
# Layout
spacing = 5
layout_sequence = QGridLayout()
layout_sequence.addWidget(self.label_info, 0, 0, 1, 3)
layout_sequence.addItem(QSpacerItem(spacing, spacing), 1, 0, 1, 2)
layout_sequence.addWidget(self.label_current_sequence, 2, 0)
layout_sequence.addWidget(self.text_current_sequence, 2, 2)
layout_sequence.addWidget(self.label_new_sequence, 3, 0)
layout_sequence.addWidget(self.helper_button, 3, 1)
layout_sequence.addWidget(self.text_new_sequence, 3, 2)
layout_sequence.addWidget(self.label_warning, 4, 2, 1, 2)
layout = QVBoxLayout()
layout.addLayout(layout_sequence)
layout.addSpacing(spacing)
layout.addWidget(bbox)
self.setLayout(layout)
# Signals
bbox.accepted.connect(self.accept)
bbox.rejected.connect(self.reject)
@Slot()
def reject(self):
"""Slot for rejected signal."""
# Added for issue #5426. Due to the focusPolicy of Qt.NoFocus for the
# buttons, if the cancel button was clicked without first setting focus
# to the button, it would cause a seg fault crash.
self.button_cancel.setFocus()
super(ShortcutEditor, self).reject()
@Slot()
def accept(self):
"""Slot for accepted signal."""
# Added for issue #5426. Due to the focusPolicy of Qt.NoFocus for the
# buttons, if the ok button was clicked without first setting focus to
# the button, it would cause a seg fault crash.
self.button_ok.setFocus()
super(ShortcutEditor, self).accept()
def keyPressEvent(self, e):
"""Qt override."""
key = e.key()
# Check if valid keys
if key not in VALID_KEYS:
self.invalid_key_flag = True
return
self.npressed += 1
self.key_non_modifiers.append(key)
self.key_modifiers.add(key)
self.key_text.append(e.text())
self.invalid_key_flag = False
debug_print('key {0}, npressed: {1}'.format(key, self.npressed))
if key == Qt.Key_unknown:
return
# The user clicked just and only the special keys
# Ctrl, Shift, Alt, Meta.
if (key == Qt.Key_Control or
key == Qt.Key_Shift or
key == Qt.Key_Alt or
key == Qt.Key_Meta):
return
modifiers = e.modifiers()
if modifiers & Qt.ShiftModifier:
key += Qt.SHIFT
if modifiers & Qt.ControlModifier:
key += Qt.CTRL
if sys.platform == 'darwin':
self.npressed -= 1
debug_print('decrementing')
if modifiers & Qt.AltModifier:
key += Qt.ALT
if modifiers & Qt.MetaModifier:
key += Qt.META
self.keys.add(key)
def toggle_state(self):
"""Switch between shortcut entry and Accept/Cancel shortcut mode."""
self.edit_state = not self.edit_state
if not self.edit_state:
self.text_new_sequence.setEnabled(False)
if self.button_ok.isEnabled():
self.button_ok.setFocus()
else:
self.button_cancel.setFocus()
else:
self.text_new_sequence.setEnabled(True)
self.text_new_sequence.setFocus()
def nonedit_keyrelease(self, e):
"""Key release event for non-edit state."""
key = e.key()
if key in [Qt.Key_Escape]:
self.close()
return
if key in [Qt.Key_Left, Qt.Key_Right, Qt.Key_Up,
Qt.Key_Down]:
if self.button_ok.hasFocus():
self.button_cancel.setFocus()
else:
self.button_ok.setFocus()
def keyReleaseEvent(self, e):
"""Qt override."""
self.npressed -= 1
if self.npressed <= 0:
key = e.key()
if len(self.keys) == 1 and key == Qt.Key_Tab:
self.toggle_state()
return
if len(self.keys) == 1 and key == Qt.Key_Escape:
self.set_sequence('')
self.label_warning.setText(_("Please introduce a different "
"shortcut"))
if len(self.keys) == 1 and key in [Qt.Key_Return, Qt.Key_Enter]:
self.toggle_state()
return
if not self.edit_state:
self.nonedit_keyrelease(e)
else:
debug_print('keys: {}'.format(self.keys))
if self.keys and key != Qt.Key_Escape:
self.validate_sequence()
self.keys = set()
self.key_modifiers = set()
self.key_non_modifiers = list()
self.key_text = list()
self.npressed = 0
def check_conflicts(self):
"""Check shortcuts for conflicts."""
conflicts = []
for index, shortcut in enumerate(self.shortcuts):
sequence = str(shortcut.key)
if sequence == self.new_sequence and \
(shortcut.context == self.context or shortcut.context == '_' or
self.context == '_'):
conflicts.append(shortcut)
return conflicts
def update_warning(self, warning_type=NO_WARNING, conflicts=[]):
"""Update warning label to reflect conflict status of new shortcut"""
if warning_type == NO_WARNING:
warn = False
tip = 'This shortcut is correct!'
elif warning_type == SEQUENCE_CONFLICT:
template = '<i>{0}<b>{1}</b></i>'
tip_title = _('The new shortcut conflicts with:') + '<br>'
tip_body = ''
for s in conflicts:
tip_body += ' - {0}: {1}<br>'.format(s.context, s.name)
tip_body = tip_body[:-4] # Removing last <br>
tip = template.format(tip_title, tip_body)
warn = True
elif warning_type == IN_BLACKLIST:
template = '<i>{0}<b>{1}</b></i>'
tip_title = _('Forbidden key sequence!') + '<br>'
tip_body = ''
use = BLACKLIST[self.new_sequence]
if use is not None:
tip_body = use
tip = template.format(tip_title, tip_body)
warn = True
elif warning_type == SHIFT_BLACKLIST:
template = '<i>{0}<b>{1}</b></i>'
tip_title = _('Forbidden key sequence!') + '<br>'
tip_body = ''
use = BLACKLIST['Shift']
if use is not None:
tip_body = use
tip = template.format(tip_title, tip_body)
warn = True
elif warning_type == SEQUENCE_LENGTH:
# Sequences with 5 keysequences (i.e. Ctrl+1, Ctrl+2, Ctrl+3,
# Ctrl+4, Ctrl+5) are invalid
template = '<i>{0}</i>'
tip = _('A compound sequence can have {break} a maximum of '
'4 subsequences.{break}').format(**{'break': '<br>'})
warn = True
elif warning_type == INVALID_KEY:
template = '<i>{0}</i>'
tip = _('Invalid key entered') + '<br>'
warn = True
self.helper_button.show()
if warn:
self.label_warning.show()
self.helper_button.setIcon(get_std_icon('MessageBoxWarning'))
self.button_ok.setEnabled(False)
else:
self.helper_button.setIcon(get_std_icon('DialogApplyButton'))
self.label_warning.setText(tip)
def set_sequence(self, sequence):
"""Set the new shortcut and update buttons."""
if not sequence or self.sequence == sequence:
self.button_ok.setEnabled(False)
different_sequence = False
else:
self.button_ok.setEnabled(True)
different_sequence = True
if sys.platform == 'darwin':
if 'Meta+Ctrl' in sequence:
shown_sequence = sequence.replace('Meta+Ctrl', 'Ctrl+Cmd')
elif 'Ctrl+Meta' in sequence:
shown_sequence = sequence.replace('Ctrl+Meta', 'Cmd+Ctrl')
elif 'Ctrl' in sequence:
shown_sequence = sequence.replace('Ctrl', 'Cmd')
elif 'Meta' in sequence:
shown_sequence = sequence.replace('Meta', 'Ctrl')
else:
shown_sequence = sequence
else:
shown_sequence = sequence
self.text_new_sequence.setText(shown_sequence)
self.new_sequence = sequence
conflicts = self.check_conflicts()
blacklist = self.new_sequence in BLACKLIST
individual_keys = self.new_sequence.split('+')
if conflicts and different_sequence:
warning_type = SEQUENCE_CONFLICT
elif blacklist:
warning_type = IN_BLACKLIST
elif len(individual_keys) == 2 and individual_keys[0] == 'Shift':
warning_type = SHIFT_BLACKLIST
else:
warning_type = NO_WARNING
self.update_warning(warning_type=warning_type, conflicts=conflicts)
def validate_sequence(self):
"""Provide additional checks for accepting or rejecting shortcuts."""
if self.invalid_key_flag:
self.update_warning(warning_type=INVALID_KEY)
return
for mod in MODIFIERS:
non_mod = set(self.key_non_modifiers)
non_mod.discard(mod)
if mod in self.key_non_modifiers:
self.key_non_modifiers.remove(mod)
self.key_modifiers = self.key_modifiers - non_mod
while u'' in self.key_text:
self.key_text.remove(u'')
self.key_text = [k.upper() for k in self.key_text]
# Fix Backtab, Tab issue
if Qt.Key_Backtab in self.key_non_modifiers:
idx = self.key_non_modifiers.index(Qt.Key_Backtab)
self.key_non_modifiers[idx] = Qt.Key_Tab
if len(self.key_modifiers) == 0:
# Filter single key allowed
if self.key_non_modifiers[0] not in VALID_SINGLE_KEYS:
return
# Filter
elif len(self.key_non_modifiers) > 1:
return
# QKeySequence accepts a maximum of 4 different sequences
if len(self.keys) > 4:
# Update warning
self.update_warning(warning_type=SEQUENCE_LENGTH)
return
keys = []
for i in range(len(self.keys)):
key_seq = 0
for m in self.key_modifiers:
key_seq += MODIFIERS[m]
key_seq += self.key_non_modifiers[i]
keys.append(key_seq)
sequence = QKeySequence(*keys)
self.set_sequence(sequence.toString())
