Skip to content

Unify toolbar init across backends. #22250

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.

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 26, 2022
Merged

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 17, 2022

... by instantiating classes specified by _toolbar2_class or
_toolmanager_toolbar_class. (Third-parties can still manually
instantiate their toolbars the old-fashioned way.)

Note that this would read a bit nicer if the toolbar classes were
defined before the manager classes, as this would allow _toolbar2_class
and _toolmanager_toolbar_class to be set using normal class attributes,
but moving large chunks of code around did not seem worth it. I only
did so for the macosx backend, where the moved code is very little.

This means that all toolbars default to having the standard tools added,
not just the interactive ones. See e.g. changes in
test_toolbar_zoompan: it is no longer necessary to explicitly register
all the tools (this actually now emits a duplicate tool warning).

This also moves the canonical storage of the toolbar on wx from the
frame to the manager (keeping a proxy for backcompat), for consistency
with the other backends.

PR Summary

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

... by instantiating classes specified by _toolbar2_class or
_toolmanager_toolbar_class.  (Third-parties can still manually
instantiate their toolbars the old-fashioned way.)

Note that this would read a bit nicer if the toolbar classes were
defined before the manager classes, as this would allow _toolbar2_class
and _toolmanager_toolbar_class to be set using normal class attributes,
but moving large chunks of code around did not seem worth it.  I only
did so for the macosx backend, where the moved code is very little.

This means that all toolbars default to having the standard tools added,
not just the interactive ones.  See e.g. changes in
test_toolbar_zoompan: it is no longer necessary to explicitly register
all the tools (this actually now emits a duplicate tool warning).

This also moves the canonical storage of the toolbar on wx from the
frame to the manager (keeping a proxy for backcompat), for consistency
with the other backends.
backend_tools.add_tools_to_container(self.toolbar)
if self.toolbar is not None:
self.SetToolBar(self.toolbar)
toolbar = self.canvas.manager.toolbar
Copy link
Member

Choose a reason for hiding this comment

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

Is that not?

Suggested change
toolbar = self.canvas.manager.toolbar
toolbar = self.figmgr.toolbar

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, but I have some later plans to get rid of the (non-standard) figmgr as well...

@timhoffm timhoffm merged commit 80073f6 into matplotlib:main Jan 26, 2022
@anntzer anntzer deleted the get_toolbar branch January 27, 2022 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants