summaryrefslogtreecommitdiffstats
path: root/kdeui/Mainpage.dox
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kdeui/Mainpage.dox
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kdeui/Mainpage.dox')
-rw-r--r--kdeui/Mainpage.dox43
1 files changed, 43 insertions, 0 deletions
diff --git a/kdeui/Mainpage.dox b/kdeui/Mainpage.dox
new file mode 100644
index 000000000..1e360ee1c
--- /dev/null
+++ b/kdeui/Mainpage.dox
@@ -0,0 +1,43 @@
+/*
+ A dummy source file for documenting the library.
+ Sirtaj Singh Kang <taj@kde.org>
+ $Id$
+ Distributed under the LGPL.
+*/
+
+/**
+* @mainpage The KDE User Interface library
+*
+* This library provides standard user interface elements for use in
+* KDE applications. If your KDE application has a GUI, you will almost
+* certainly link to libkdeui.
+*
+* Most applications with single or multiple toplevel widgets
+* should use the KMainWindow class in this library, which
+* automatically provides features like session management and simplified
+* toolbar/menubar/statusbar creation.
+*
+* A spell-checker library is also provided.
+* KSpell offers easy access to International ISpell or ASpell
+* (at the user's option) as well as a spell-checker GUI
+* ("Add", "Replace", etc.).
+*
+* You can use KSpell to
+* automatically spell-check an ASCII file as well as to implement
+* online spell-checking and to spell-check proprietary format and
+* marked up (e.g. HTML, TeX) documents. The relevant methods for
+* these three procedures are check(), checkWord(), and
+* checkList(), respectively.
+*
+* KSpellConfig holds configuration information about KSpell as well
+* as acting as an options-setting dialog.
+*
+* KSpell usually works asynchronously. If you do not need that, you should
+* simply use KSpell::modalCheck(). It won't return until the
+* passed string is processed or the spell checking canceled.
+* During modal spell checking your GUI is still repainted, but the user may
+* only interact with the KSpell dialog.
+*
+* @see KSpell, KSpellConfig
+*/
+