Skip to content

Commit 542f325

Browse files
QuLogicQuLogic
committed
DOC: Make event handling table scrollable
The existing table is too wide, and overflow is clipped, so that not all toolkits are visible. Also, wrap all the entered keys in `:kbd:`, and re-sort the columns. Fixes matplotlib#24741
1 parent a9ba9d5 commit 542f325

File tree

2 files changed

+130
-19
lines changed

2 files changed

+130
-19
lines changed

‎doc/_static/mpl.css‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,15 @@ div.graphviz {
109109
img.graphviz.inheritance {
110110
max-width: none;
111111
}
112+
113+
/* Make tables in notes horizontally scrollable if too large. */
114+
div.wide-table {
115+
overflow-x: auto;
116+
}
117+
118+
div.wide-table table th.stub {
119+
background-color: var(--pst-color-background);
120+
background-clip: padding-box;
121+
left: 0;
122+
position: sticky;
123+
}

‎doc/users/explain/event_handling.rst‎

Lines changed: 118 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -85,25 +85,124 @@ Event name Class Description
8585
what you may expect to receive as key(s) (using a QWERTY keyboard layout)
8686
from the different user interface toolkits, where a comma separates different keys:
8787

88-
================ ============================= ============================== ============================== ============================== ============================== ===================================
89-
Key(s) Pressed WxPython Qt WebAgg Gtk Tkinter macosx
90-
================ ============================= ============================== ============================== ============================== ============================== ===================================
91-
Shift+2 shift, shift+2 shift, @ shift, @ shift, @ shift, @ shift, @
92-
Shift+F1 shift, shift+f1 shift, shift+f1 shift, shift+f1 shift, shift+f1 shift, shift+f1 shift, shift+f1
93-
Shift shift shift shift shift shift shift
94-
Control control control control control control control
95-
Alt alt alt alt alt alt alt
96-
AltGr Nothing Nothing alt iso_level3_shift iso_level3_shift
97-
CapsLock caps_lock caps_lock caps_lock caps_lock caps_lock caps_lock
98-
CapsLock+a caps_lock, a caps_lock, a caps_lock, A caps_lock, A caps_lock, A caps_lock, a
99-
a a a a a a a
100-
Shift+a shift, A shift, A shift, A shift, A shift, A shift, A
101-
CapsLock+Shift+a caps_lock, shift, A caps_lock, shift, A caps_lock, shift, a caps_lock, shift, a caps_lock, shift, a caps_lock, shift, A
102-
Ctrl+Shift+Alt control, ctrl+shift, ctrl+alt control, ctrl+shift, ctrl+meta control, ctrl+shift, ctrl+meta control, ctrl+shift, ctrl+meta control, ctrl+shift, ctrl+meta control, ctrl+shift, ctrl+alt+shift
103-
Ctrl+Shift+a control, ctrl+shift, ctrl+A control, ctrl+shift, ctrl+A control, ctrl+shift, ctrl+A control, ctrl+shift, ctrl+A control, ctrl+shift, ctrl+a control, ctrl+shift, ctrl+A
104-
F1 f1 f1 f1 f1 f1 f1
105-
Ctrl+F1 control, ctrl+f1 control, ctrl+f1 control, ctrl+f1 control, ctrl+f1 control, ctrl+f1 control, Nothing
106-
================ ============================= ============================== ============================== ============================== ============================== ===================================
88+
.. container:: wide-table
89+
90+
.. list-table::
91+
:header-rows: 1
92+
:stub-columns: 1
93+
94+
* - Key(s) Pressed
95+
- Tkinter
96+
- Qt
97+
- macosx
98+
- WebAgg
99+
- GTK
100+
- WxPython
101+
* - :kbd:`Shift+2`
102+
- shift, @
103+
- shift, @
104+
- shift, @
105+
- shift, @
106+
- shift, @
107+
- shift, shift+2
108+
* - :kbd:`Shift+F1`
109+
- shift, shift+f1
110+
- shift, shift+f1
111+
- shift, shift+f1
112+
- shift, shift+f1
113+
- shift, shift+f1
114+
- shift, shift+f1
115+
* - :kbd:`Shift`
116+
- shift
117+
- shift
118+
- shift
119+
- shift
120+
- shift
121+
- shift
122+
* - :kbd:`Control`
123+
- control
124+
- control
125+
- control
126+
- control
127+
- control
128+
- control
129+
* - :kbd:`Alt`
130+
- alt
131+
- alt
132+
- alt
133+
- alt
134+
- alt
135+
- alt
136+
* - :kbd:`AltGr`
137+
- iso_level3_shift
138+
- *nothing*
139+
-
140+
- alt
141+
- iso_level3_shift
142+
- *nothing*
143+
* - :kbd:`CapsLock`
144+
- caps_lock
145+
- caps_lock
146+
- caps_lock
147+
- caps_lock
148+
- caps_lock
149+
- caps_lock
150+
* - :kbd:`CapsLock+a`
151+
- caps_lock, A
152+
- caps_lock, a
153+
- caps_lock, a
154+
- caps_lock, A
155+
- caps_lock, A
156+
- caps_lock, a
157+
* - :kbd:`a`
158+
- a
159+
- a
160+
- a
161+
- a
162+
- a
163+
- a
164+
* - :kbd:`Shift+a`
165+
- shift, A
166+
- shift, A
167+
- shift, A
168+
- shift, A
169+
- shift, A
170+
- shift, A
171+
* - :kbd:`CapsLock+Shift+a`
172+
- caps_lock, shift, a
173+
- caps_lock, shift, A
174+
- caps_lock, shift, A
175+
- caps_lock, shift, a
176+
- caps_lock, shift, a
177+
- caps_lock, shift, A
178+
* - :kbd:`Ctrl+Shift+Alt`
179+
- control, ctrl+shift, ctrl+meta
180+
- control, ctrl+shift, ctrl+meta
181+
- control, ctrl+shift, ctrl+alt+shift
182+
- control, ctrl+shift, ctrl+meta
183+
- control, ctrl+shift, ctrl+meta
184+
- control, ctrl+shift, ctrl+alt
185+
* - :kbd:`Ctrl+Shift+a`
186+
- control, ctrl+shift, ctrl+a
187+
- control, ctrl+shift, ctrl+A
188+
- control, ctrl+shift, ctrl+A
189+
- control, ctrl+shift, ctrl+A
190+
- control, ctrl+shift, ctrl+A
191+
- control, ctrl+shift, ctrl+A
192+
* - :kbd:`F1`
193+
- f1
194+
- f1
195+
- f1
196+
- f1
197+
- f1
198+
- f1
199+
* - :kbd:`Ctrl+F1`
200+
- control, ctrl+f1
201+
- control, ctrl+f1
202+
- control, *nothing*
203+
- control, ctrl+f1
204+
- control, ctrl+f1
205+
- control, ctrl+f1
107206

108207
Matplotlib attaches some keypress callbacks by default for interactivity; they
109208
are documented in the :ref:`key-event-handling` section.

0 commit comments

Comments
 (0)