Add get_tooltip(), set_tooltip() methods to GUI widgets (mne-tools#10270

)

mne/gui/tests/test_gui_api.py

@@ -250,6 +250,18 @@ def _check_widget_trigger(widget, mock, before, after, call_count=True,
     renderer._tool_bar_set_theme(theme='dark')
     # --- END: tool bar ---
 
+    # --- BEGIN: tooltips ---
+    widget = renderer._dock_add_button(
+        name='',
+        callback=mock,
+        tooltip='foo'
+    )
+    assert widget.get_tooltip() == 'foo'
+    # Change it …
+    widget.set_tooltip('bar')
+    assert widget.get_tooltip() == 'bar'
+    # --- END: tooltips ---
+
     renderer.show()
     renderer.close()
 

mne/viz/backends/_abstract.py

@@ -692,6 +692,14 @@ def is_enabled(self):
     def update(self, repaint=True):
         pass
 
+    @abstractmethod
+    def get_tooltip(self):
+        pass
+
+    @abstractmethod
+    def set_tooltip(self, tooltip: str):
+        pass
+
 
 class _AbstractMplInterface(ABC):
     @abstractmethod

mne/viz/backends/_notebook.py

@@ -446,6 +446,14 @@ def is_enabled(self):
     def update(self, repaint=True):
         pass
 
+    def get_tooltip(self):
+        assert hasattr(self._widget, 'tooltip')
+        return self._widget.tooltip
+
+    def set_tooltip(self, tooltip):
+        assert hasattr(self._widget, 'tooltip')
+        self._widget.tooltip = tooltip
+
 
 class _Renderer(_PyVistaRenderer, _IpyDock, _IpyToolBar, _IpyMenuBar,
                 _IpyStatusBar, _IpyWindow, _IpyPlayback):

mne/viz/backends/_qt.py

@@ -685,6 +685,14 @@ def update(self, repaint=True):
         if repaint:
             self._widget.repaint()
 
+    def get_tooltip(self):
+        assert hasattr(self._widget, 'toolTip')
+        return self._widget.toolTip()
+
+    def set_tooltip(self, tooltip):
+        assert hasattr(self._widget, 'setToolTip')
+        self._widget.setToolTip(tooltip)
+
 
 class _Renderer(_PyVistaRenderer, _QtDock, _QtToolBar, _QtMenuBar,
                 _QtStatusBar, _QtWindow, _QtPlayback):