Module: GtkSource::HoverProvider

Defined in:

(unknown)

Overview

Interface to populate interactive tooltips.

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

If you can populate the [classHoverDisplay] synchronously, use [vfuncHoverProvider.populate]. Otherwise, interface implementations that may take additional time should use [vfuncHoverProvider.populate_async] to avoid blocking the main loop.

Instance Method Summary

• #populate(context, display) ⇒ Boolean
• #populate_async(context, display, cancellable, callback, user_data) ⇒ nil
• #populate_finish(result) ⇒ Boolean

Instance Method Details

#populate(context, display) ⇒ Boolean

Parameters:

• context (GtkSource::HoverContext)
• display (GtkSource::HoverDisplay)

Returns:

• (Boolean)

#populate_async(context, display, cancellable, callback, user_data) ⇒ nil

Parameters:

• context (GtkSource::HoverContext)
• display (GtkSource::HoverDisplay)
• cancellable (Gio::Cancellable)
• callback (Gio::AsyncReadyCallback)
• user_data (GObject)

Returns:

• (nil)

#populate_finish(result) ⇒ Boolean

Parameters:

• result (Gio::AsyncResult)

Returns:

• (Boolean)