X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3e65f74e180f1252b1c03bf146b5dad4cc7bec68..35f95708e3aee076d779ba31c6b871afb5c50daf:/docs/doxygen/overviews/html.h diff --git a/docs/doxygen/overviews/html.h b/docs/doxygen/overviews/html.h index 370001478c..9c3d8bcbb0 100644 --- a/docs/doxygen/overviews/html.h +++ b/docs/doxygen/overviews/html.h @@ -10,6 +10,8 @@ @page overview_html wxHTML Overview +@tableofcontents + The wxHTML library provides classes for parsing and displaying HTML. It is not intended to be a high-end HTML browser. If you are looking for something like that try . @@ -27,36 +29,27 @@ See @c src/html/m_*.cpp files for details. There is a generic wxHtmlParser class, independent of wxHtmlWindow. -@li @ref overview_html_quickstart -@li @ref overview_html_printing -@li @ref overview_html_helpformats -@li @ref overview_html_filters -@li @ref overview_html_cells -@li @ref overview_html_handlers -@li @ref overview_html_supptags - - -
-@section overview_html_quickstart wxHTML quick start +@section overview_html_quickstart wxHTML Quick Start @subsection overview_html_quickstart_disphtml Displaying HTML First of all, you must include @c wx/wxhtml.h. -Class wxHtmlWindow (derived from ::wxScrolledWindow) is used to display HTML documents. +Class wxHtmlWindow (derived from ::wxScrolledWindow) is used to display HTML +documents. It has two important methods: wxHtmlWindow::LoadPage and wxHtmlWindow::SetPage. LoadPage loads and displays HTML file while SetPage displays directly the passed @b string. See the example: @code - mywin -> LoadPage("test.htm"); - mywin -> SetPage("htmlbody" - "h1Error/h1" - "Some error occurred :-H)" - "/body/hmtl"); +mywin->LoadPage("test.htm"); +mywin->SetPage("htmlbody" + "h1Error/h1" + "Some error occurred :-H)" + "/body/hmtl"); @endcode @subsection overview_html_quickstart_settingup Setting up wxHtmlWindow @@ -71,9 +64,9 @@ wxHtmlWindow::SetRelatedFrame and wxHtmlWindow::SetRelatedStatusBar. See the example: @code - html = new wxHtmlWindow(this); - html -> SetRelatedFrame(this, "HTML : %%s"); - html -> SetRelatedStatusBar(0); +html = new wxHtmlWindow(this); +html->SetRelatedFrame(this, "HTML : %%s"); +html->SetRelatedStatusBar(0); @endcode The first command associates the HTML object with its parent frame @@ -101,32 +94,33 @@ The last two functions are used to store user customization info wxConfig stuff @section overview_html_printing HTML Printing -The wxHTML library provides printing facilities with several levels of complexity. -The easiest way to print an HTML document is to use the wxHtmlEasyPrinting class. +The wxHTML library provides printing facilities with several levels of +complexity. The easiest way to print an HTML document is to use the +wxHtmlEasyPrinting class. -It lets you print HTML documents with only one command and you don't have to worry -about deriving from the wxPrintout class at all. It is only a simple wrapper around the -wxHtmlPrintout, normal wxWidgets printout class. +It lets you print HTML documents with only one command and you don't have to +worry about deriving from the wxPrintout class at all. It is only a simple +wrapper around the wxHtmlPrintout, normal wxWidgets printout class. And finally there is the low level class wxHtmlDCRenderer which you can use to -render HTML into a rectangular area on any DC. +render HTML into a rectangular area on any DC. It supports rendering into +multiple rectangles with the same width. The most common use of this is placing +one rectangle on each page or printing into two columns. -It supports rendering into multiple rectangles with the same -width. (The most common use of this is placing one rectangle on each page or -printing into two columns.) @section overview_html_helpformats Help Files Format -wxHTML library can be used to show an help manual to the user; in fact, it supports -natively (through wxHtmlHelpController) a reduced version of MS HTML Workshop format. +wxHTML library can be used to show an help manual to the user; in fact, it +supports natively (through wxHtmlHelpController) a reduced version of MS HTML +Workshop format. A @b book consists of three files: the header file, the contents file and the index file. -You can make a regular zip archive of these files, plus the HTML and any -image files, for wxHTML (or helpview) to read; and the @c ".zip" file can -optionally be renamed to @c ".htb". +You can make a regular zip archive of these files, plus the HTML and any image +files, for wxHTML (or helpview) to read; and the @c ".zip" file can optionally +be renamed to @c ".htb". @subsection overview_html_helpformats_hhp Header file (.hhp) @@ -159,56 +153,54 @@ It contains exactly one list (@c <ul>....@c </ul> statement): @code