Struct sourceview5::SnippetManager

pub struct SnippetManager { /* private fields */ }

Provides access to Snippet.

SnippetManager is an object which processes snippet description files and creates Snippet objects.

Use get_default() to retrieve the default instance of SnippetManager.

Use snippet() to retrieve snippets for a given snippets.

Properties

search-path

Contains a list of directories to search for files containing snippets (*.snippets).

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl SnippetManager

pub fn builder() -> SnippetManagerBuilder

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

This method returns an instance of SnippetManagerBuilder which can be used to create SnippetManager objects.

pub fn search_path(&self) -> Vec<GString>

Gets the list directories where @self looks for snippet files.

Returns

None-terminated array containing a list of snippet files directories. The array is owned by @lm and must not be modified.

pub fn snippet( &self, group: Option<&str>, language_id: Option<&str>, trigger: &str, ) -> Option<Snippet>

Queries the known snippets for the first matching @group, @language_id, and/or @trigger.

If @group or @language_id are None, they will be ignored.

group

a group name or None

language_id

a #GtkSourceLanguage:id or None

trigger

the trigger for the snippet

Returns

a #GtkSourceSnippet or None if no matching snippet was found.

pub fn list_all(&self) -> ListModel

Gets a gio::ListModel of all snippets.

This can be used to get an unfiltered list of all of the snippets known to the snippet manager.

Returns

a gio::ListModel of Snippet

pub fn list_groups(&self) -> Vec<GString>

List all the known groups within the snippet manager.

The result should be freed with g_free(), and the individual strings are owned by @self and should never be freed by the caller.

Returns

An array of strings which should be freed with g_free().

pub fn list_matching( &self, group: Option<&str>, language_id: Option<&str>, trigger_prefix: Option<&str>, ) -> ListModel

Queries the known snippets for those matching @group, @language_id, and/or @trigger_prefix.

If any of these are None, they will be ignored when filtering the available snippets.

The gio::ListModel only contains information about the available snippets until [ListModelExtManual::item()][crate::gio::prelude::ListModelExtManual::item()] is called for a specific snippet. This helps reduce the number of glib::Object’s that are created at runtime to those needed by the calling application.

group

a group name or None

language_id

a #GtkSourceLanguage:id or None

trigger_prefix

a prefix for a trigger to activate

Returns

a #GListModel of #GtkSourceSnippet.

pub fn set_search_path(&self, dirs: &[&str])

Sets the list of directories in which the SnippetManager looks for snippet files.

If @dirs is None, the search path is reset to default.

At the moment this function can be called only before the snippet files are loaded for the first time. In practice to set a custom search path for a SnippetManager, you have to call this function right after creating it.

dirs

a None-terminated array of strings or None.

pub fn default() -> SnippetManager

Returns the default #GtkSourceSnippetManager instance.

Returns

a #GtkSourceSnippetManager which is owned by GtkSourceView library and must not be unref’d.

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

Trait Implementations

impl Clone for SnippetManager

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 SnippetManager

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

Formats the value using the given formatter.

impl HasParamSpec for SnippetManager

type ParamSpec = ParamSpecObject

type SetValue = SnippetManager

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SnippetManager

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 SnippetManager

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 SnippetManager

type Parent = Object

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

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 SnippetManager

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 SnippetManager

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SnippetManager