fix tricky regression noticed by Vyacheslav Tokarev on Google Reader.
[kdelibs.git] / khtml / README.HTMLWidget
blob571d4a94741dda312e197c3561e89a06480c0720
1 KDE HTML Widget
2 ===============
4 Developers
5 ----------
7 The first version was written by
9 Torben Weis <weis@stud.uni-frankfurt.de>
11 It was extended by
13 Josip A. Gracin <grac@fly.cc.fer.hr>,
14 Martin Jones <mjones@kde.org>,
15 Waldo Bastian <bastian@kde.org>
16 Lars Knoll <knoll@kde.org>
17 Antti Koivisto <koivisto@iki.fi>
18 Dirk Mueller <mueller@kde.org>
19 Peter Kelly <pmk@post.com>
21 It is currently primarily maintained and developed by
22 Lars Knoll, Dirk Mueller and Antti Koivisto.
25 Revision History
26 ----------------
28 This library is called libkhtml.
29 This library used to be called libkhtmlw. With the release of KDE 1.1 a 
30 source incompatible version called libkhtml has been created. 
31 libkhtmlw will not be maintained any more, all application writers are 
32 urgently requested to make use of the new libkhtml library.
35 Starting Point
36 --------------
38 You can add the widget to your program by doing something like:
40 #include <khtml.h>
42    .
43    .
44    .
46     KHTMLWidget *view = new KHTMLWidget( parent, "Name" );
47         view->show();
49         view->begin( "file:/tmp/test.html" );
50         view->parse();
51         view->write( "<HTML><TITLE>...." );
52         view->write( "..." );
53             .
54                 .
55                 .
56         view->write( "</HTML>" );
57         view->end();
60 After doing this, control must be returned to the event loop as the HTML
61 is parsed in the background using a Qt timer.
63 For more information see the full documentation in JavaDoc format included
64 in the header files.