Class: GtkSource::Snippet

Inherits:

Object

• Object
• GtkSource::Snippet

Defined in:

(unknown)

Instance Method Summary

• #add_chunk(chunk) ⇒ nil

  Appends chunk to the snippet.

• #buffer ⇒ Gtk::TextBuffer

  Buffer.

• #buffer=(buffer) ⇒ Gtk::TextBuffer
• #context ⇒ GtkSource::SnippetContext

  Gets the context used for expanding the snippet.

• #copy ⇒ GtkSource::Snippet

  Does a deep copy of the snippet.

• #description ⇒ String

  Description.

• #description=(description) ⇒ String
• #focus_position ⇒ Integer

  Focus-position.

• #focus_position=(focus_position) ⇒ Integer
• #get_nth_chunk(nth) ⇒ GtkSource::SnippetChunk

  Gets the chunk at nth.

• #initialize(text) ⇒ GtkSource::Snippet constructor

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

• #language_id ⇒ String

  Language-id.

• #language_id=(language_id) ⇒ String
• #n_chunks ⇒ Integer

  Gets the number of chunks in the snippet.

• #name ⇒ String

  Name.

• #name=(name) ⇒ String
• #trigger ⇒ String

  Trigger.

• #trigger=(trigger) ⇒ String

Constructor Details

#initialize(text) ⇒ GtkSource::Snippet

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

Parameters:

• text (String) —

  the formatted snippet text to parse

Instance Method Details

#add_chunk(chunk) ⇒ nil

Appends chunk to the snippet.

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

Parameters:

• chunk (GtkSource::SnippetChunk) —

  a Gtk::SourceSnippetChunk

Returns:

• (nil)

#buffer ⇒ Gtk::TextBuffer

Returns buffer.

Returns:

• (Gtk::TextBuffer) —

  buffer

#buffer=(buffer) ⇒ Gtk::TextBuffer

Parameters:

• buffer (Gtk::TextBuffer)

Returns:

• (Gtk::TextBuffer) —

  buffer

• (Gtk::TextBuffer) —

  buffer

#context ⇒ GtkSource::SnippetContext

Gets the context used for expanding the snippet.

Returns:

• (GtkSource::SnippetContext) —

  an Gtk::SourceSnippetContext

#copy ⇒ GtkSource::Snippet

Does a deep copy of the snippet.

Returns:

• (GtkSource::Snippet) —

  A new Gtk::SourceSnippet

#description ⇒ String

Returns description.

Returns:

• (String) —

  description

#description=(description) ⇒ String

Parameters:

• description (String)

Returns:

• (String) —

  description

• (String) —

  description

#focus_position ⇒ Integer

Returns focus-position.

Returns:

• (Integer) —

  focus-position

#focus_position=(focus_position) ⇒ Integer

Parameters:

• focus_position (Integer)

Returns:

• (Integer) —

  focus-position

• (Integer) —

  focus-position

#get_nth_chunk(nth) ⇒ GtkSource::SnippetChunk

Gets the chunk at nth.

Parameters:

• nth (Integer) —

  the nth chunk to get

Returns:

• (GtkSource::SnippetChunk) —

  an Gtk::SourceSnippetChunk

#language_id ⇒ String

Returns language-id.

Returns:

• (String) —

  language-id

#language_id=(language_id) ⇒ String

Parameters:

• language_id (String)

Returns:

• (String) —

  language-id

• (String) —

  language-id

#n_chunks ⇒ Integer

Gets the number of chunks in the snippet.

Note that not all chunks are editable.

Returns:

• (Integer) —

  The number of chunks.

#name ⇒ String

Returns name.

Returns:

• (String) —

  name

#name=(name) ⇒ String

Parameters:

• name (String)

Returns:

• (String) —

  name

• (String) —

  name

#trigger ⇒ String

Returns trigger.

Returns:

• (String) —

  trigger

#trigger=(trigger) ⇒ String

Parameters:

• trigger (String)

Returns:

• (String) —

  trigger

• (String) —

  trigger