Class Annotations

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.Annotations

All Implemented Interfaces:

Proxy

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

Use this object to manage Annotations. Each View has a single annotation manager and it is guaranteed to be the same for the lifetime of View.

Add AnnotationProviders with addProvider(AnnotationProvider) to display all the annotations added to each AnnotationProvider.

Since:

5.18

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Annotations.AnnotationsClass
static class	Annotations.Builder<B extends Annotations.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Annotations.ChangedCallback	Functional interface declaration of the ChangedCallback callback.

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addProvider(AnnotationProvider provider)	Adds a new annotation provider.
protected Annotations	asParent()	Return this instance as if it were its parent type.
static Annotations.Builder<? extends Annotations.Builder>	builder()	A Annotations.Builder object constructs a Annotations with the specified properties.
void	emitChanged()
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the Annotations class.
SignalConnection<Annotations.ChangedCallback>	onChanged(Annotations.ChangedCallback handler)
boolean	removeProvider(AnnotationProvider provider)	Removes a 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

Annotations

public Annotations(MemorySegment address)

Create a Annotations instance for the provided memory address.

Parameters:

address - the memory address of the native object

Annotations

public Annotations()

Create a new Annotations.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Annotations class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Annotations 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(AnnotationProvider provider)

Adds a new annotation provider.

Parameters:

provider - a GtkSourceAnnotationProvider.

removeProvider

public boolean removeProvider(AnnotationProvider provider)

Removes a provider.

Parameters:

provider - a GtkSourceAnnotationProvider.

Returns:

true if the provider was found and removed

onChanged

public SignalConnection<Annotations.ChangedCallback> onChanged(Annotations.ChangedCallback handler)

See Also:

• Annotations.ChangedCallback.run()

emitChanged

public void emitChanged()

builder

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

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

Returns:

the builder object