Package org.gnome.gtksourceview

Class SnippetContext

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.SnippetContext

All Implemented Interfaces:

Proxy

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

Context for expanding SnippetChunk.

This class is currently used primary as a hashtable. However, the longer term goal is to have it hold onto a GjsContext as well as other languages so that SnippetChunk can expand themselves by executing script within the context.

The Snippet will build the context and then expand each of the chunks during the insertion/edit phase.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SnippetContext	asParent()	Returns this instance as if it were its parent type.
static SnippetContext.Builder<? extends SnippetContext.Builder>	builder()	A SnippetContext.Builder object constructs a SnippetContext with the specified properties.
void	clearVariables()	Removes all variables from the context.
void	emitChanged()	Emits the "changed" signal.
String	expand(String input)
static Type	getType()	Get the GType of the SnippetContext class
String	getVariable(String key)	Gets the current value for a variable named key.
SignalConnection<SnippetContext.ChangedCallback>	onChanged(SnippetContext.ChangedCallback handler)	The signal is emitted when a change has been discovered in one of the chunks of the snippet which has caused a variable or other dynamic data within the context to have changed.
void	setConstant(String key, String value)	Sets a constatnt within the context.
void	setLinePrefix(String linePrefix)
void	setTabWidth(int tabWidth)
void	setUseSpaces(boolean useSpaces)
void	setVariable(String key, String value)	Sets a variable within the context.

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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

SnippetContext

public SnippetContext(MemorySegment address)

Create a SnippetContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SnippetContext

public SnippetContext()

Creates a new GtkSourceSnippetContext.

Generally, this isn't needed unless you are controlling the expansion of snippets manually.

Method Details

getType

public static Type getType()

Get the GType of the SnippetContext class

Returns:

the GType

asParent

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

clearVariables

public void clearVariables()

Removes all variables from the context.

expand

public String expand(String input)

getVariable

public String getVariable(String key)

Gets the current value for a variable named key.

Parameters:

key - the name of the variable

Returns:

the value for the variable, or null

setConstant

public void setConstant(String key,
 String value)

Sets a constatnt within the context.

This is similar to a variable set with setVariable(java.lang.String, java.lang.String) but is expected to not change during use of the snippet.

Examples would be the date or users name.

Parameters:

key - the constant name

value - the value of the constant

setLinePrefix

public void setLinePrefix(String linePrefix)

setTabWidth

public void setTabWidth(int tabWidth)

setUseSpaces

public void setUseSpaces(boolean useSpaces)

setVariable

public void setVariable(String key,
 String value)

Sets a variable within the context.

This variable may be overridden by future updates to the context.

Parameters:

key - the variable name

value - the value for the variable

onChanged

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

The signal is emitted when a change has been discovered in one of the chunks of the snippet which has caused a variable or other dynamic data within the context to have changed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SnippetContext.ChangedCallback.run()

emitChanged

public void emitChanged()

Emits the "changed" signal. See onChanged(org.gnome.gtksourceview.SnippetContext.ChangedCallback).

builder

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

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