.. module:: wx.html
.. include:: headings.inc
=========================================================================
**wx.html**
=========================================================================
This module contains a widget class and supporting classes for a generic HTML
renderer. It supports only a subset of the HTML standards, and no Javascript
or CSS, but it is relatively lightweight and has no platform dependencies. It
is suitable for displaying simple HTML documents, such as the application's
documentation or built-in help pages.
.. note:: Due to some internal dynamic initialization in wxWidgets, this
module should be imported **before** the :class:`wx.App` object is
created.
Class Summary
=============
================================================================================ ================================================================================
**Class** **Short Description**
================================================================================ ================================================================================
`~wx.html.HtmlBookRecord` Helper class for :ref:`wx.html.HtmlHelpData`.
`~wx.html.HtmlCell` Internal data structure.
`~wx.html.HtmlCellEvent` This event class is used for the events generated by :ref:`wx.html.HtmlWindow`.
`~wx.html.HtmlColourCell` This cell changes the colour of either the background or the foreground.
`~wx.html.HtmlContainerCell` The :ref:`wx.html.HtmlContainerCell` class is an implementation of a cell that may contain more cells in it.
`~wx.html.HtmlDCRenderer` This class can render HTML document into a specified area of a DC.
`~wx.html.HtmlEasyPrinting` This class provides very simple interface to printing architecture.
`~wx.html.HtmlFilter` This class is the parent class of input filters for :ref:`wx.html.HtmlWindow`.
`~wx.html.HtmlFontCell` This cell represents a font change in the document stream.
`~wx.html.HtmlHelpController` This help controller provides an easy way of displaying HTML help in your application (see :ref:`HTML Sample <html sample>`, test example).
`~wx.html.HtmlHelpData` This class is used by :ref:`wx.html.HtmlHelpController` and :ref:`wx.html.HtmlHelpFrame` to access HTML help items.
`~wx.html.HtmlHelpDataItem` Helper class for :ref:`wx.html.HtmlHelpData`.
`~wx.html.HtmlHelpDialog` This class is used by :ref:`wx.html.HtmlHelpController` to display help.
`~wx.html.HtmlHelpFrame` This class is used by :ref:`wx.html.HtmlHelpController` to display help.
`~wx.html.HtmlHelpWindow` This class is used by :ref:`wx.html.HtmlHelpController` to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.
`~wx.html.HtmlLinkEvent` This event class is used for the events generated by :ref:`wx.html.HtmlWindow`.
`~wx.html.HtmlLinkInfo` This class stores all necessary information about hypertext links (as represented by <A> tag in HTML documents).
`~wx.html.HtmlListBox` :ref:`wx.html.HtmlListBox` is an implementation of :ref:`wx.VListBox` which shows HTML content in the listbox rows.
`~wx.html.HtmlModalHelp` This class uses :ref:`wx.html.HtmlHelpController` to display help in a modal dialog.
`~wx.html.HtmlParser` Classes derived from this handle the **generic** parsing of HTML documents: it scans the document and divide it into blocks of tags (where one block consists of beginning and ending tag and of text between these two tags).
`~wx.html.HtmlPrintout` This class serves as printout class for HTML documents.
`~wx.html.HtmlRenderingInfo` This class contains information given to cells when drawing them.
`~wx.html.HtmlRenderingState` Selection state is passed to :meth:`wx.html.HtmlCell.Draw` so that it can render itself differently e.g.
`~wx.html.HtmlRenderingStyle` :ref:`wx.html.HtmlSelection` is data holder with information about text selection.
`~wx.html.HtmlSelection`
`~wx.html.HtmlTag` This class represents a single HTML tag.
`~wx.html.HtmlTagHandler`
`~wx.html.HtmlWidgetCell` :ref:`wx.html.HtmlWidgetCell` is a class that provides a connection between HTML cells and widgets (an object derived from :ref:`wx.Window`).
`~wx.html.HtmlWindow` :ref:`wx.html.HtmlWindow` is probably the only class you will directly use unless you want to do something special (like adding new tag handlers or MIME filters).
`~wx.html.HtmlWindowInterface` Abstract interface to a HTML rendering window (such as :ref:`wx.html.HtmlWindow` or :ref:`wx.html.HtmlListBox`) that is passed to :ref:`wx.html.HtmlWinParser`.
`~wx.html.HtmlWinParser` This class is derived from :ref:`wx.html.HtmlParser` and its main goal is to parse HTML input so that it can be displayed in :ref:`wx.html.HtmlWindow`.
`~wx.html.HtmlWinTagHandler` This is basically :ref:`wx.html.HtmlTagHandler` except that it is extended with protected member m_WParser pointing to the :ref:`wx.html.HtmlWinParser` object (value of this member is identical to :ref:`wx.html.HtmlParser`'s m_Parser).
`~wx.html.HtmlWordCell` This html cell represents a single word or text fragment in the document stream.
`~wx.html.HtmlWordWithTabsCell` :ref:`wx.html.HtmlWordCell` is a specialization for storing text fragments with embedded tab characters.
`~wx.html.SimpleHtmlListBox` :ref:`wx.html.SimpleHtmlListBox` is an implementation of :ref:`wx.html.HtmlListBox` which shows HTML content in the listbox rows.
================================================================================ ================================================================================
Functions Summary
=================
================================================================================ ================================================================================
**Function** **Short Description**
================================================================================ ================================================================================
:func:`~wx.html.HtmlWinParser_AddTagHandler` :rtype: `None`
================================================================================ ================================================================================
.. toctree::
:maxdepth: 1
:hidden:
wx.html.HtmlBookRecord
wx.html.HtmlCell
wx.html.HtmlCellEvent
wx.html.HtmlColourCell
wx.html.HtmlContainerCell
wx.html.HtmlDCRenderer
wx.html.HtmlEasyPrinting
wx.html.HtmlFilter
wx.html.HtmlFontCell
wx.html.HtmlHelpController
wx.html.HtmlHelpData
wx.html.HtmlHelpDataItem
wx.html.HtmlHelpDialog
wx.html.HtmlHelpFrame
wx.html.HtmlHelpWindow
wx.html.HtmlLinkEvent
wx.html.HtmlLinkInfo
wx.html.HtmlListBox
wx.html.HtmlModalHelp
wx.html.HtmlOpeningStatus.enumeration
wx.html.HtmlParser
wx.html.HtmlPrintout
wx.html.HtmlRenderingInfo
wx.html.HtmlRenderingState
wx.html.HtmlRenderingStyle
wx.html.HtmlScriptMode.enumeration
wx.html.HtmlSelection
wx.html.HtmlSelectionState.enumeration
wx.html.HtmlTag
wx.html.HtmlTagHandler
wx.html.HtmlURLType.enumeration
wx.html.HtmlWidgetCell
wx.html.HtmlWinParser
wx.html.HtmlWinTagHandler
wx.html.HtmlWindow
wx.html.HtmlWindowInterface
wx.html.HtmlWordCell
wx.html.HtmlWordWithTabsCell
wx.html.SimpleHtmlListBox
wx.html2.WebViewFindFlags.enumeration
wx.html2.WebViewIE_EmulationLevel.enumeration
wx.html2.WebViewNavigationActionFlags.enumeration
wx.html2.WebViewNavigationError.enumeration
wx.html2.WebViewReloadFlags.enumeration
wx.html2.WebViewUserScriptInjectionTime.enumeration
wx.html2.WebViewZoom.enumeration
wx.html2.WebViewZoomType.enumeration
wx.html.functions