GspellInlineCheckerGtv: gspell Reference Manual

## GspellInlineCheckerGtv GspellInlineCheckerGtv — Inline spell checker for GtkTextView |

## Functions

GspellInlineCheckerGtv * | gspell_inline_checker_gtv_new ()
void | gspell_inline_checker_gtv_attach_view ()
void | gspell_inline_checker_gtv_detach_view ()

## Properties

GtkSourceBuffer * | buffer | Read / Write / Construct Only
GspellChecker * | spell-checker | Read / Write / Construct Only

## Types and Values

| GspellInlineCheckerGtv

## Object Hierarchy

        GObject
        ╰── GspellInlineCheckerGtv

## Includes

    #include <gspell/gspell.h>

## Description

The GspellInlineCheckerGtv is an inline spell checker for the GtkTextView widget. 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 regions of the attached GtkTextView's.

## Functions

### gspell_inline_checker_gtv_new ()

    GspellInlineCheckerGtv *
    gspell_inline_checker_gtv_new (GtkSourceBuffer *buffer,
                                   GspellChecker *checker);

#### Parameters

buffer | a GtkSourceBuffer. |
checker | a GspellChecker. |

#### Returns

a new GspellInlineCheckerGtv object.

### gspell_inline_checker_gtv_attach_view ()

    void
    gspell_inline_checker_gtv_attach_view (GspellInlineCheckerGtv *spell,
                                           GtkTextView *view);

Enables the inline spell checker for `view` . `view` must have the same buffer as the “buffer” property.

#### Parameters

spell | a GspellInlineCheckerGtv. |
view | a GtkTextView. |

### gspell_inline_checker_gtv_detach_view ()

    void
    gspell_inline_checker_gtv_detach_view (GspellInlineCheckerGtv *spell,
                                           GtkTextView *view);

Disables the inline spell checker for `view` .

#### Parameters

spell | a GspellInlineCheckerGtv. |
view | a GtkTextView. |

## Types and Values

### GspellInlineCheckerGtv

    typedef struct _GspellInlineCheckerGtv GspellInlineCheckerGtv;

## Property Details

### The `“buffer”` property

      “buffer”                   GtkSourceBuffer *

The GtkSourceBuffer. If a same buffer is used for several views, the misspelled words are visible in all views, because GtkTextTag's are added to the buffer.

Flags: Read / Write / Construct Only

### The `“spell-checker”` property

      “spell-checker”            GspellChecker *

The GspellChecker to use.

Flags: Read / Write / Construct Only

## See Also

GspellChecker