gtksource/org.gtkkn.bindings.gtksource/Snippet

Snippet

open class Snippet(pointer: <Error class: unknown class><<Error class: unknown class>>)

Quick insertion code snippets.

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

Snippets are defined in XML files which are loaded by the class@SnippetManager. Alternatively, applications can create snippets on demand and insert them into the class@View using method@View.push_snippet.

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

Skipped during bindings generation

method buffer: Property has no getter nor setter
method trigger: Property TypeInfo of getter and setter do not match

Constructors

Snippet

constructor(trigger: String? = null, languageId: String? = null)

Creates a new #GtkSourceSnippet

constructor(text: String)

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

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

description

open var description: String

focusPosition

open val focusPosition: Int

gtksourceSnippetPointer

val gtksourceSnippetPointer: <Error class: unknown class><<Error class: unknown class>>

languageId

open var languageId: String

name

open var name: String

Functions

addChunk

open fun addChunk(chunk: SnippetChunk)

Appends @chunk to the @snippet.

copy

open fun copy(): Snippet

Does a deep copy of the snippet.

getContext

open fun getContext(): SnippetContext?

Gets the context used for expanding the snippet.

getDescription

open fun getDescription(): String

Gets the description for the snippet.

getFocusPosition

open fun getFocusPosition(): Int

Gets the current focus for the snippet.

getLanguageId

open fun getLanguageId(): String

Gets the language-id used for the source snippet.

getName

open fun getName(): String

Gets the name for the snippet.

getNChunks

open fun getNChunks(): <Error class: unknown class>

Gets the number of chunks in the snippet.

getNthChunk

open fun getNthChunk(nth: <Error class: unknown class>): SnippetChunk

Gets the chunk at @nth.

getTrigger

open fun getTrigger(): String?

Gets the trigger for the source snippet.

setDescription

open fun setDescription(description: String)

Sets the description for the snippet.

setLanguageId

open fun setLanguageId(languageId: String)

Sets the language identifier for the snippet.

setName

open fun setName(name: String)

Sets the name for the snippet.

setTrigger

open fun setTrigger(trigger: String)

Sets the trigger for the snippet.