Add an example showing alternate mouse cursors.

QuLogic · QuLogic · commit d6655686462b · 2021-07-27T02:23:49.000-04:00
diff --git a/examples/widgets/mouse_cursor.py b/examples/widgets/mouse_cursor.py
@@ -0,0 +1,54 @@
+"""
+============
+Mouse Cursor
+============
+
+This example sets the cursor on the canvas allowing you to see what they would
+look like. Note, this is an interactive example, and must be run to see the
+effect.
+"""
+import math as M
+
+import matplotlib.pyplot as plt
+from matplotlib.backend_tools import Cursors
+
+
+nrows = M.ceil(M.sqrt(len(Cursors)))
+ncols = M.ceil(len(Cursors) / nrows)
+
+fig, axs = plt.subplots(nrows, ncols)
+fig.suptitle('Hover over an Axes to see alternate Cursors')
+
+for ax, cursor in zip(axs.flat, Cursors):
+    ax.cursor_to_use = cursor
+    ax.text(0.5, 0.5, cursor.name,
+            horizontalalignment='center', verticalalignment='center')
+    ax.set(xticks=[], yticks=[])
+
+# Cleanup extra things.
+for ax in axs.flat[len(Cursors):]:
+    ax.remove()
+fig.subplots_adjust(hspace=0, wspace=0)
+
+
+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`
