Package org.gnome.gtksourceview

Class CompletionContext<T extends GObject>

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.CompletionContext<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, SequencedCollection<T>, ListModel<T>, Proxy, ListModelJavaList<T>

@Generated("io.github.jwharm.JavaGI")
public class CompletionContext<T extends GObject>
extends GObject
implements ListModel<T>

The context of a completion.

GtkSourceCompletionContext contains information about an attept to display completion proposals to the user based on typed text in the View.

When typing, Completion may use registered CompletionProvider to determine if there may be results which could be displayed. If so, a GtkSourceCompletionContext is created with information that is provided to the CompletionProvider to populate results which might be useful to the user.

CompletionProvider are expected to provide ListModel with CompletionProposal which may be joined together in a list of results for the user. They are also responsible for how the contents are displayed using CompletionCell which allows for some level of customization.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.ListModel

ListModel.ItemsChangedCallback, ListModel.ListModel$Impl, ListModel.ListModelInterface

Nested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaList

ListModelJavaList.SubList<E extends @Nullable GObject,List extends ListModelJavaList<E>>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected CompletionContext	asParent()	Returns this instance as if it were its parent type.
static CompletionContext.Builder<? extends CompletionContext.Builder>	builder()	A CompletionContext.Builder object constructs a CompletionContext with the specified properties.
void	emitProviderModelChanged(@Nullable CompletionProvider provider, @Nullable ListModel model)	Emits the "provider-model-changed" signal.
CompletionActivation	getActivation()	Gets the mode for which the context was activated.
boolean	getBounds(@Nullable TextIter begin, @Nullable TextIter end)	Gets the bounds for the completion, which is the beginning of the current word (taking break characters into account) to the current insertion cursor.
@Nullable Buffer	getBuffer()	Gets the underlying buffer used by the context.
boolean	getBusy()	Gets the "busy" property.
@Nullable Completion	getCompletion()	Gets the GtkSourceCompletion that created the context.
boolean	getEmpty()	Checks if any proposals have been provided to the context.
@Nullable Language	getLanguage()	Gets the language of the underlying buffer, if any.
@Nullable ListModel	getProposalsForProvider(CompletionProvider provider)	Gets the GListModel associated with the provider.
static @Nullable Type	getType()	Get the GType of the CompletionContext class
@Nullable View	getView()	Gets the text view for the context.
String	getWord()	Gets the word that is being completed up to the position of the insert mark.
ListModel	listProviders()	Gets the providers that are associated with the context.
SignalConnection<CompletionContext.ProviderModelChangedCallback>	onProviderModelChanged(CompletionContext.ProviderModelChangedCallback handler)	Emitted when a provider changes a model.
void	setProposalsForProvider(CompletionProvider provider, @Nullable ListModel results)	This function allows providers to update their results for a context outside of a call to CompletionProvider.populateAsync(org.gnome.gtksourceview.CompletionContext, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.gnome.gio.ListModel

emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChanged

Methods inherited from interface org.javagi.gio.ListModelJavaList

add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

CompletionContext

public CompletionContext(MemorySegment address)

Create a CompletionContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

CompletionContext

public CompletionContext()

Creates a new CompletionContext.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the CompletionContext class

Returns:

the GType

asParent

protected CompletionContext 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

getActivation

public CompletionActivation getActivation()

Gets the mode for which the context was activated.

getBounds

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

Gets the bounds for the completion, which is the beginning of the current word (taking break characters into account) to the current insertion cursor.

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

If end is non-null, it will be set to the insertion cursor for the current word being completed.

Parameters:

begin - a GtkTextIter

end - a GtkTextIter

Returns:

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

getBuffer

public @Nullable Buffer getBuffer()

Gets the underlying buffer used by the context.

This is a convenience function to get the buffer via the GtkSourceCompletion property.

Returns:

a GtkTextBuffer or null

getBusy

public boolean getBusy()

Gets the "busy" property. This is set to true while the completion context is actively fetching proposals from registered GtkSourceCompletionProvider's.

Returns:

true if the context is busy

getCompletion

public @Nullable Completion getCompletion()

Gets the GtkSourceCompletion that created the context.

Returns:

an GtkSourceCompletion or null

getEmpty

public boolean getEmpty()

Checks if any proposals have been provided to the context.

Out of convenience, this function will return true if this CompletionContext is null.

Returns:

true if there are no proposals in the context

getLanguage

public @Nullable Language getLanguage()

Gets the language of the underlying buffer, if any.

Returns:

a GtkSourceLanguage or null

getProposalsForProvider

public @Nullable ListModel getProposalsForProvider(CompletionProvider provider)

Gets the GListModel associated with the provider.

You can connect to GtkSourceCompletionContext::model-changed to receive notifications about when the model has been replaced by a new model.

Parameters:

provider - a GtkSourceCompletionProvider

Returns:

a GListModel or null

Since:

5.6

getView

public @Nullable View getView()

Gets the text view for the context.

Returns:

a GtkSourceView or null

getWord

public String getWord()

Gets the word that is being completed up to the position of the insert mark.

Returns:

a string containing the current word

listProviders

public ListModel listProviders()

Gets the providers that are associated with the context.

Returns:

a GListModel of GtkSourceCompletionProvider

Since:

5.6

setProposalsForProvider

public void setProposalsForProvider(CompletionProvider provider,
 @Nullable ListModel results)

This function allows providers to update their results for a context outside of a call to CompletionProvider.populateAsync(org.gnome.gtksourceview.CompletionContext, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

This can be used to immediately return results for a provider while it does additional asynchronous work. Doing so will allow the completions to update while the operation is in progress.

Parameters:

provider - an GtkSourceCompletionProvider

results - a GListModel or null

onProviderModelChanged

public SignalConnection<CompletionContext.ProviderModelChangedCallback> onProviderModelChanged(CompletionContext.ProviderModelChangedCallback handler)

Emitted when a provider changes a model.

This signal is primarily useful for GtkSourceCompletionProvider's that want to track other providers in context. For example, it can be used to create a "top results" provider.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

5.6

See Also:

• CompletionContext.ProviderModelChangedCallback.run(org.gnome.gtksourceview.CompletionProvider, org.gnome.gio.ListModel)

emitProviderModelChanged

public void emitProviderModelChanged(@Nullable CompletionProvider provider,
 @Nullable ListModel model)

Emits the "provider-model-changed" signal. See onProviderModelChanged(org.gnome.gtksourceview.CompletionContext.ProviderModelChangedCallback).

builder

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

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

Returns:

the builder object