/* gtkspell - a spell-checking addon for GTK's TextView widget
* Copyright (c) 2002 Evan Martin.
*/
Introduction
------------
GtkSpell provides MSWord/MacOSX-style highlighting of misspelled words in a
GtkTextView widget. Right-clicking a misspelled word pops up a menu of
suggested replacements.
GtkSpell is a library, to be used by your software.
GtkSpell depends on GTK+ 2.0 (of course), and also on Enchant
library, which can be found at http://www.abisource.com/projects/enchant/ .
For more information, see http://gtkspell.sf.net .
Use
---
The easiest way to learn is to look at the provided example programs.
It's pretty simple.
Use gtkspell_new_attach() to attach a new GtkSpell to a GtkTextView.
Be sure to read the glib documentation on GError if you're unfamiliar
with it-- GtkSpell will return NULL on error.
Memory management is handled by GtkSpell so you don't need to keep a
pointer to the GtkSpell object around. If you need to modify settings
or detach a GtkSpell, you can retrieve it from a GtkTextView with
gtkspell_get_from_text_view().
Once you have a pointer to a GtkSpell, you can change the language it
uses with gtkspell_set_language(). Use gtkspell_detach() to remove the
GtkSpell from its attached buffer. (This will also free the GtkSpell
object.) Finally, gtkspell_recheck_all() is provided to re-spellcheck
the entire buffer, but it shouldn't be necessary.
Finally, gtkspell.h serves as an API reference.
Original Author
---------------
Evan Martin <martine@danga.com> - http://neugierig.org/
Previous Maintainer
-------------------
Nathan Fredrickson <nathan@silverorange.com>
Current Developer and Maintainer
--------------------------------
Eduardo PĂ©rez Ureta <eperez@users.sourceforge.net> - http://edpeur.blogspot.com/
Thanks
------
Ari Pollak <ari@debian.org> - Debian packages.
Alex <hansolo@rochester.rr.com> - Redhat packages.
vim: tw=72