22d6efa851
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3296 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
256 lines
8.1 KiB
TeX
256 lines
8.1 KiB
TeX
%
|
|
% automatically generated by HelpGen from
|
|
% htmlwindow.tex at 14/Mar/99 20:13:37
|
|
%
|
|
|
|
\section{\class{wxHtmlWindow}}\label{wxhtmlwindow}
|
|
|
|
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)
|
|
|
|
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
|
|
\helpref{SetPage(text)}{wxhtmlwindowsetpage} or
|
|
\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
wxScrolledWindow
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wxhtml/wxhtmlwin.h>
|
|
|
|
\membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
|
|
|
|
\func{}{wxHtmlWindow}{\void}
|
|
|
|
Default constructor.
|
|
|
|
\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... :-)
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{style}{wxHW\_SCROLLBAR\_NEVER, or wxHW\_SCROLLBAR\_AUTO.
|
|
Affects appearance of vertical scrollbar in the window.}
|
|
|
|
\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
|
|
|
|
\func{bool}{SetPage}{\param{const wxString\& }{source}}
|
|
|
|
Sets HTML page and display it. This won't {\bf load} the page!!
|
|
It will display the {\it source}. See example:
|
|
|
|
\begin{verbatim}
|
|
htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
|
|
\end{verbatim}
|
|
|
|
If you want to load document from some location use
|
|
\helpref{LoadPage}{wxhtmlwindowloadpage} instead.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{source}{The HTML document source to be displayed.}
|
|
|
|
\wxheading{Return value}
|
|
|
|
FALSE if an error occured, TRUE otherwise
|
|
|
|
\membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
|
|
|
|
\func{bool}{LoadPage}{\param{const wxString\& }{location}}
|
|
|
|
Unlike SetPage this function first loads HTML page from {\it location}
|
|
and then displays it. See example:
|
|
|
|
\begin{verbatim}
|
|
htmlwin -> SetPage("help/myproject/index.htm");
|
|
\end{verbatim}
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{location}{The address of document. See \helpref{wxFileSystem}{wxfilesystem} for details on address format and behaviour of "opener".}
|
|
|
|
\wxheading{Return value}
|
|
|
|
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::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
|
|
|
|
\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
|
|
|
|
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.
|
|
|
|
\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
|
|
|
|
\constfunc{wxFrame*}{GetRelatedFrame}{\void}
|
|
|
|
Returns the related frame.
|
|
|
|
\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{bar}{statusbar slot number (0..n)}
|
|
|
|
\membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
|
|
|
|
\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{int }{*sizes}}
|
|
|
|
This function sets font sizes and faces.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\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.
|
|
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_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
|
|
( <FONT SIZE=-2> to <FONT SIZE=+4> )}
|
|
|
|
\wxheading{Defaults}
|
|
|
|
Under wxGTK:
|
|
|
|
\begin{verbatim}
|
|
SetFonts("", wxSLANT, "", wxSLANT, {10, 12, 14, 16, 19, 24, 32});
|
|
\end{verbatim}
|
|
|
|
Under Windows:
|
|
|
|
\begin{verbatim}
|
|
SetFonts("", wxSLANT, "", wxSLANT, {7, 8, 10, 12, 16, 22, 30});
|
|
\end{verbatim}
|
|
|
|
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}
|
|
|
|
\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::ReadCustomization}\label{wxhtmlwindowreadcustomization}
|
|
|
|
\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
|
|
|
|
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}
|
|
|
|
Read values : all things set by SetFonts, SetBorders.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{cfg}{wxConfig from which you wanna read configuration}
|
|
|
|
\docparam{path}{Optional path in config tree. If not given current path is used.}
|
|
|
|
\membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
|
|
|
|
\func{virtual void}{WriteCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
|
|
|
|
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}
|
|
|
|
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.}
|
|
|
|
|
|
\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.
|
|
|