Package org.gnome.gtksourceview

Class Snippet

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.Snippet

All Implemented Interfaces:

Proxy

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

Quick insertion code snippets.

The GtkSourceSnippet represents a series of chunks that can quickly be inserted into the View.

Snippets are defined in XML files which are loaded by the SnippetManager. Alternatively, applications can create snippets on demand and insert them into the View using View.pushSnippet(org.gnome.gtksourceview.Snippet, org.gnome.gtk.TextIter).

Snippet chunks can reference other snippet chunks as well as post-process the values from other chunks such as capitalization.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Snippet()	Creates a new Snippet.
Snippet(@Nullable String trigger, @Nullable String languageId)	Creates a new GtkSourceSnippet
Snippet(MemorySegment address)	Create a Snippet proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addChunk(SnippetChunk chunk)	Appends chunk to the snippet.
protected Snippet	asParent()	Returns this instance as if it were its parent type.
static Snippet.Builder<? extends Snippet.Builder>	builder()	A Snippet.Builder object constructs a Snippet with the specified properties.
Snippet	copy()	Does a deep copy of the snippet.
@Nullable SnippetContext	getContext()	Gets the context used for expanding the snippet.
String	getDescription()	Gets the description for the snippet.
int	getFocusPosition()	Gets the current focus for the snippet.
String	getLanguageId()	Gets the language-id used for the source snippet.
String	getName()	Gets the name for the snippet.
int	getNChunks()	Gets the number of chunks in the snippet.
SnippetChunk	getNthChunk(int nth)	Gets the chunk at nth.
@Nullable String	getTrigger()	Gets the trigger for the source snippet.
static @Nullable Type	getType()	Get the GType of the Snippet class
static Snippet	parsed(String text)	Parses the snippet formatted text into a series of chunks and adds them to a new GtkSourceSnippet.
void	setDescription(String description)	Sets the description for the snippet.
void	setLanguageId(String languageId)	Sets the language identifier for the snippet.
void	setName(String name)	Sets the name for the snippet.
void	setTrigger(String trigger)	Sets the trigger for the snippet.

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

Snippet

public Snippet(MemorySegment address)

Create a Snippet proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Snippet

public Snippet(@Nullable String trigger,
 @Nullable String languageId)

Creates a new GtkSourceSnippet

Parameters:

trigger - the trigger word

languageId - the source language

Snippet

public Snippet()

Creates a new Snippet.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Snippet class

Returns:

the GType

asParent

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

parsed

public static Snippet parsed(String text)
                      throws GErrorException

Parses the snippet formatted text into a series of chunks and adds them to a new GtkSourceSnippet.

Parameters:

text - the formatted snippet text to parse

Returns:

the newly parsed GtkSourceSnippet, or null upon failure and error is set.

Throws:

GErrorException - see GError

Since:

5.6

addChunk

public void addChunk(SnippetChunk chunk)

Appends chunk to the snippet.

This may only be called before the snippet has been expanded.

Parameters:

chunk - a GtkSourceSnippetChunk

copy

public Snippet copy()

Does a deep copy of the snippet.

Returns:

A new GtkSourceSnippet

getContext

public @Nullable SnippetContext getContext()

Gets the context used for expanding the snippet.

Returns:

an GtkSourceSnippetContext

getDescription

public String getDescription()

Gets the description for the snippet.

getFocusPosition

public int getFocusPosition()

Gets the current focus for the snippet.

This is changed as the user tabs through focus locations.

Returns:

The focus position, or -1 if unset.

getLanguageId

public String getLanguageId()

Gets the language-id used for the source snippet.

The language identifier should be one that matches a source language Language:id property.

Returns:

the language identifier

getNChunks

public int getNChunks()

Gets the number of chunks in the snippet.

Note that not all chunks are editable.

Returns:

The number of chunks.

getName

public String getName()

Gets the name for the snippet.

getNthChunk

public SnippetChunk getNthChunk(int nth)

Gets the chunk at nth.

Parameters:

nth - the nth chunk to get

Returns:

an GtkSourceSnippetChunk

getTrigger

public @Nullable String getTrigger()

Gets the trigger for the source snippet.

A trigger is a word that can be expanded into the full snippet when the user presses Tab.

Returns:

A string or null

setDescription

public void setDescription(String description)

Sets the description for the snippet.

Parameters:

description - the snippet description

setLanguageId

public void setLanguageId(String languageId)

Sets the language identifier for the snippet.

This should match the Language:id identifier.

Parameters:

languageId - the language identifier for the snippet

setName

public void setName(String name)

Sets the name for the snippet.

Parameters:

name - the snippet name

setTrigger

public void setTrigger(String trigger)

Sets the trigger for the snippet.

Parameters:

trigger - the trigger word

builder

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

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

Returns:

the builder object