GtkSource.HoverProvider¶

Implementations:: None

Methods¶

	`populate_async` (context, display, cancellable, callback, *user_data)
	`populate_finish` (result)

Virtual Methods¶

	`do_populate` (context, display)
	`do_populate_async` (context, display, cancellable, callback, *user_data)
	`do_populate_finish` (result)

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class GtkSource.HoverProvider¶

Bases:: GObject.GInterface
Structure:: GtkSource.HoverProviderInterface

Interface to populate interactive tooltips.

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

If you can populate the [class`HoverDisplay`] synchronously, use [vfunc`HoverProvider`.populate]. Otherwise, interface implementations that may take additional time should use [vfunc`HoverProvider`.populate_async] to avoid blocking the main loop.

populate_async(context, display, cancellable, callback, *user_data)¶

Parameters:

context (GtkSource.HoverContext) –
display (GtkSource.HoverDisplay) –
cancellable (Gio.Cancellable or None) –
callback (Gio.AsyncReadyCallback or None) –
user_data (object or None) –

populate_finish(result)¶

Parameters:: result (Gio.AsyncResult) –
Raises:: GLib.Error
Return type:: bool

do_populate(context, display) virtual¶

Parameters:

context (GtkSource.HoverContext) –
display (GtkSource.HoverDisplay) –

Return type:

bool

do_populate_async(context, display, cancellable, callback, *user_data) virtual¶

Parameters:

context (GtkSource.HoverContext) –
display (GtkSource.HoverDisplay) –
cancellable (Gio.Cancellable or None) –
callback (Gio.AsyncReadyCallback or None) –
user_data (object or None) –

do_populate_finish(result) virtual¶

Parameters:: result (Gio.AsyncResult) –
Return type:: bool