Struct sourceview5::Snippet

pub struct Snippet { /* private fields */ }

Quick insertion code snippets.

The Snippet 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::push_snippet().

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

Properties

buffer

Readable

description

Readable | Writeable

focus-position

Readable

language-id

Readable | Writeable

name

Readable | Writeable

trigger

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Snippet

pub fn new(trigger: Option<&str>, language_id: Option<&str>) -> Snippet

Creates a new #GtkSourceSnippet

trigger

the trigger word

language_id

the source language

Returns

A new #GtkSourceSnippet

pub fn new_parsed(text: &str) -> Result<Snippet, Error>

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

text

the formatted snippet text to parse

Returns

the newly parsed #GtkSourceSnippet, or None upon failure and @error is set.

pub fn builder() -> SnippetBuilder

Creates a new builder-pattern struct instance to construct Snippet objects.

This method returns an instance of SnippetBuilder which can be used to create Snippet objects.

pub fn add_chunk(&self, chunk: &SnippetChunk)

Appends @chunk to the @self.

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

chunk

a #GtkSourceSnippetChunk

pub fn copy(&self) -> Snippet

pub fn context(&self) -> Option<SnippetContext>

Gets the context used for expanding the snippet.

Returns

an #GtkSourceSnippetContext

pub fn description(&self) -> GString

Gets the description for the snippet.

pub fn focus_position(&self) -> i32

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.

pub fn language_id(&self) -> GString

Gets the language-id used for the source snippet.

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

Returns

the language identifier

pub fn n_chunks(&self) -> u32

Gets the number of chunks in the snippet.

Note that not all chunks are editable.

Returns

The number of chunks.

pub fn name(&self) -> GString

Gets the name for the snippet.

pub fn nth_chunk(&self, nth: u32) -> SnippetChunk

Gets the chunk at @nth.

nth

the nth chunk to get

Returns

an #GtkSourceSnippetChunk

pub fn trigger(&self) -> Option<GString>

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 None

pub fn set_description(&self, description: &str)

Sets the description for the snippet.

description

the snippet description

pub fn set_language_id(&self, language_id: &str)

Sets the language identifier for the snippet.

This should match the id identifier.

language_id

the language identifier for the snippet

pub fn set_name(&self, name: &str)

Sets the name for the snippet.

name

the snippet name

pub fn set_trigger(&self, trigger: &str)

Sets the trigger for the snippet.

trigger

the trigger word

pub fn buffer(&self) -> Option<TextBuffer>

pub fn connect_buffer_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_description_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_focus_position_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_language_id_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_trigger_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for Snippet

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Snippet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Snippet

fn default() -> Self

Returns the “default value” for a type.

impl Display for Snippet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Snippet

type ParamSpec = ParamSpecObject

type SetValue = Snippet

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Snippet>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Snippet

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Snippet

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Snippet

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Snippet

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Snippet

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Snippet

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Snippet