Merge pull request #20744 from QuLogic/cursor-example

timhoffm · web-flow · commit 0cf55c108f29 · 2021-07-29T09:33:44.000+02:00
Add an example showing alternate mouse cursors.
diff --git a/examples/widgets/mouse_cursor.py b/examples/widgets/mouse_cursor.py
@@ -0,0 +1,46 @@
+"""
+============
+Mouse Cursor
+============
+
+This example sets an alternative cursor on a figure canvas.
+
+Note, this is an interactive example, and must be run to see the effect.
+"""
+
+import matplotlib.pyplot as plt
+from matplotlib.backend_tools import Cursors
+
+
+fig, axs = plt.subplots(len(Cursors), figsize=(6, len(Cursors) + 0.5),
+                        gridspec_kw={'hspace': 0})
+fig.suptitle('Hover over an Axes to see alternate Cursors')
+
+for cursor, ax in zip(Cursors, axs):
+    ax.cursor_to_use = cursor
+    ax.text(0.5, 0.5, cursor.name,
+            horizontalalignment='center', verticalalignment='center')
+    ax.set(xticks=[], yticks=[])
+
+
+def hover(event):
+    if fig.canvas.widgetlock.locked():
+        # Don't do anything if the zoom/pan tools have been enabled.
+        return
+
+    fig.canvas.set_cursor(
+        event.inaxes.cursor_to_use if event.inaxes else Cursors.POINTER)
+
+
+fig.canvas.mpl_connect('motion_notify_event', hover)
+
+plt.show()
+
+#############################################################################
+#
+# .. admonition:: References
+#
+#    The use of the following functions, methods, classes and modules is shown
+#    in this example:
+#
+#    - `matplotlib.backend_bases.FigureCanvasBase.set_cursor`
