:right-sidebar: True

Hover
===================================================================

.. currentmodule:: gi.repository.GtkSource





.. class:: Hover(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





Interactive tooltips.

``GtkSourceHover`` allows a :obj:`~gi.repository.GtkSource.View` to provide contextual information.
When enabled, if the user hovers over a word in the text editor, a series
of registered :obj:`~gi.repository.GtkSource.HoverProvider` can populate a :obj:`~gi.repository.GtkSource.HoverDisplay`
with useful information.

To enable call :obj:`~gi.repository.View.get_hover` and add :obj:`~gi.repository.GtkSource.HoverProvider`
using :obj:`~gi.repository.Hover.add_provider`\. To disable, remove all registered
providers with :obj:`~gi.repository.Hover.remove_provider`\.

You can change how long to wait to display the interactive tooltip by
setting the :obj:`~gi.repository.GtkSource.Hover.props.hover_delay` property in milliseconds.




Methods
-------

.. rst-class:: interim-class

.. class:: Hover
   :no-index:


   .. method:: add_provider(provider: ~gi.repository.GtkSource.HoverProvider) -> None

      






      :param provider: 




   .. method:: remove_provider(provider: ~gi.repository.GtkSource.HoverProvider) -> None

      






      :param provider: 








Properties
----------

.. rst-class:: interim-class

.. class:: Hover
   :no-index:
   

   .. attribute:: props.hover_delay
      :type: int

      The type of the None singleton.