Interface HoverProvider

All Superinterfaces:

Proxy

All Known Implementing Classes:

HoverProvider.HoverProvider$Impl

@Generated("org.javagi.JavaGI")
public interface HoverProvider
extends Proxy

Interface to populate interactive tooltips.

GtkSourceHoverProvider is an interface that should be implemented to extend the contents of a HoverDisplay. This is typical in editors that interact external tooling such as those utilizing Language Server Protocol.

If you can populate the HoverDisplay synchronously, use HoverProvider.populate. Otherwise, interface implementations that may take additional time should use populateAsync(HoverContext, HoverDisplay, Cancellable, AsyncReadyCallback) to avoid blocking the main loop.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HoverProvider.HoverProvider$Impl	The HoverProvider$Impl type represents a native instance of the HoverProvider interface.
static class	HoverProvider.HoverProviderInterface

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the HoverProvider class.
default void	populateAsync(HoverContext context, HoverDisplay display, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)
default boolean	populateFinish(AsyncResult result)

Methods inherited from interface Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the HoverProvider class.

Returns:

the GType

populateAsync

default void populateAsync(HoverContext context,
 HoverDisplay display,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

populateFinish

default boolean populateFinish(AsyncResult result)
                        throws GErrorException

Throws:

GErrorException