Spelling.TextBufferAdapter¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.ActionGroup (14)
Structs:: GObject.ObjectClass (5)

class	`new` (buffer, checker)
	`get_buffer` ()
	`get_checker` ()
	`get_enabled` ()
	`get_language` ()
	`get_menu_model` ()
	`get_tag` ()
	`invalidate_all` ()
	`set_checker` (checker)
	`set_enabled` (enabled)
	`set_language` (language)
	`update_corrections` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.ActionGroup (14)

Properties¶

Name	Type	Flags
`buffer`	`GtkSource.Buffer`	r/w/co
`checker`	`Spelling.Checker`	r/w
`enabled`	`bool`	r/w/en
`language`	`str`	r/w/en

Signals¶

Inherited:: GObject.Object (1), Gio.ActionGroup (4)

Fields¶

Inherited:: GObject.Object (1), Gio.ActionGroup (4)

Class Details¶

class Spelling.TextBufferAdapter(**kwargs)¶

Bases:: GObject.Object, Gio.ActionGroup
Abstract:: No
Structure:: Spelling.TextBufferAdapterClass

SpellingTextBufferAdapter implements helpers to easily add spellchecking capabilities to a GtkSourceBuffer.

classmethod new(buffer, checker)¶

Parameters:

buffer (GtkSource.Buffer) – a GtkSourceBuffer
checker (Spelling.Checker) – a SpellingChecker

Returns:

a newly created SpellingTextBufferAdapter

Return type:

Spelling.TextBufferAdapter

Create a new SpellingTextBufferAdapter.

get_buffer()¶

Returns:: a GtkSourceBuffer
Return type:: GtkSource.Buffer or None

Gets the underlying buffer for the adapter.

get_checker()¶

Returns:: a SpellingChecker or None
Return type:: Spelling.Checker or None

Gets the checker used by the adapter.

get_enabled()¶

Returns:: True if enabled
Return type:: bool

Gets if the spellcheck is enabled.

get_language()¶

Returns:: a language code
Return type:: str or None

Gets the checker language.

get_menu_model()¶

Returns:: a GMenuModel
Return type:: Gio.MenuModel

Gets the menu model containing corrections

get_tag()¶

Returns:: a GtkTextTag or None
Return type:: Gtk.TextTag or None

Gets the tag used for potentially misspelled words.

invalidate_all()¶

Invalidate the spelling engine, to force parsing again.

Invalidation is automatically done on [property`GtkSource`.Buffer:loading] change.

set_checker(checker)¶

Parameters:: checker (Spelling.Checker) – a SpellingChecker

Set the [class`Spelling`.Checker] used for spellchecking.

set_enabled(enabled)¶

Parameters:: enabled (bool) – whether the spellcheck is enabled

If True spellcheck is enabled.

set_language(language)¶

Parameters:: language (str) – the language to use

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

update_corrections()¶

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.

Property Details¶

Spelling.TextBufferAdapter.props.buffer¶

Name:: buffer
Type:: GtkSource.Buffer
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The [class`GtkSource`.Buffer].

Spelling.TextBufferAdapter.props.checker¶

Name:: checker
Type:: Spelling.Checker
Default Value:: None
Flags:: READABLE, WRITABLE

The [class`Spelling`.Checker].

Spelling.TextBufferAdapter.props.enabled¶

Name:: enabled
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether spellcheck is enabled.

Spelling.TextBufferAdapter.props.language¶

Name:: language
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The language code, such as en_US.