Struct sourceview5::StyleScheme

pub struct StyleScheme { /* private fields */ }

Controls the appearance of View.

#GtkSourceStyleScheme contains all the text styles to be used in View and Buffer. For instance, it contains text styles for syntax highlighting, it may contain foreground and background color for non-highlighted text, color for the line numbers, current line highlighting, bracket matching, etc.

Style schemes are stored in XML files. The format of a scheme file is documented in the style scheme reference.

The two style schemes with IDs “classic” and “tango” follow more closely the GTK theme (for example for the background color).

Properties

description

Style scheme description, a translatable string to present to the user.

Readable

filename

Style scheme filename or None.

Readable

id

Style scheme id, a unique string used to identify the style scheme in StyleSchemeManager.

Readable | Writeable | Construct Only

name

Style scheme name, a translatable string to present to the user.

Readable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl StyleScheme

pub fn builder() -> StyleSchemeBuilder

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

This method returns an instance of StyleSchemeBuilder which can be used to create StyleScheme objects.

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

Returns

a None-terminated array containing the @self authors or None if no author is specified by the style scheme.

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

Returns

@self description (if defined), or None.

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

Returns

@self file name if the scheme was created parsing a style scheme file or None in the other cases.

pub fn id(&self) -> GString

Returns

@self id.

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

Gets a metadata property from the style scheme.

name

metadata property name.

Returns

value of property @name stored in the metadata of @self or None if @self does not contain the specified metadata property.

pub fn name(&self) -> GString

Returns

@self name.

pub fn style(&self, style_id: &str) -> Option<Style>

style_id

id of the style to retrieve.

Returns

style which corresponds to @style_id in the @self, or None when no style with this name found. It is owned by @self and may not be unref’ed.

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

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

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

Trait Implementations

impl Clone for StyleScheme

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 StyleScheme

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

Formats the value using the given formatter.

impl Display for StyleScheme

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

Formats the value using the given formatter.

impl HasParamSpec for StyleScheme

type ParamSpec = ParamSpecObject

type SetValue = StyleScheme

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StyleScheme

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 StyleScheme

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 StyleScheme

type Parent = Object

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

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 StyleScheme

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 StyleScheme

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StyleScheme