Package org.gnome.gtksourceview

Class HoverContext

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.HoverContext

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class HoverContext
extends GObject

Context for populating HoverDisplay contents.

GtkSourceHoverContext contains information about the request to populate contents for a HoverDisplay.

It can be used to retrieve the View, Buffer, and Gtk.TextIter for the regions of text which are being displayed.

Use getBounds(org.gnome.gtk.TextIter, org.gnome.gtk.TextIter) to get the word that was requested. getIter(org.gnome.gtk.TextIter) will get you the location of the pointer when the request was made.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
HoverContext()	Creates a new HoverContext.
HoverContext(MemorySegment address)	Create a HoverContext proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected HoverContext	asParent()	Returns this instance as if it were its parent type.
static HoverContext.Builder<? extends HoverContext.Builder>	builder()	A HoverContext.Builder object constructs a HoverContext with the specified properties.
boolean	getBounds(@Nullable TextIter begin, @Nullable TextIter end)	Gets the current word bounds of the hover.
Buffer	getBuffer()	A convenience function to get the buffer.
boolean	getIter(TextIter iter)	Gets the location of the pointer where the request was made.
static @Nullable Type	getType()	Get the GType of the HoverContext class
View	getView()

Methods inherited from class org.gnome.gobject.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, getMemoryLayout, 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 org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

HoverContext

public HoverContext(MemorySegment address)

Create a HoverContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

HoverContext

public HoverContext()

Creates a new HoverContext.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the HoverContext class

Returns:

the GType

asParent

protected HoverContext asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getBounds

public boolean getBounds(@Nullable TextIter begin,
 @Nullable TextIter end)

Gets the current word bounds of the hover.

If begin is non-null, it will be set to the start position of the current word being hovered.

If end is non-null, it will be set to the end position for the current word being hovered.

Parameters:

begin - a GtkTextIter

end - a GtkTextIter

Returns:

true if the marks are still valid and begin or end was set.

getBuffer

public Buffer getBuffer()

A convenience function to get the buffer.

Returns:

The GtkSourceBuffer for the view

getIter

public boolean getIter(TextIter iter)

Gets the location of the pointer where the request was made.

Parameters:

iter - a GtkTextIter

Returns:

true if the mark is still valid and iter was set.

getView

public View getView()

builder

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

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

Returns:

the builder object