File: Mainpage.dox

package info (click to toggle)
kde4libs 4:4.14.2-5+deb8u2
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 82,428 kB
  • ctags: 99,415
  • sloc: cpp: 761,864; xml: 12,344; ansic: 6,295; java: 4,060; perl: 2,938; yacc: 2,507; python: 1,207; sh: 1,179; ruby: 337; lex: 278; makefile: 29
file content (65 lines) | stat: -rw-r--r-- 1,957 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
	A dummy source file for documenting the library.
	Sirtaj Singh Kang <taj@kde.org>
	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.
<p>
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.
Sonnet 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 Sonnet 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.

SonnetConfig holds configuration information about Sonnet as well
as acting as an options-setting dialog.

Sonnet usually works asynchronously. If you do not need that, you should
simply use Sonnet::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 Sonnet dialog.

@see Sonnet, SonnetConfig

@authors
Various: see the copyright headers of the individual files.

@maintainers
See the
<a href="http://websvn.kde.org/trunk/KDE/kdelibs/kdeui/MAINTAINERS?view=markup">MAINTAINERS</a>
file.

@licenses
@lgpl

*/

/**

\defgroup KDEUIMacros KDEUI Macros

*/

// DOXYGEN_REFERENCES = kdecore
// DOXYGEN_SET_INTERNAL_DOCS = YES
// DOXYGEN_SET_PROJECT_NAME = KDEUI
// DOXYGEN_SET_RECURSIVE = YES
// DOXYGEN_EXCLUDE_PATTERNS = *_p.h */tests/*
// vim:ts=4:sw=4:expandtab:filetype=doxygen