| Top | |
|
|
|
| gboolean | enable-language-menu | Read / Write |
| gboolean | inline-spell-checking | Read / Write |
| GtkTextView * | view | Read / Write / Construct Only |
GspellTextView extends the GtkTextView class with inline spell checking.
Misspelled words are highlighted with a red PANGO_UNDERLINE_SINGLE.
Right-clicking a misspelled word pops up a context menu of suggested
replacements. The context menu also contains an “Ignore All” item to add the
misspelled word to the session dictionary. And an “Add” item to add the word
to the personal dictionary.
For a basic use-case, there is the gspell_text_view_basic_setup() convenience
function.
The spell is checked only on the visible region of the GtkTextView. Note that if a same GtkTextBuffer is used for several views, the misspelled words are visible in all views, because the highlighting is achieved with a GtkTextTag added to the buffer.
If you don't use the gspell_text_view_basic_setup() function, you need to
call gspell_text_buffer_set_spell_checker() to associate a GspellChecker to
the GtkTextBuffer.
Note that GspellTextView extends the GtkTextView class but without subclassing it, because the GtkSourceView library has already a GtkTextView subclass.
If you want a PANGO_UNDERLINE_ERROR instead (a wavy underline), please fix
this bug first.
GspellTextView *
gspell_text_view_get_from_gtk_text_view
(GtkTextView *gtk_view);
Returns the GspellTextView of gtk_view
. The returned object is guaranteed
to be the same for the lifetime of gtk_view
.
void
gspell_text_view_basic_setup (GspellTextView *gspell_view);
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 “inline-spell-checking” property to TRUE.
Set the “enable-language-menu” property to TRUE.
Example:
1 2 3 4 5 |
GtkTextView *gtk_view; GspellTextView *gspell_view; gspell_view = gspell_text_view_get_from_gtk_text_view (gtk_view); gspell_text_view_basic_setup (gspell_view); |
This is equivalent to:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
GtkTextView *gtk_view; GspellTextView *gspell_view; GspellChecker *checker; GtkTextBuffer *gtk_buffer; GspellTextBuffer *gspell_buffer; checker = gspell_checker_new (NULL); gtk_buffer = gtk_text_view_get_buffer (gtk_view); gspell_buffer = gspell_text_buffer_get_from_gtk_text_buffer (gtk_buffer); gspell_text_buffer_set_spell_checker (gspell_buffer, checker); g_object_unref (checker); gspell_view = gspell_text_view_get_from_gtk_text_view (gtk_view); gspell_text_view_set_inline_spell_checking (gspell_view, TRUE); gspell_text_view_set_enable_language_menu (gspell_view, TRUE); |
Since: 1.2
gboolean
gspell_text_view_get_inline_spell_checking
(GspellTextView *gspell_view);
void gspell_text_view_set_inline_spell_checking (GspellTextView *gspell_view,gboolean enable);
Enables or disables the inline spell checking.
gboolean
gspell_text_view_get_enable_language_menu
(GspellTextView *gspell_view);
Since: 1.2
void gspell_text_view_set_enable_language_menu (GspellTextView *gspell_view,gboolean enable_language_menu);
Sets whether to enable the language context menu. If enabled, doing a right click on the GtkTextView will show a sub-menu to choose the language for the spell checking. If another language is chosen, it changes the “language” property of the “spell-checker” of the “buffer” of the “view”.
Since: 1.2
“enable-language-menu” property“enable-language-menu” gboolean
When the context menu is shown, whether to add a sub-menu to select the language for the spell checking.
Owner: GspellTextView
Flags: Read / Write
Default value: FALSE
Since: 1.2
“inline-spell-checking” property“inline-spell-checking” gboolean
Whether the inline spell checking is enabled.
Owner: GspellTextView
Flags: Read / Write
Default value: FALSE
“view” property“view” GtkTextView *
The GtkTextView.
Owner: GspellTextView
Flags: Read / Write / Construct Only