Skip to content

NavigationToolbar2 refactored into NavigationBase and Toolbar2Base #1849

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

Closed
wants to merge 1 commit into from
Closed

NavigationToolbar2 refactored into NavigationBase and Toolbar2Base #1849

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
196 changes: 108 additions & 88 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1501,7 +1501,7 @@ def __init__(self, figure):
self.button_pick_id = self.mpl_connect('button_press_event', self.pick)
self.scroll_pick_id = self.mpl_connect('scroll_event', self.pick)
self.mouse_grabber = None # the axes currently grabbing mouse
self.toolbar = None # NavigationToolbar2 will set me
self.navigation = None
if False:
## highlight the artists that are hit
self.mpl_connect('motion_notify_event', self.onHilite)
Expand Down Expand Up @@ -2339,17 +2339,15 @@ def stop_event_loop_default(self):
self._looping = False


def key_press_handler(event, canvas, toolbar=None):
def key_press_handler(event, canvas, navigation):
"""
Implement the default mpl key bindings for the canvas and toolbar
described at :ref:`key-event-handling`
Implement the default mpl key bindings for the canvas described at
:ref:`key-event-handling`

*event*
a :class:`KeyEvent` instance
*canvas*
a :class:`FigureCanvasBase` instance
*toolbar*
a :class:`NavigationToolbar2` instance

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document the navigation argument.

"""
# these bindings happen whether you are over an axes or not
Expand All @@ -2374,31 +2372,30 @@ def key_press_handler(event, canvas, toolbar=None):
# toggle fullscreen mode (default key 'f')
if event.key in fullscreen_keys:
canvas.manager.full_screen_toggle()

# quit the figure (defaut key 'ctrl+w')
if event.key in quit_keys:
elif event.key in quit_keys:
Gcf.destroy_fig(canvas.figure)

if toolbar is not None:
# home or reset mnemonic (default key 'h', 'home' and 'r')
if event.key in home_keys:
toolbar.home()
# forward / backward keys to enable left handed quick navigation
# (default key for backward: 'left', 'backspace' and 'c')
elif event.key in back_keys:
toolbar.back()
# (default key for forward: 'right' and 'v')
elif event.key in forward_keys:
toolbar.forward()
# pan mnemonic (default key 'p')
elif event.key in pan_keys:
toolbar.pan()
# zoom mnemonic (default key 'o')
elif event.key in zoom_keys:
toolbar.zoom()
# saving current figure (default key 's')
elif event.key in save_keys:
toolbar.save_figure()
# home or reset mnemonic (default key 'h', 'home' and 'r')
elif event.key in home_keys:
navigation.home()
# forward / backward keys to enable left handed quick navigation
# (default key for backward: 'left', 'backspace' and 'c')
elif event.key in back_keys:
navigation.back()
# (default key for forward: 'right' and 'v')
elif event.key in forward_keys:
navigation.forward()
# pan mnemonic (default key 'p')
elif event.key in pan_keys:
navigation.pan()
# zoom mnemonic (default key 'o')
elif event.key in zoom_keys:
navigation.zoom()
# saving current figure (default key 's')
elif event.key in save_keys:
navigation.save_figure()

navigation.update_cursor(event.inaxes)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is new, is there a functional reason for this? Does it give us some new functionality?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The top part of the diff isn't actually new. The 'navigation.update_cursor' method is called so that the cursor icon updates instantly, instead of waiting until the mouse is next moved.


if event.inaxes is None:
return
Expand Down Expand Up @@ -2505,7 +2502,7 @@ def key_press(self, event):
Implement the default mpl key bindings defined at
:ref:`key-event-handling`
"""
key_press_handler(event, self.canvas, self.canvas.toolbar)
key_press_handler(event, self.canvas, self.canvas.navigation)

def show_popup(self, msg):
"""
Expand Down Expand Up @@ -2534,9 +2531,68 @@ class Cursors:
cursors = Cursors()


class NavigationToolbar2(object):
class Toolbar2Base(object):
"""
Base class for the navigation cursor, version 2
Base class for navigation toolbars, version 2

Backend specific sub-classes should define:

:meth:`_init_toolbar`
create your toolbar widget

:meth:`set_history_buttons` (optional)
you can change the history back / forward buttons to
indicate disabled / enabled state.
"""
# list of toolitems to add to the toolbar, format is:
# (
# text, # the text of the button (often not visible to users)
# tooltip_text, # the tooltip shown on hover (where possible)
# image_file, # name of the image for the button (without the extension)
# name_of_method, # name of the method in NavigationBase to call
# )
toolitems = (
('Home', 'Reset original view', 'home', 'home'),
('Back', 'Back to previous view', 'back', 'back'),
('Forward', 'Forward to next view', 'forward', 'forward'),
(None, None, None, None),
('Pan', 'Pan axes with left mouse, zoom with right', 'move', 'pan'),
('Zoom', 'Zoom to rectangle', 'zoom_to_rect', 'zoom'),
(None, None, None, None),
('Subplots', 'Configure subplots', 'subplots', 'configure_subplots'),
('Save', 'Save the figure', 'filesave', 'save_figure'),
)

def _init_toolbar(self):
"""
This is where you actually build the GUI widgets (called by
__init__). The icons ``home.xpm``, ``back.xpm``, ``forward.xpm``,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the icons comment is out of date - it can probably be nuked.

``hand.xpm``, ``zoom_to_rect.xpm`` and ``filesave.xpm`` are standard
across backends (there are ppm versions in CVS also).

You just need to set the callbacks


home : self.home
back : self.back
forward : self.forward
hand : self.pan
zoom_to_rect : self.zoom
filesave : self.save_figure

You only need to define the last one - the others are in the base
class implementation.

"""
raise NotImplementedError

def set_history_buttons(self):
"""Enable or disable back/forward button"""
pass

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're trying to follow PEP8 wherever applicable. Would you mind making this two newlines?

class NavigationBase(object):
"""
Base class for the navigation

backends must implement a canvas that handles connections for
'button_press_event' and 'button_release_event'. See
Expand All @@ -2551,9 +2607,6 @@ class NavigationToolbar2(object):
:meth:`set_cursor`
if you want the pointer icon to change

:meth:`_init_toolbar`
create your toolbar widget

:meth:`draw_rubberband` (optional)
draw the zoom to rect "rubberband" rectangle

Expand All @@ -2571,35 +2624,16 @@ class NavigationToolbar2(object):
:meth:`set_message` (optional)
display message

:meth:`set_history_buttons` (optional)
you can change the history back / forward buttons to
indicate disabled / enabled state.
:meth:`destroy` (optional)
clean up any toolbar/status bar widgets

That's it, we'll do the rest!
"""

# list of toolitems to add to the toolbar, format is:
# (
# text, # the text of the button (often not visible to users)
# tooltip_text, # the tooltip shown on hover (where possible)
# image_file, # name of the image for the button (without the extension)
# name_of_method, # name of the method in NavigationToolbar2 to call
# )
toolitems = (
('Home', 'Reset original view', 'home', 'home'),
('Back', 'Back to previous view', 'back', 'back'),
('Forward', 'Forward to next view', 'forward', 'forward'),
(None, None, None, None),
('Pan', 'Pan axes with left mouse, zoom with right', 'move', 'pan'),
('Zoom', 'Zoom to rectangle', 'zoom_to_rect', 'zoom'),
(None, None, None, None),
('Subplots', 'Configure subplots', 'subplots', 'configure_subplots'),
('Save', 'Save the figure', 'filesave', 'save_figure'),
)

def __init__(self, canvas):
def __init__(self, canvas, toolbar=None):
self.canvas = canvas
canvas.toolbar = self
canvas.navigation = self
self.toolbar = toolbar
# a dict from axes index to a list of view limits
self._views = cbook.Stack()
self._positions = cbook.Stack() # stack of subplot positions
Expand All @@ -2609,7 +2643,8 @@ def __init__(self, canvas):
self._idRelease = None
self._active = None
self._lastCursor = None
self._init_toolbar()
if self.toolbar:
self.toolbar._init_toolbar()
self._idDrag = self.canvas.mpl_connect(
'motion_notify_event', self.mouse_move)

Expand All @@ -2622,6 +2657,14 @@ def __init__(self, canvas):
self.mode = '' # a mode string for the status bar
self.set_history_buttons()

def destroy(self):
"""Destroy status and toolbar widgets."""
pass

def set_history_buttons(self):
if self.toolbar:
self.toolbar.set_history_buttons()

def set_message(self, s):
"""Display a message on toolbar or in status bar"""
pass
Expand Down Expand Up @@ -2654,30 +2697,8 @@ def home(self, *args):
self.set_history_buttons()
self._update_view()

def _init_toolbar(self):
"""
This is where you actually build the GUI widgets (called by
__init__). The icons ``home.xpm``, ``back.xpm``, ``forward.xpm``,
``hand.xpm``, ``zoom_to_rect.xpm`` and ``filesave.xpm`` are standard
across backends (there are ppm versions in CVS also).

You just need to set the callbacks

home : self.home
back : self.back
forward : self.forward
hand : self.pan
zoom_to_rect : self.zoom
filesave : self.save_figure

You only need to define the last one - the others are in the base
class implementation.

"""
raise NotImplementedError

def mouse_move(self, event):
if not event.inaxes or not self._active:
def update_cursor(self, inaxes=False):
if not inaxes or not self._active:
if self._lastCursor != cursors.POINTER:
self.set_cursor(cursors.POINTER)
self._lastCursor = cursors.POINTER
Expand All @@ -2692,6 +2713,9 @@ def mouse_move(self, event):

self._lastCursor = cursors.MOVE

def mouse_move(self, event):

self.update_cursor(event.inaxes)
if event.inaxes and event.inaxes.get_navigate():

try:
Expand Down Expand Up @@ -3092,7 +3116,3 @@ def zoom(self, *args):
a.set_navigate_mode(self._active)

self.set_message(self.mode)

def set_history_buttons(self):
"""Enable or disable back/forward button"""
pass
Loading