GspellInlineCheckerText

GspellInlineCheckerText — Inline spell checker for GtkTextView

Functions

Properties

gboolean enabled Read / Write
GtkTextView * view Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GspellInlineCheckerText

Includes

#include <gspell/gspell.h>

Description

The GspellInlineCheckerText 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 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.

Functions

gspell_text_view_get_inline_checker ()

GspellInlineCheckerText *
gspell_text_view_get_inline_checker (GtkTextView *view);

Returns the GspellInlineCheckerText of view . The returned object is guaranteed to be the same for the lifetime of view .

Parameters

view

a GtkTextView.

 

Returns

the GspellInlineCheckerText of view .

[transfer none]


gspell_inline_checker_text_set_enabled ()

void
gspell_inline_checker_text_set_enabled
                               (GspellInlineCheckerText *inline_checker,
                                gboolean enabled);

Enables or disables the inline spell checker.

Parameters

inline_checker

a GspellInlineCheckerText.

 

enabled

the new state.

 

gspell_inline_checker_text_get_enabled ()

gboolean
gspell_inline_checker_text_get_enabled
                               (GspellInlineCheckerText *inline_checker);

Parameters

inline_checker

a GspellInlineCheckerText.

 

Returns

whether the inline spell checker is enabled.

Types and Values

GspellInlineCheckerText

typedef struct _GspellInlineCheckerText GspellInlineCheckerText;

Property Details

The “enabled” property

  “enabled”                  gboolean

Whether the inline spell checker is enabled.

Flags: Read / Write

Default value: FALSE


The “view” property

  “view”                     GtkTextView *

The GtkTextView.

Flags: Read / Write / Construct Only