]> git.saurik.com Git - wxWidgets.git/commitdiff
Update wxHtmlWindow documentation to refer to wxWebView.
authorSteve Lamerton <steve.lamerton@gmail.com>
Tue, 8 Nov 2011 11:35:38 +0000 (11:35 +0000)
committerSteve Lamerton <steve.lamerton@gmail.com>
Tue, 8 Nov 2011 11:35:38 +0000 (11:35 +0000)
Closes #13608

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69700 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/html/htmlwin.h

index ef7dde2599531d5e0871d4d9c523800ef5c79136..9ad78baac9e7f92b71df79ddaa7239870ba4ce09 100644 (file)
     wxHtmlWindow is probably the only class you will directly use unless you want
     to do something special (like adding new tag handlers or MIME filters).
 
     wxHtmlWindow is probably the only class you will directly use unless you want
     to do something special (like adding new tag handlers or MIME filters).
 
-    The purpose of this class is to display HTML pages (either local file or
-    downloaded via HTTP protocol) in a window.
+    The purpose of this class is to display rich content pages (either local file or
+    downloaded via HTTP protocol) in a window based on a subset of the HTML standard.
     The width of the window is constant - given in the constructor - and virtual height
     is changed dynamically depending on page size.
     Once the window is created you can set its content by calling SetPage() with raw HTML,
     LoadPage() with a wxFileSystem location or LoadFile() with a filename.
 
     The width of the window is constant - given in the constructor - and virtual height
     is changed dynamically depending on page size.
     Once the window is created you can set its content by calling SetPage() with raw HTML,
     LoadPage() with a wxFileSystem location or LoadFile() with a filename.
 
+    @note
+    If you want complete HTML/CSS support as well as a Javascript engine, see instead
+    wxWebView.
+
     @note
     wxHtmlWindow uses the wxImage class for displaying images, as such you need to
     initialize the handlers for any image formats you use before loading a page.
     @note
     wxHtmlWindow uses the wxImage class for displaying images, as such you need to
     initialize the handlers for any image formats you use before loading a page.