summaryrefslogtreecommitdiffstats
path: root/kdeui/README.kspell
diff options
context:
space:
mode:
Diffstat (limited to 'kdeui/README.kspell')
-rw-r--r--kdeui/README.kspell17
1 files changed, 17 insertions, 0 deletions
diff --git a/kdeui/README.kspell b/kdeui/README.kspell
new file mode 100644
index 000000000..9ae1afe84
--- /dev/null
+++ b/kdeui/README.kspell
@@ -0,0 +1,17 @@
+KSpell, by David Sweet
+----------------------
+KSpell provides an interface to ASpell and International ISpell 3.1. You
+should use it like a UI widget to provide spellchecking in your application.
+See kspell.h and http://www.chaos.umd.edu/~dsweet/KDE/KSpell for
+documentation.
+
+Settings
+--------
+A configuration dialog/widget is also provided. This class (KSpellConfig) acts
+not only as a widget allowing the user to set KSpell preferences, but also
+as a data abstraction class allowing you to get and set the preferences from
+within your program. You can pass an instance of KSpellConfig to KSpell
+and the spellchecker will run with the appropriate preference settings. The
+preferences, when saved (see kspelldlg.h) are saved globally. If needed,
+you can read them with KSpellDlg and set and use application-specific
+spellchecking settings.