Class Hover

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.Hover

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class Hover
extends GObject

Interactive tooltips.

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

To enable call View.getHover() and add HoverProvider using addProvider(HoverProvider). To disable, remove all registered providers with removeProvider(HoverProvider).

You can change how long to wait to display the interactive tooltip by setting the Hover:hover-delay property in milliseconds.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Hover.Builder<B extends Hover.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Hover.HoverClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Hover()	Create a new Hover.
Hover(MemorySegment address)	Create a Hover instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addProvider(HoverProvider provider)
protected Hover	asParent()	Return this instance as if it were its parent type.
static Hover.Builder<? extends Hover.Builder>	builder()	A Hover.Builder object constructs a Hover with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the Hover class.
void	removeProvider(HoverProvider provider)

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Hover

public Hover(MemorySegment address)

Create a Hover instance for the provided memory address.

Parameters:

address - the memory address of the native object

Hover

public Hover()

Create a new Hover.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Hover class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Hover asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

addProvider

public void addProvider(HoverProvider provider)

removeProvider

public void removeProvider(HoverProvider provider)

builder

public static Hover.Builder<? extends Hover.Builder> builder()

A Hover.Builder object constructs a Hover with the specified properties. Use the various set...() methods to set properties, and finish construction with Hover.Builder.build().

Returns:

the builder object