Struct sourceview5::SnippetChunk

pub struct SnippetChunk { /* private fields */ }

A chunk of text within the source snippet.

The SnippetChunk represents a single chunk of text that may or may not be an edit point within the snippet. Chunks that are an edit point (also called a tab stop) have the focus-position property set.

Properties

context

Readable | Writeable

focus-position

Readable | Writeable

spec

Readable | Writeable

text

Readable | Writeable

text-set

Readable | Writeable

tooltip-text

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl SnippetChunk

pub fn new() -> SnippetChunk

Create a new SnippetChunk that can be added to a Snippet.

pub fn builder() -> SnippetChunkBuilder

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

This method returns an instance of SnippetChunkBuilder which can be used to create SnippetChunk objects.

pub fn copy(&self) -> SnippetChunk

pub fn context(&self) -> SnippetContext

Gets the context for the snippet insertion.

Returns

A #GtkSourceSnippetContext

pub fn focus_position(&self) -> i32

Gets the focus-position.

The focus-position is used to determine how many tabs it takes for the snippet to advanced to this chunk.

A focus-position of zero will be the last focus position of the snippet and snippet editing ends when it has been reached.

A focus-position of -1 means the chunk cannot be focused by the user.

Returns

the focus-position

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

Gets the specification for the chunk.

The specification is evaluated for variables when other chunks are edited within the snippet context. If the user has changed the text, the text and text-set properties are updated.

Returns

the specification, if any

pub fn text(&self) -> GString

Gets the text property.

The text property is updated when the user edits the text of the chunk. If it has not been edited, the spec property is returned.

Returns

the text of the chunk

pub fn is_text_set(&self) -> bool

Gets the text-set property.

This is typically set when the user has edited a snippet chunk.

pub fn tooltip_text(&self) -> GString

pub fn set_context(&self, context: &SnippetContext)

pub fn set_focus_position(&self, focus_position: i32)

Sets the focus-position property.

The focus-position is used to determine how many tabs it takes for the snippet to advanced to this chunk.

A focus-position of zero will be the last focus position of the snippet and snippet editing ends when it has been reached.

A focus-position of -1 means the chunk cannot be focused by the user.

focus_position

the focus-position

pub fn set_spec(&self, spec: &str)

Sets the specification for the chunk.

The specification is evaluated for variables when other chunks are edited within the snippet context. If the user has changed the text, the text and] text-set properties are updated.

spec

the new specification for the chunk

pub fn set_text(&self, text: &str)

Sets the text for the snippet chunk.

This is usually used by the snippet engine to update the text, but may be useful when creating custom snippets to avoid expansion of any specification.

text

the text of the property

pub fn set_text_set(&self, text_set: bool)

Sets the text-set property.

This is typically set when the user has edited a snippet chunk by the snippet engine.

text_set

the property value

pub fn set_tooltip_text(&self, tooltip_text: &str)

pub fn connect_context_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_spec_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

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

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

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

Trait Implementations

impl Clone for SnippetChunk

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 SnippetChunk

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

Formats the value using the given formatter.

impl Default for SnippetChunk

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SnippetChunk

type ParamSpec = ParamSpecObject

type SetValue = SnippetChunk

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SnippetChunk

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 SnippetChunk

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 SnippetChunk

type Parent = Object

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

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 SnippetChunk

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 SnippetChunk

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SnippetChunk