kdeui/Mainpage.dox

   1 /*
   2         A dummy source file for documenting the library.
   3         Sirtaj Singh Kang <taj@kde.org>
   4         Distributed under the LGPL.
   5 */
   6
   7 /** @mainpage The KDE User Interface Library
   8
   9 This library provides standard user interface elements for use in
  10 %KDE applications. If your %KDE application has a GUI, you will almost
  11 certainly link to libkdeui.
  12 <p>
  13 Most applications with single or multiple toplevel widgets
  14 should use the KMainWindow class in this library, which
  15 automatically provides features like session management and simplified
  16 toolbar/menubar/statusbar creation.
  17
  18 A spell-checker library is also provided.
  19 Sonnet offers easy access to International ISpell or ASpell
  20 (at the user's option) as well as a spell-checker GUI
  21 ("Add", "Replace", etc.).
  22
  23 You can use Sonnet to
  24 automatically spell-check an ASCII file as well as to implement
  25 online spell-checking and to spell-check proprietary format and
  26 marked up (e.g. HTML, TeX) documents.  The relevant methods for
  27 these three procedures are check(), checkWord(), and
  28 checkList(), respectively.
  29
  30 SonnetConfig holds configuration information about Sonnet as well
  31 as acting as an options-setting dialog.
  32
  33 Sonnet usually works asynchronously. If you do not need that, you should
  34 simply use Sonnet::modalCheck(). It won't return until the
  35 passed string is processed or the spell checking canceled.
  36 During modal spell checking your GUI is still repainted, but the user may
  37 only interact with the Sonnet dialog.
  38
  39 @see Sonnet, SonnetConfig
  40
  41 @authors
  42 Various: see the copyright headers of the individual files.
  43
  44 @maintainers
  45 See the
  46 <a href="http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/MAINTAINERS?view=markup">MAINTAINERS</a>
  47 file.
  48
  49 @licenses
  50 @lgpl
  51
  52 */
  53
  54 // DOXYGEN_REFERENCES = kdecore
  55 // DOXYGEN_SET_INTERNAL_DOCS = YES
  56 // DOXYGEN_SET_PROJECT_NAME = KDEUI
  57 // vim:ts=4:sw=4:expandtab:filetype=doxygen