:right-sidebar: True

HoverProvider
===================================================================

.. currentmodule:: gi.repository.GtkSource





.. class:: HoverProvider(*args, **kwargs)
   :no-contents-entry:






Interface to populate interactive tooltips.

``GtkSourceHoverProvider`` is an interface that should be implemented to extend
the contents of a :obj:`~gi.repository.GtkSource.HoverDisplay`\. This is typical in editors that
interact external tooling such as those utilizing Language Server Protocol.

If you can populate the :obj:`~gi.repository.GtkSource.HoverDisplay` synchronously, use
:obj:`~gi.repository.HoverProvider.populate`\. Otherwise, interface implementations that
may take additional time should use :obj:`~gi.repository.HoverProvider.populate_async`
to avoid blocking the main loop.




Methods
-------

.. rst-class:: interim-class

.. class:: HoverProvider
   :no-index:


   .. method:: populate_async(context: ~gi.repository.GtkSource.HoverContext, display: ~gi.repository.GtkSource.HoverDisplay, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[~gi.repository.GObject.Object | None, ~gi.repository.Gio.AsyncResult, ~typing.Any], None] | None = None, user_data: ~typing.Any = None) -> None

      






      :param context: 

      :param display: 

      :param cancellable: 

      :param callback: 

      :param user_data: 




   .. method:: populate_finish(result: ~gi.repository.Gio.AsyncResult) -> bool

      






      :param result: 












Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: HoverProvider
   :no-index:
   

   .. method:: do_populate(context: ~gi.repository.GtkSource.HoverContext, display: ~gi.repository.GtkSource.HoverDisplay) -> bool

      The type of the None singleton.







      :param context: 

      :param display: 




   .. method:: do_populate_async(context: ~gi.repository.GtkSource.HoverContext, display: ~gi.repository.GtkSource.HoverDisplay, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[~gi.repository.GObject.Object | None, ~gi.repository.Gio.AsyncResult, ~typing.Any], None] | None = None, user_data: ~typing.Any = None) -> None

      






      :param context: 

      :param display: 

      :param cancellable: 

      :param callback: 

      :param user_data: 




   .. method:: do_populate_finish(result: ~gi.repository.Gio.AsyncResult) -> bool

      






      :param result: