Commit7c400e9

authored

Merge pull request#16892 from anntzer/mouseevent-key

Warn in the docs that MouseEvent.key can be wrong.

2 parentsb26b184 +23a0b3d commit7c400e9Copy full SHA for 7c400e9

File tree

-0

lines changed

-0

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1369,6 +1369,12 @@ class MouseEvent(LocationEvent):`
`1369`	`1369`	`The key pressed when the mouse event triggered, e.g. 'shift'.`
`1370`	`1370`	See `KeyEvent`.
`1371`	`1371`
	`1372`	`+ .. warning::`
	`1373`	`+ This key is currently obtained from the last 'key_press_event' or`
	`1374`	`+ 'key_release_event' that occurred within the canvas. Thus, if the`
	`1375`	`+ last change of keyboard state occurred while the canvas did not have`
	`1376`	`+ focus, this attribute will be wrong.`
	`1377`	`+`
`1372`	`1378`	`step : int`
`1373`	`1379`	`The number of scroll steps (positive for 'up', negative for 'down').`
`1374`	`1380`	`This applies only to 'scroll_event' and defaults to 0 otherwise.`

Comments

(0)