8000 Privatize state_modifier_keys · matplotlib/matplotlib@3a1bde9 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3a1bde9

Browse files
ericpreericpre
committed
Privatize state_modifier_keys
1 parent f4c01d0 commit 3a1bde9

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

‎doc/api/next_api_changes/deprecations/20839-EP.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Selector widget state internals
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
*state_modifier_keys* have to be defined when creating the selector widget. The
4+
*state_modifier_keys* attribute is deprecated.

‎lib/matplotlib/widgets.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1809,9 +1809,9 @@ def __init__(self, ax, onselect, useblit=False, button=None,
18091809
self.useblit = useblit and self.canvas.supports_blit
18101810
self.connect_default_events()
18111811

1812-
self.state_modifier_keys = dict(move=' ', clear='escape',
1813-
square='shift', center='control')
1814-
self.state_modifier_keys.update(state_modifier_keys or {})
1812+
self._state_modifier_keys = dict(move=' ', clear='escape',
1813+
square='shift', center='control')
1814+
self._state_modifier_keys.update(state_modifier_keys or {})
18151815

18161816
self.background = None
18171817

@@ -1834,6 +1834,7 @@ def __init__(self, ax, onselect, useblit=False, button=None,
18341834
eventpress = _api.deprecate_privatize_attribute("3.5")
18351835
eventrelease = _api.deprecate_privatize_attribute("3.5")
18361836
state = _api.deprecate_privatize_attribute("3.5")
1837+
state_modifier_keys = _api.deprecate_privatize_attribute("3.5")
18371838

18381839
def set_active(self, active):
18391840
super().set_active(active)
@@ -1944,7 +1945,7 @@ def press(self, event):
19441945
key = event.key or ''
19451946
key = key.replace('ctrl', 'control')
19461947
# move state is locked in on a button press
1947-
if key == self.state_modifier_keys['move']:
1948+
if key == self._state_modifier_keys['move']:
19481949
self._state.add('move')
19491950
self._press(event)
19501951
return True
@@ -1992,10 +1993,10 @@ def on_key_press(self, event):
19921993
if self.active:
19931994
key = event.key or ''
19941995
key = key.replace('ctrl', 'control')
1995-
if key == self.state_modifier_keys['clear']:
1996+
if key == self._state_modifier_keys['clear']:
19961997
self.clear()
19971998
return
1998-
for (state, modifier) in self.state_modifier_keys.items():
1999+
for (state, modifier) in self._state_modifier_keys.items():
19992000
if modifier in key:
20002001
self._state.add(state)
20012002
self._on_key_press(event)
@@ -2007,7 +2008,7 @@ def on_key_release(self, event):
20072008
"""Key release event handler and validator."""
20082009
if self.active:
20092010
key = event.key or ''
2010-
for (state, modifier) in self.state_modifier_keys.items():
2011+
for (state, modifier) in self._state_modifier_keys.items():
20112012
if modifier in key:
20122013
self._state.discard(state)
20132014
self._on_key_release(event)
@@ -2088,7 +2089,7 @@ def add_default_state(self, value):
20882089
20892090
"""
20902091
supported_default_state = [
2091-
key for key, value in self.state_modifier_keys.items()
2092+
key for key, value in self._state_modifier_keys.items()
20922093
if key != 'clear' and value != 'not-applicable'
20932094
]
20942095
if value not in supported_default_state:
@@ -3635,13 +3636,13 @@ def _on_key_release(self, event):
36353636
# 'move_all' mode (by checking the released key)
36363637
if (not self._selection_completed
36373638
and
3638-
(event.key == self.state_modifier_keys.get('move_vertex')
3639-
or event.key == self.state_modifier_keys.get('move_all'))):
3639+
(event.key == self._state_modifier_keys.get('move_vertex')
3640+
or event.key == self._state_modifier_keys.get('move_all'))):
36403641
self._xs.append(event.xdata)
36413642
self._ys.append(event.ydata)
36423643
self._draw_polygon()
36433644
# Reset the polygon if the released key is the 'clear' key.
3644-
elif event.key == self.state_modifier_keys.get('clear'):
3645+
elif event.key == self._state_modifier_keys.get('clear'):
36453646
event = self._clean_event(event)
36463647
self._xs, self._ys = [event.xdata], [event.ydata]
36473648
self._selection_completed = False

0 commit comments

Comments
 (0)
0