Gspell.Entry¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_from_gtk_entry` (gtk_entry)
	`basic_setup` ()
	`get_entry` ()
	`get_inline_spell_checking` ()
	`set_inline_spell_checking` (enable)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`entry`	`Gtk.Entry`	r/w/co
`inline-spell-checking`	`bool`	r/w

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gspell.Entry(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gspell.EntryClass

classmethod get_from_gtk_entry(gtk_entry)¶

Parameters:: gtk_entry (Gtk.Entry) – a Gtk.Entry.
Returns:: the Gspell.Entry of gtk_entry.
Return type:: Gspell.Entry

Returns the Gspell.Entry of gtk_entry. The returned object is guaranteed to be the same for the lifetime of gtk_entry.

New in version 1.4.

basic_setup()¶

This function is a convenience function that does the following:

Set a spell checker. The language chosen is the one returned by Gspell.Language.get_default().
Set the Gspell.Entry :inline-spell-checking property to True.

Example:

GtkEntry *gtk_entry;
GspellEntry *gspell_entry;

gspell_entry = gspell_entry_get_from_gtk_entry (gtk_entry);
gspell_entry_basic_setup (gspell_entry);

This is equivalent to:

GtkEntry *gtk_entry;
GspellEntry *gspell_entry;
GspellChecker *checker;
GtkEntryBuffer *gtk_buffer;
GspellEntryBuffer *gspell_buffer;

checker = gspell_checker_new (NULL);
gtk_buffer = gtk_entry_get_buffer (gtk_entry);
gspell_buffer = gspell_entry_buffer_get_from_gtk_entry_buffer (gtk_buffer);
gspell_entry_buffer_set_spell_checker (gspell_buffer, checker);
g_object_unref (checker);

gspell_entry = gspell_entry_get_from_gtk_entry (gtk_entry);
gspell_entry_set_inline_spell_checking (gspell_entry, TRUE);

New in version 1.4.

get_entry()¶

Returns:: the Gtk.Entry of self.
Return type:: Gtk.Entry

New in version 1.4.

get_inline_spell_checking()¶

Returns:: the value of the Gspell.Entry :inline-spell-checking property.
Return type:: bool

New in version 1.4.

set_inline_spell_checking(enable)¶

Parameters:: enable (bool) – the new state.

Sets the Gspell.Entry :inline-spell-checking property.

New in version 1.4.

Property Details¶

Gspell.Entry.props.entry¶

Name:: entry
Type:: Gtk.Entry
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gtk.Entry.

New in version 1.4.

Gspell.Entry.props.inline_spell_checking¶

Name:: inline-spell-checking
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the inline spell checking is enabled.

Even if this property is True, Gspell.Entry disables internally the inline spell checking in case the Gtk.Entry :visibility property is False.

New in version 1.4.