Skip to content

Backport PR #22077 on branch v3.5.x (Fix keyboard event routing in Tk backend (fixes #13484, #14081, and #22028)) #22322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2022
Merged

Backport PR #22077 on branch v3.5.x (Fix keyboard event routing in Tk backend (fixes #13484, #14081, and #22028)) #22322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/matplotlib/backends/_backend_tk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,9 @@ def enter_notify_event(self, event):
guiEvent=event, xy=self._event_mpl_coords(event))

def button_press_event(self, event, dblclick=False):
# set focus to the canvas so that it can receive keyboard events
self._tkcanvas.focus_set()

num = getattr(event, 'num', None)
if sys.platform == 'darwin': # 2 and 3 are reversed.
num = {2: 3, 3: 2}.get(num, num)
Expand Down Expand Up @@ -473,6 +476,7 @@ def destroy(*args):
Gcf.destroy(self)
self.window.protocol("WM_DELETE_WINDOW", destroy)
self.window.deiconify()
self.canvas._tkcanvas.focus_set()
else:
self.canvas.draw_idle()
if mpl.rcParams['figure.raise_window']:
Expand Down
30 changes: 30 additions & 0 deletions lib/matplotlib/tests/test_backend_tk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,3 +185,33 @@ class Toolbar(NavigationToolbar2Tk):
print("success")
Toolbar(fig.canvas, fig.canvas.manager.window) # This should not raise.
print("success")


@pytest.mark.backend('TkAgg', skip_on_importerror=True)
@_isolated_tk_test(success_count=1)
def test_canvas_focus(): # pragma: no cover
import tkinter as tk
import matplotlib.pyplot as plt
success = []

def check_focus():
tkcanvas = fig.canvas.get_tk_widget()
# Give the plot window time to appear
if not tkcanvas.winfo_viewable():
tkcanvas.wait_visibility()
# Make sure the canvas has the focus, so that it's able to receive
# keyboard events.
if tkcanvas.focus_lastfor() == tkcanvas:
success.append(True)
plt.close()
root.destroy()

root = tk.Tk()
fig = plt.figure()
plt.plot([1, 2, 3])
root.after(0, plt.show)
root.after(100, check_focus)
root.mainloop()

if success:
print("success")