GspellTextView: gspell 1 Reference Manual

## GspellTextView GspellTextView — Spell checking support for GtkTextView |

## Functions

GspellTextView * | gspell_text_view_get_from_gtk_text_view ()
GtkTextView * | gspell_text_view_get_view ()
gboolean | gspell_text_view_get_inline_spell_checking ()
void | gspell_text_view_set_inline_spell_checking ()

## Properties

gboolean | inline-spell-checking | Read / Write
GtkTextView * | view | Read / Write / Construct Only

## Types and Values

| GspellTextView

## Object Hierarchy

        GObject
        ╰── GspellTextView

## Includes

    #include <gspell/gspell.h>

## Description

GspellTextView extends the GtkTextView class with inline spell checking. Misspelled words are highlighted with a `PANGO_UNDERLINE_ERROR`, usually a red wavy underline. 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.

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.

You need to call `gspell_text_buffer_set_spell_checker()` to associate a GspellChecker to the GtkTextBuffer. “buffer” changes are handled, as well as GspellChecker changes.

Note that GspellTextView extends the GtkTextView class but without subclassing it, because the GtkSourceView library has already a GtkTextView subclass.

## Functions

### gspell_text_view_get_from_gtk_text_view ()

    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` .

#### Parameters

gtk_view | a GtkTextView. |

#### Returns

the GspellTextView of `gtk_view` .

[transfer none]

### gspell_text_view_get_view ()

    GtkTextView *
    gspell_text_view_get_view (GspellTextView *gspell_view);

#### Parameters

gspell_view | a GspellTextView. |

#### Returns

the GtkTextView of `gspell_view` .

[transfer none]

### gspell_text_view_get_inline_spell_checking ()

    gboolean
    gspell_text_view_get_inline_spell_checking
                                   (GspellTextView *gspell_view);

#### Parameters

gspell_view | a GspellTextView. |

#### Returns

whether the inline spell checking is enabled.

### gspell_text_view_set_inline_spell_checking ()

    void
    gspell_text_view_set_inline_spell_checking
                                   (GspellTextView *gspell_view,
                                    gboolean enable);

Enables or disables the inline spell checking.

#### Parameters

gspell_view | a GspellTextView. |
enable | the new state. |

## Types and Values

### GspellTextView

    typedef struct _GspellTextView GspellTextView;

## Property Details

### The `“inline-spell-checking”` property

      “inline-spell-checking”    gboolean

Whether the inline spell checking is enabled.

Flags: Read / Write

Default value: FALSE

### The `“view”` property

      “view”                     GtkTextView *

The GtkTextView.

Flags: Read / Write / Construct Only