Struct TextBufferAdapter 

pub struct TextBufferAdapter { /* private fields */ }

SpellingTextBufferAdapter implements helpers to easily add spellchecking capabilities to a [gtk_source::Buffer][crate::gtk_source::Buffer].

Properties

buffer

The [gtk_source::Buffer][crate::gtk_source::Buffer].

Readable | Writeable | Construct Only

checker

The Checker.

Readable | Writeable

enabled

Whether spellcheck is enabled.

Readable | Writeable

language

The language code, such as en_US.

Readable | Writeable

Implements

gio::prelude::ActionGroupExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl TextBufferAdapter

pub fn new(buffer: &impl IsA<Buffer>, checker: &Checker) -> TextBufferAdapter

Create a new SpellingTextBufferAdapter.

buffer

a [gtk_source::Buffer][crate::gtk_source::Buffer]

checker

a SpellingChecker

Returns

a newly created SpellingTextBufferAdapter

pub fn builder() -> TextBufferAdapterBuilder

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

This method returns an instance of TextBufferAdapterBuilder which can be used to create TextBufferAdapter objects.

pub fn buffer(&self) -> Option<Buffer>

Gets the underlying buffer for the adapter.

Returns

a [gtk_source::Buffer][crate::gtk_source::Buffer]

pub fn checker(&self) -> Option<Checker>

Gets the checker used by the adapter.

Returns

a SpellingChecker or None

pub fn is_enabled(&self) -> bool

Gets if the spellcheck is enabled.

Returns

true if enabled

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

Gets the checker language.

Returns

a language code

pub fn menu_model(&self) -> MenuModel

Gets the menu model containing corrections

Returns

a GMenuModel

pub fn tag(&self) -> Option<TextTag>

Gets the tag used for potentially misspelled words.

Returns

a gtk::TextTag or None

pub fn invalidate_all(&self)

Invalidate the spelling engine, to force parsing again.

Invalidation is automatically done on [loading][struct@crate::gtk_source::Buffer#loading] change.

pub fn set_checker(&self, checker: &Checker)

Set the Checker used for spellchecking.

checker

a SpellingChecker

pub fn set_enabled(&self, enabled: bool)

If true spellcheck is enabled.

enabled

whether the spellcheck is enabled

pub fn set_language(&self, language: &str)

Sets the language code to use by the checker, such as en_US.

language

the language to use

pub fn update_corrections(&self)

Looks at the current cursor position and updates the list of corrections based on the current word.

Use this to force an update immediately rather than after the automatic timeout caused by cursor movements.

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

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

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

Trait Implementations

impl Clone for TextBufferAdapter

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 TextBufferAdapter

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

Formats the value using the given formatter.

impl Default for TextBufferAdapter

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for TextBufferAdapter

type ParamSpec = ParamSpecObject

type SetValue = TextBufferAdapter

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TextBufferAdapter

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 TextBufferAdapter

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,

Restrict a value to a certain interval.

impl ParentClassIs for TextBufferAdapter

type Parent = Object

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

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for TextBufferAdapter

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

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TextBufferAdapter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TextBufferAdapter

impl IsA<ActionGroup> for TextBufferAdapter