summaryrefslogtreecommitdiffstats
path: root/tdehtml/README.HTMLWidget
diff options
context:
space:
mode:
authorDarrell Anderson <[email protected]>2013-03-02 15:57:34 -0600
committerDarrell Anderson <[email protected]>2013-03-02 15:57:34 -0600
commit7c0b0c9dc9fcbe9c198925bdc7ee18ac6be49f4f (patch)
treec76702a7f6310fbe9d437e347535422e836e94e9 /tdehtml/README.HTMLWidget
parenta2a38be7600e2a2c2b49c66902d912ca036a2c0f (diff)
parent27bbee9a5f9dcda53d8eb23863ee670ad1360e41 (diff)
downloadtdelibs-7c0b0c9dc9fcbe9c198925bdc7ee18ac6be49f4f.tar.gz
tdelibs-7c0b0c9dc9fcbe9c198925bdc7ee18ac6be49f4f.zip
Merge branch 'master' of http://scm.trinitydesktop.org/scm/git/tdelibs
Diffstat (limited to 'tdehtml/README.HTMLWidget')
-rw-r--r--tdehtml/README.HTMLWidget66
1 files changed, 66 insertions, 0 deletions
diff --git a/tdehtml/README.HTMLWidget b/tdehtml/README.HTMLWidget
new file mode 100644
index 000000000..cae4a3c58
--- /dev/null
+++ b/tdehtml/README.HTMLWidget
@@ -0,0 +1,66 @@
+KDE HTML Widget
+===============
+
+Developers
+----------
+
+The first version was written by
+
+Torben Weis <[email protected]>
+
+It was extended by
+
+Josip A. Gracin <[email protected]>,
+Martin Jones <[email protected]>,
+Waldo Bastian <[email protected]>
+Lars Knoll <[email protected]>
+Antti Koivisto <[email protected]>
+Dirk Mueller <[email protected]>
+Peter Kelly <[email protected]>
+
+It is currently primarily maintained and developed by
+Lars Knoll, Dirk Mueller and Antti Koivisto.
+
+
+Revision History
+----------------
+
+This library is called libtdehtml.
+This library used to be called libtdehtmlw. With the release of KDE 1.1 a
+source incompatible version called libtdehtml has been created.
+libtdehtmlw will not be maintained any more, all application writers are
+urgently requested to make use of the new libtdehtml library.
+
+
+Starting Point
+--------------
+
+You can add the widget to your program by doing something like:
+
+#include <tdehtml.h>
+
+ .
+ .
+ .
+
+ TDEHTMLWidget *view = new TDEHTMLWidget( parent, "Name" );
+ view->show();
+
+ view->begin( "file:/tmp/test.html" );
+ view->parse();
+ view->write( "<HTML><TITLE>...." );
+ view->write( "..." );
+ .
+ .
+ .
+ view->write( "</HTML>" );
+ view->end();
+
+
+After doing this, control must be returned to the event loop as the HTML
+is parsed in the background using a Qt timer.
+
+For more information see the full documentation in JavaDoc format included
+in the header files.
+
+