Snippet

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_snippet_get_type ()" ) ]
public sealed class Snippet : Object

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.

Namespace: GtkSource

Package: gtksourceview-5

Content:

Properties:

public TextBuffer buffer { owned get; }
public string description { get; set; }
public int focus_position { get; }
public string language_id { get; set; }
public string name { get; set; }
public string trigger { get; set; }

Creation methods:

public Snippet (string? trigger, string? language_id)
Creates a new Snippet
public Snippet.parsed (string text) throws Error
Parses the snippet formatted text into a series of chunks and adds them to a new Snippet.

Methods:

public void add_chunk (SnippetChunk chunk)
Appends chunk to the this.
public Snippet copy ()
Does a deep copy of the snippet.
public unowned SnippetContext? get_context ()
Gets the context used for expanding the snippet.
public unowned string get_description ()
Gets the description for the snippet.
public int get_focus_position ()
Gets the current focus for the snippet.
public unowned string get_language_id ()
Gets the language-id used for the source snippet.
public uint get_n_chunks ()
Gets the number of chunks in the snippet.
public unowned string get_name ()
Gets the name for the snippet.
public unowned SnippetChunk get_nth_chunk (uint nth)
Gets the chunk at nth.
public unowned string? get_trigger ()
Gets the trigger for the source snippet.
public void set_description (string description)
Sets the description for the snippet.
public void set_language_id (string language_id)
Sets the language identifier for the snippet.
public void set_name (string name)
Sets the name for the snippet.
public void set_trigger (string trigger)
Sets the trigger for the snippet.

Inherited Members:

All known members inherited from class GLib.Object