Struct sourceview5::SnippetContext

pub struct SnippetContext { /* private fields */ }

Context for expanding SnippetChunk.

This class is currently used primary as a hashtable. However, the longer term goal is to have it hold onto a GjsContext as well as other languages so that SnippetChunk can expand themselves by executing script within the context.

The Snippet will build the context and then expand each of the chunks during the insertion/edit phase.

Signals

changed

The signal is emitted when a change has been discovered in one of the chunks of the snippet which has caused a variable or other dynamic data within the context to have changed.

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl SnippetContext

pub fn new() -> SnippetContext

Creates a new #GtkSourceSnippetContext.

Generally, this isn’t needed unless you are controlling the expansion of snippets manually.

Returns

a #GtkSourceSnippetContext

pub fn clear_variables(&self)

Removes all variables from the context.

pub fn expand(&self, input: &str) -> GString

pub fn variable(&self, key: &str) -> Option<GString>

Gets the current value for a variable named @key.

key

the name of the variable

Returns

the value for the variable, or None

pub fn set_constant(&self, key: &str, value: &str)

Sets a constatnt within the context.

This is similar to a variable set with set_variable() but is expected to not change during use of the snippet.

Examples would be the date or users name.

key

the constant name

value

the value of the constant

pub fn set_line_prefix(&self, line_prefix: &str)

pub fn set_tab_width(&self, tab_width: i32)

pub fn set_use_spaces(&self, use_spaces: bool)

pub fn set_variable(&self, key: &str, value: &str)

Sets a variable within the context.

This variable may be overridden by future updates to the context.

key

the variable name

value

the value for the variable

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

The signal is emitted when a change has been discovered in one of the chunks of the snippet which has caused a variable or other dynamic data within the context to have changed.

Trait Implementations

impl Clone for SnippetContext

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 SnippetContext

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

Formats the value using the given formatter.

impl Default for SnippetContext

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SnippetContext

type ParamSpec = ParamSpecObject

type SetValue = SnippetContext

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SnippetContext

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 SnippetContext

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 SnippetContext

type Parent = Object

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

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 SnippetContext

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 SnippetContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SnippetContext