-\membersection{Quick Start}\label{quickstart}
+\subsection{wxHTML quick start}\label{wxhtmlquickstart}
-\wxheading{Displaying HMTL}
+\wxheading{Displaying HTML}
First of all, you must include <wx/wxhtml.h>.
Class \helpref{wxHtmlWindow}{wxhtmlwindow} (derived from wxScrolledWindow)
is used to display HTML documents.
-It has 2 important methods : \helpref{LoadPage}{wxhtmlwindowloadpage}
+It has two important methods: \helpref{LoadPage}{wxhtmlwindowloadpage}
and \helpref{SetPage}{wxhtmlwindowsetpage}.
LoadPage loads and displays HTML file while SetPage displays directly the
passed {\bf string}. See the example:
mywin -> LoadPage("test.htm");
mywin -> SetPage("<html><body>"
"<h1>Error</h1>"
- "Some error occured :-H)"
- "</body></hmtl>");
+ "Some error occurred :-H)"
+ "</body></hmtl>");
\end{verbatim}
-I think the difference is quite clear...
-
\wxheading{Displaying Help}
See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
\wxheading{Setting up wxHtmlWindow}
Because wxHtmlWindow is derived from wxScrolledWindow and not from
-wxFrame, it doesn't have visible frame. But the user usually want to see
-the title of HTML page displayed somewhere and frame's titlebar is
-ideal place for it...
+wxFrame, it doesn't have visible frame. But the user usually wants to see
+the title of HTML page displayed somewhere and the frame's titlebar is
+the ideal place for it.
-wxHtmlWindow provides 2 methods in order to handle this :
+wxHtmlWindow provides 2 methods in order to handle this:
\helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe} and
\helpref{SetRelatedStatusBar}{wxhtmlwindowsetrelatedstatusbar}.
See the example:
html -> SetRelatedStatusBar(0);
\end{verbatim}
-The first command associates html object with it's parent frame
-(this points to wxFrame object there) and sets format of title.
+The first command associates the HTML object with its parent frame
+(this points to wxFrame object there) and sets the format of the title.
Page title "Hello, world!" will be displayed as "HTML : Hello, world!"
in this example.
You can customize wxHtmlWindow by setting font size, font face and
borders (space between border of window and displayed HTML). Related functions:
-\begin{itemize}
+\begin{itemize}\itemsep=0pt
\item \helpref{SetFonts}{wxhtmlwindowsetfonts}
\item \helpref{SetBorders}{wxhtmlwindowsetborders}
\item \helpref{ReadCustomization}{wxhtmlwindowreadcustomization}
\end{itemize}
The last two functions are used to store user customization info wxConfig stuff
-(for example registry under Windows or dotfile under Unix)
+(for example in the registry under Windows, or in a dotfile under Unix).
projects / wxWidgets.git / blobdiff