1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# (C) Copyright 2008-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
# ------------------------------------------------------------------------------
# Copyright (c) 2007, Riverbank Computing Limited
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD license.
# However, when used with the GPL version of PyQt the additional terms
# described in the PyQt GPL exception also apply
#
# Author: Riverbank Computing Limited
# ------------------------------------------------------------------------------
""" Defines the key binding editor for use with the KeyBinding class. This is a
specialized editor used to associate a particular key with a control (i.e., the
key binding editor).
"""
from pyface.qt import QtCore, QtGui
from pyface.api import YES, confirm
from traits.api import Bool, Event
from .editor import Editor
from .key_event_to_name import key_event_to_name
class KeyBindingEditor(Editor):
"""An editor for modifying bindings of keys to controls."""
# -------------------------------------------------------------------------
# Trait definitions:
# -------------------------------------------------------------------------
#: Does the editor's control have focus currently?
has_focus = Bool(False)
#: Keyboard event
key = Event()
#: Clear field event
clear = Event()
def init(self, parent):
"""Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.control = KeyBindingCtrl(self)
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
self.control.setText(self.value)
def _key_changed(self, event):
"""Handles a keyboard event."""
binding = self.object
key_name = key_event_to_name(event)
cur_binding = self.ui.parent.handler.key_binding_for(binding, key_name)
if cur_binding is not None:
result = confirm(
parent=self.control,
message=(
f"{key_name!r} has already been assigned to "
f"'{cur_binding.description}'.\n"
"Do you wish to continue?"
),
title="Duplicate Key Definition",
)
if result != YES:
return
self.value = key_name
# Need to manually update editor because the update to the value
# won't get transferred to toolkit object due to loopback protection.
self.update_editor()
def _clear_changed(self):
"""Handles a clear field event."""
self.value = ""
# Need to manually update editor because the update to the value
# won't get transferred to toolkit object due to loopback protection.
self.update_editor()
class KeyBindingCtrl(QtGui.QLineEdit):
"""PyQt control for editing key bindings."""
def __init__(self, editor, parent=None):
super().__init__(parent)
self.setFocusPolicy(QtCore.Qt.FocusPolicy.StrongFocus)
self.setMinimumWidth(160)
self.setMaximumWidth(160)
self.setReadOnly(True)
# Save the reference to the controlling editor object:
self.editor = editor
# Indicate we don't have the focus right now:
editor.has_focus = False
def keyPressEvent(self, event):
"""Handle keyboard keys being pressed."""
# Ignore presses of the control and shift keys.
if event.key() not in (QtCore.Qt.Key.Key_Control, QtCore.Qt.Key.Key_Shift):
self.editor.key = event
def paintEvent(self, event):
"""Updates the screen."""
super().paintEvent(event)
if self.editor.has_focus:
w = self.width()
h = self.height()
p = QtGui.QPainter(self)
p.setRenderHint(QtGui.QPainter.RenderHint.Antialiasing, True)
pen = QtGui.QPen(QtGui.QColor("tomato"))
pen.setWidth(2)
p.setPen(pen)
p.drawRect(1, 1, w - 2, h - 2)
p.end()
def focusInEvent(self, event):
"""Handles getting the focus."""
self.editor.has_focus = True
self.update()
def focusOutEvent(self, event):
"""Handles losing the focus."""
self.editor.has_focus = False
self.update()
def mouseDoubleClickEvent(self, event):
"""Handles the user double clicking the control to clear its contents."""
self.editor.clear = True
|
