NavigationToolbar2Tk: make packing optional.

jmehne · jmehne · commit 4419b1873a41 · 2019-09-16T22:21:58.000+02:00
Currently, the toolbar cannot be easily used with Tk's grid layout
manager, because it is already packed during initialization. Thus, it is
necessary to manually call `pack_forget` on the toolbar.

Add a parameter, that makes this a bit easier to discover.
diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -507,16 +507,22 @@ class NavigationToolbar2Tk(NavigationToolbar2, tk.Frame):
     Attributes
     ----------
     canvas : `FigureCanvas`
-        the figure canvas on which to operate
+        The figure canvas on which to operate.
     win : tk.Window
-        the tk.Window which owns this toolbar
-
+        The tk.Window which owns this toolbar.
+    pack_toolbar : bool, optional
+        If True, add the toolbar to the parent's pack manager's packing list
+        during initialization with *side='bottom'* and *fill='x'*.
+        If you want to use the toolbar with a different layout manager, use
+        *pack_toolbar=False*.
+        Default: True
     """
-    def __init__(self, canvas, window):
+    def __init__(self, canvas, window, pack_toolbar=True):
         self.canvas = canvas
         # Avoid using self.window (prefer self.canvas.get_tk_widget().master),
         # so that Tool implementations can reuse the methods.
         self.window = window
+        self.pack_toolbar = pack_toolbar
         NavigationToolbar2.__init__(self, canvas)
 
     def destroy(self, *args):
@@ -582,7 +588,8 @@ def _init_toolbar(self):
         self.message = tk.StringVar(master=self)
         self._message_label = tk.Label(master=self, textvariable=self.message)
         self._message_label.pack(side=tk.RIGHT)
-        self.pack(side=tk.BOTTOM, fill=tk.X)
+        if self.pack_toolbar:
+            self.pack(side=tk.BOTTOM, fill=tk.X)
 
     def configure_subplots(self):
         toolfig = Figure(figsize=(6, 3))
