Struct sourceview5::Language

pub struct Language { /* private fields */ }

Represents a syntax highlighted language.

A Language represents a programming or markup language, affecting syntax highlighting and context classes.

Use LanguageManager to obtain a Language instance, and BufferExt::set_language() to apply it to a Buffer.

Properties

hidden

Readable

id

Readable

name

Readable

section

Readable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Language

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

Returns the globs associated to this language.

This is just an utility wrapper around metadata() to retrieve the “globs” metadata property and split it into an array.

Returns

a newly-allocated None terminated array containing the globs or None if no globs are found. The returned array must be freed with g_strfreev().

pub fn is_hidden(&self) -> bool

Returns whether the language should be hidden from the user.

Returns

true if the language should be hidden, false otherwise.

pub fn id(&self) -> GString

Returns the ID of the language.

The ID is not locale-dependent.The returned string is owned by @self and should not be freed or modified.

Returns

the ID of @self.

pub fn metadata(&self, name: &str) -> Option<GString>

name

metadata property name.

Returns

value of property @name stored in the metadata of @self or None if language does not contain the specified metadata property. The returned string is owned by @self and should not be freed or modified.

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

Returns the mime types associated to this language.

This is just an utility wrapper around metadata() to retrieve the “mimetypes” metadata property and split it into an array.

Returns

a newly-allocated None terminated array containing the mime types or None if no mime types are found. The returned array must be freed with g_strfreev().

pub fn name(&self) -> GString

Returns the localized name of the language.

The returned string is owned by @self and should not be freed or modified.

Returns

the name of @self.

pub fn section(&self) -> GString

Returns the localized section of the language.

Each language belong to a section (ex. HTML belongs to the Markup section). The returned string is owned by @self and should not be freed or modified.

Returns

the section of @self.

pub fn style_fallback(&self, style_id: &str) -> Option<GString>

Returns the ID of the style to use if the specified @style_id is not present in the current style scheme.

style_id

a style ID.

Returns

the ID of the style to use if the specified @style_id is not present in the current style scheme or None if the style has no fallback defined. The returned string is owned by the @self and must not be modified.

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

Returns the ids of the styles defined by this @self.

Returns

a newly-allocated None terminated array containing ids of the styles defined by this @self or None if no style is defined. The returned array must be freed with g_strfreev().

pub fn style_name(&self, style_id: &str) -> Option<GString>

Returns the name of the style with ID @style_id defined by this @self.

style_id

a style ID.

Returns

the name of the style with ID @style_id defined by this @self or None if the style has no name or there is no style with ID @style_id defined by this @self. The returned string is owned by the @self and must not be modified.

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

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

Trait Implementations

impl Clone for Language

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 Language

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

Formats the value using the given formatter.

impl Display for Language

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

Formats the value using the given formatter.

impl HasParamSpec for Language

type ParamSpec = ParamSpecObject

type SetValue = Language

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Language

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 Language

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 Language

type Parent = Object

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

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 Language

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 Language

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Language