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)
+handlers or MIME filters).
-Purpose of this class is to display HTML page (either local
-file or downloaded via HTTP protocol) in a window. Width
-of window is constant - given in constructor - virtual height
-is changed dynamicly depending on page size.
-Once the window is created you can set it's content by calling
+The purpose of this class is to display HTML pages (either local
+file or downloaded via HTTP protocol) in a window. 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
\helpref{SetPage(text)}{wxhtmlwindowsetpage} or
\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
\func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxHW_SCROLLBAR_AUTO}, \param{const wxString\& }{name = "htmlWindow"}}
-Constructor. The parameters are same as in wxScrollWindow ctor.
-(Too lazy to document it once again... :-)
+Constructor. The parameters are the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor.
\wxheading{Parameters}
\docparam{style}{wxHW\_SCROLLBAR\_NEVER, or wxHW\_SCROLLBAR\_AUTO.
-Affects appearance of vertical scrollbar in the window.}
+Affects the appearance of vertical scrollbar in the window.}
-\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
+\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
-\func{bool}{SetPage}{\param{const wxString\& }{source}}
+\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
-Sets HTML page and display it. This won't {\bf load} the page!!
-It will display the {\it source}. See example:
+Adds \helpref{input filter}{filters} to the static list of available
+filters. These filters are present by default:
-\begin{verbatim}
-htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
-\end{verbatim}
+\begin{itemize}\itemsep=0pt
+\item {\tt text/html} MIME type
+\item {\tt image/*} MIME types
+\item Plain Text filter (this filter is used if no other filter matches)
+\end{itemize}
-If you want to load document from some location use
-\helpref{LoadPage}{wxhtmlwindowloadpage} instead.
+\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}
-\wxheading{Parameters}
+\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}
-\docparam{source}{The HTML document source to be displayed.}
+Returns pointer to the top-level container.
-\wxheading{Return value}
+See also: \helpref{Cells Overview}{cells},
+\helpref{Printing Overview}{printing}
-FALSE if an error occured, TRUE otherwise
+\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
+
+\func{wxString}{GetOpenedPage}{\void}
+
+Returns full location of the opened page. If no page is opened or if the displayed page wasn't
+produced by call to LoadPage, empty string is returned.
+
+\membersection{wxHtmlWindow::GetOpenedPageTitle}\label{wxhtmlwindowgetopenedpagetitle}
+
+\func{wxString}{GetOpenedPageTitle}{\void}
+
+Returns title of the opened page or wxEmptyString if current page does not contain {\tt <TITLE>} tag.
+
+\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
+
+\constfunc{wxFrame*}{GetRelatedFrame}{\void}
+
+Returns the related frame.
+
+\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
+
+\func{bool}{HistoryBack}{\void}
+
+Moves back to the previous page. (each page displayed using
+\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
+
+\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
+
+\func{void}{HistoryClear}{\void}
+
+Clears history.
+
+\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
+
+\func{bool}{HistoryForward}{\void}
+
+Moves to next page in history.
\membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
\func{bool}{LoadPage}{\param{const wxString\& }{location}}
-Unlike SetPage this function first loads HTML page from {\it location}
+Unlike SetPage this function first loads HTML page from {\it location}
and then displays it. See example:
\begin{verbatim}
FALSE if an error occured, TRUE otherwise
-\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
+\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
-\func{wxString}{GetOpenedPage}{\void}
+\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}}
-Returns full location of the opened page. If no page is opened or if the displayed page wasn't
-produced by call to LoadPage, empty string is returned.
+Called when user clicks on hypertext link. Default behaviour is to call
+\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
-\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
-\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
+\membersection{wxHtmlWindow::OnSetTitle}\label{wxhtmlwindowonsettitle}
-Sets frame in which page title will be displayed. {\it format} is format of
-frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
-\%s is substituted with HTML page title.
+\func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}}
-\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
+Called on parsing {\tt <TITLE>} tag.
-\constfunc{wxFrame*}{GetRelatedFrame}{\void}
-Returns the related frame.
+\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
-\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
+\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
-\func{void}{SetRelatedStatusBar}{\param{int }{bar}}
+This reads custom settings from wxConfig. It uses the path 'path'
+if given, otherwise it saves info into currently selected path.
+The values are stored in sub-path {\tt wxHtmlWindow}
-{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
-this sets statusbar slot where messages will be displayed.
-(Default is -1 = no messages.)
+Read values: all things set by SetFonts, SetBorders.
\wxheading{Parameters}
-\docparam{bar}{statusbar slot number (0..n)}
+\docparam{cfg}{wxConfig from which you want to read the configuration.}
+
+\docparam{path}{Optional path in config tree. If not given current path is used.}
+
+\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
+
+\func{void}{SetBorders}{\param{int }{b}}
+
+This function sets the space between border of window and HTML contents. See image:
+
+\image{}{border.bmp}
+
+\wxheading{Parameters}
+
+\docparam{b}{indentation from borders in pixels}
\membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
\wxheading{Parameters}
-\docparam{normal_face}{This is face name for normal (i.e. non-fixed) font.
+\docparam{normal\_face}{This is face name for normal (i.e. non-fixed) font.
It can be either empty string (then the default face is choosen) or
platform-specific face name. Examples are "helvetica" under Unix or
"Times New Roman" under Windows.}
-\docparam{normal_italic_mode}{This is either wxSLANT or wxITALIC.
+\docparam{normal\_italic\_mode}{This is either wxSLANT or wxITALIC.
It determines how
italic (<I>..</I>) text is handled. See wxFont documentation for
details. For example you should use wxSLANT in conjuction with
"helvetica" face or wxITALIC with "times" face.}
-\docparam{fixed_face}{The same thing for fixed face ( <TT>..</TT> )}
+\docparam{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )}
-\docparam{fixed_italic_mode}{The same thing for fixed face.}
+\docparam{fixed\_italic\_mode}{The same thing for fixed face.}
\docparam{sizes}{This is an array of 7 items of {\it int} type.
The values represent size of font with HTML size from -2 to +4
Athough it seems different the fact is that the fonts are of approximately
same size under both platforms (due to wxMSW / wxGTK inconsistency)
-\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
+\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
-\func{void}{SetBorders}{\param{int }{b}}
+\func{bool}{SetPage}{\param{const wxString\& }{source}}
-This function sets the space between border of window and HTML contents. See image:
+Sets HTML page and display it. This won't {\bf load} the page!!
+It will display the {\it source}. See example:
-\image{}{border.bmp}
+\begin{verbatim}
+htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
+\end{verbatim}
+
+If you want to load a document from some location use
+\helpref{LoadPage}{wxhtmlwindowloadpage} instead.
\wxheading{Parameters}
-\docparam{b}{indentation from borders in pixels}
+\docparam{source}{The HTML document source to be displayed.}
-\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
+\wxheading{Return value}
-\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
+FALSE if an error occured, TRUE otherwise.
-This reads custom settings from wxConfig. It uses the path 'path'
-if given, otherwise it saves info into currently selected path.
-The values are stored in sub-path {\tt wxHtmlWindow}
+\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
-Read values : all things set by SetFonts, SetBorders.
+\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
+
+Sets the frame in which page title will be displayed. {\it format} is format of
+frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
+\%s is substituted with HTML page title.
+
+\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
+
+\func{void}{SetRelatedStatusBar}{\param{int }{bar}}
+
+{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
+this sets statusbar slot where messages will be displayed.
+(Default is -1 = no messages.)
\wxheading{Parameters}
-\docparam{cfg}{wxConfig from which you wanna read configuration}
+\docparam{bar}{statusbar slot number (0..n)}
-\docparam{path}{Optional path in config tree. If not given current path is used.}
\membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
Saves custom settings into wxConfig. It uses the path 'path'
if given, otherwise it saves info into currently selected path.
-Regardless path is given or not the function creates sub-path
-{\tt wxHtmlWindow}
+Regardless of whether the path is given or not, the function creates sub-path
+{\tt wxHtmlWindow}.
-Saved values : all things set by SetFonts, SetBorders.
+Saved values: all things set by SetFonts, SetBorders.
\wxheading{Parameters}
-\docparam{cfg}{wxConfig to which you wanna save configuration}
-
-\docparam{path}{Optional path in config tree. If not given current path is used.}
-
+\docparam{cfg}{wxConfig to which you want to save the configuration.}
-\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}
-
-\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}
-
-Returns pointer to the top-level container.
-
-See also: \helpref{Cells Overview}{cells},
-\helpref{Printing Overview}{printing}
-
-\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
-
-\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
-
-Adds \helpref{input filter}{filters} to the static list of available
-filters. These filters are present by default:
-
-\begin{itemize}
-\item {\tt text/html} MIME type
-\item {\tt image/*} MIME types
-\item Plain Text filter (this filter is used if no other filter matches)
-\end{itemize}
-
-\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
-
-\func{bool}{HistoryBack}{\void}
-
-Moves back to the previous page. (each page displayed using
-\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
-
-\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
-
-\func{bool}{HistoryForward}{\void}
-
-Moves to next page in history.
-
-\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
-
-\func{void}{HistoryClear}{\void}
-
-Clears history.
-
-\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
-
-\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}}
-
-Called when user clicks on hypertext link. Default behaviour is to call
-\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
+\docparam{path}{Optional path in config tree. If not given, the current path is used.}
projects / wxWidgets.git / blobdiff