} 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::HistoryCanBack}\label{wxhtmlwindowhistorycanback} + +\func{bool}{HistoryCanBack}{\void} + +Returns true if it is possible to go back in the history (i.e. HistoryBack() +won't fail). + +\membersection{wxHtmlWindow::HistoryCanForward}\label{wxhtmlwindowhistorycanforward} + +\func{bool}{HistoryCanForward}{\void} + +Returns true if it is possible to go forward in the history (i.e. HistoryBack() +won't fail). + + +\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} @@ -84,71 +142,67 @@ htmlwin -> SetPage("help/myproject/index.htm"); \wxheading{Return value} -FALSE if an error occured, TRUE otherwise +FALSE if an error occurred, TRUE otherwise +\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} +\func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}} -\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage} +Called when user clicks on hypertext link. Default behaviour is to call +\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else. -\func{wxString}{GetOpenedPage}{\void} +Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}. -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::OnSetTitle}\label{wxhtmlwindowonsettitle} +\func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}} -\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} +Called on parsing {\tt <TITLE>} tag. -\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::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. -\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe} +\wxheading{Parameters} -\constfunc{wxFrame*}{GetRelatedFrame}{\void} +\docparam{cfg}{wxConfig from which you want to read the configuration.} -Returns the related frame. +\docparam{path}{Optional path in config tree. If not given current path is used.} +\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} -\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} +\func{void}{SetBorders}{\param{int }{b}} -\func{void}{SetRelatedStatusBar}{\param{int }{bar}} +This function sets the space between border of window and HTML contents. See image: -{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe}, -this sets statusbar slot where messages will be displayed. -(Default is -1 = no messages.) +\helponly{\image{}{border.bmp}} \wxheading{Parameters} -\docparam{bar}{statusbar slot number (0..n)} +\docparam{b}{indentation from borders in pixels} \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}} +\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const 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. +\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{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )} \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 @@ -159,47 +213,59 @@ The values represent size of font with HTML size from -2 to +4 Under wxGTK: \begin{verbatim} - SetFonts("", wxSLANT, "", wxSLANT, {10, 12, 14, 16, 19, 24, 32}); + SetFonts("", "", {10, 12, 14, 16, 19, 24, 32}); \end{verbatim} Under Windows: \begin{verbatim} - SetFonts("", wxSLANT, "", wxSLANT, {7, 8, 10, 12, 16, 22, 30}); + SetFonts("", "", {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::SetPage}\label{wxhtmlwindowsetpage} -\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} +\func{bool}{SetPage}{\param{const wxString\& }{source}} -\func{void}{SetBorders}{\param{int }{b}} +Sets HTML page and display it. This won't {\bf load} the page!! +It will display the {\it source}. See example: -This function sets the space between border of window and HTML contents. See image: +\begin{verbatim} +htmlwin -> SetPage("<html><body>Hello, world!</body></html>"); +\end{verbatim} -\image{}{border.bmp} +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.} +\wxheading{Return value} -\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization} +FALSE if an error occurred, TRUE otherwise. -\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}} +\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} -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} +\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}} -Read values : all things set by SetFonts, SetBorders. +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. -\wxheading{Parameters} +\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} -\docparam{cfg}{wxConfig from which you wanna read configuration} +\func{void}{SetRelatedStatusBar}{\param{int }{bar}} -\docparam{path}{Optional path in config tree. If not given current path is used.} +{\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::WriteCustomization}\label{wxhtmlwindowwritecustomization} @@ -208,69 +274,14 @@ Read values : all things set by SetFonts, SetBorders. 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.} - - -\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{cfg}{wxConfig to which you want to save the configuration.} +\docparam{path}{Optional path in config tree. If not given, the current path is used.}

X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/704a4b7524e05d7bf4d208eb1b30be9989abef4c..07e285be620715a9c22ee7ae820c983bcdedbf88:/docs/latex/wx/htwindow.tex diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index ae85e3ba6d..a763720138 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -3,29 +3,27 @@ % 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) +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}. - \wxheading{Derived from} -wxScrolledWindow +\helpref{wxScrolledWindow}{wxscrolledwindow} \wxheading{Include files} - + \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow} @@ -33,45 +31,105 @@ wxScrolledWindow Default constructor. -\func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const wxString\& }{name = "htmlWindow"}, \param{bool }{scrollable = TRUE}} +\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{scrollable}{if false then no scrollbars are displayed, even if size of page is larger than window size} +\docparam{style}{wxHW\_SCROLLBAR\_NEVER, or wxHW\_SCROLLBAR\_AUTO. +Affects the appearance of vertical scrollbar in the window.} +\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter} +\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}} -\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage} +Adds \helpref{input filter}{filters} to the static list of available +filters. These filters are present by default: -\func{bool}{SetPage}{\param{const wxString\& }{source}} +\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} -Sets HTML page and display it. This won't {\bf load} the page!! -It will display the {\it source}. See example: +\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation} -\begin{verbatim} -htmlwin -> SetPage("Hello, world!"); -\end{verbatim} +\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void} -If you want to load document from some location use -\helpref{LoadPage}{wxhtmlwindowloadpage} instead. +Returns pointer to the top-level container. -\wxheading{Parameters} +See also: \helpref{Cells Overview}{cells}, +\helpref{Printing Overview}{printing} -\docparam{source}{The HTML document source to be displayed.} +\membersection{wxHtmlWindow::GetOpenedAnchor}\label{wxhtmlwindowgetopenedanchor} +\func{wxString}{GetOpenedAnchor}{\void} -\wxheading{Return value} +Returns anchor within currently opened page +(see \helpref{GetOpenedPage}{wxhtmlwindowgetopenedpage}). +If no page is opened or if the displayed page wasn't +produced by call to LoadPage, empty string is returned. + + +\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} -FALSE if an error occured, TRUE otherwise +Returns title of the opened page or wxEmptyString if current page does not contain {\tt } 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::HistoryCanBack}\label{wxhtmlwindowhistorycanback} + +\func{bool}{HistoryCanBack}{\void} + +Returns true if it is possible to go back in the history (i.e. HistoryBack() +won't fail). + +\membersection{wxHtmlWindow::HistoryCanForward}\label{wxhtmlwindowhistorycanforward} + +\func{bool}{HistoryCanForward}{\void} + +Returns true if it is possible to go forward in the history (i.e. HistoryBack() +won't fail). + + +\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} @@ -84,71 +142,67 @@ htmlwin -> SetPage("help/myproject/index.htm"); \wxheading{Return value} -FALSE if an error occured, TRUE otherwise +FALSE if an error occurred, TRUE otherwise +\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} +\func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}} -\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage} +Called when user clicks on hypertext link. Default behaviour is to call +\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else. -\func{wxString}{GetOpenedPage}{\void} +Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}. -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::OnSetTitle}\label{wxhtmlwindowonsettitle} +\func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}} -\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} +Called on parsing {\tt <TITLE>} tag. -\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::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. -\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe} +\wxheading{Parameters} -\constfunc{wxFrame*}{GetRelatedFrame}{\void} +\docparam{cfg}{wxConfig from which you want to read the configuration.} -Returns the related frame. +\docparam{path}{Optional path in config tree. If not given current path is used.} +\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} -\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} +\func{void}{SetBorders}{\param{int }{b}} -\func{void}{SetRelatedStatusBar}{\param{int }{bar}} +This function sets the space between border of window and HTML contents. See image: -{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe}, -this sets statusbar slot where messages will be displayed. -(Default is -1 = no messages.) +\helponly{\image{}{border.bmp}} \wxheading{Parameters} -\docparam{bar}{statusbar slot number (0..n)} +\docparam{b}{indentation from borders in pixels} \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}} +\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const 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. +\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{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )} \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 @@ -159,47 +213,59 @@ The values represent size of font with HTML size from -2 to +4 Under wxGTK: \begin{verbatim} - SetFonts("", wxSLANT, "", wxSLANT, {10, 12, 14, 16, 19, 24, 32}); + SetFonts("", "", {10, 12, 14, 16, 19, 24, 32}); \end{verbatim} Under Windows: \begin{verbatim} - SetFonts("", wxSLANT, "", wxSLANT, {7, 8, 10, 12, 16, 22, 30}); + SetFonts("", "", {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::SetPage}\label{wxhtmlwindowsetpage} -\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} +\func{bool}{SetPage}{\param{const wxString\& }{source}} -\func{void}{SetBorders}{\param{int }{b}} +Sets HTML page and display it. This won't {\bf load} the page!! +It will display the {\it source}. See example: -This function sets the space between border of window and HTML contents. See image: +\begin{verbatim} +htmlwin -> SetPage("<html><body>Hello, world!</body></html>"); +\end{verbatim} -\image{}{border.bmp} +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.} +\wxheading{Return value} -\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization} +FALSE if an error occurred, TRUE otherwise. -\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}} +\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} -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} +\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}} -Read values : all things set by SetFonts, SetBorders. +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. -\wxheading{Parameters} +\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} -\docparam{cfg}{wxConfig from which you wanna read configuration} +\func{void}{SetRelatedStatusBar}{\param{int }{bar}} -\docparam{path}{Optional path in config tree. If not given current path is used.} +{\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::WriteCustomization}\label{wxhtmlwindowwritecustomization} @@ -208,69 +274,14 @@ Read values : all things set by SetFonts, SetBorders. 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.} - - -\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{cfg}{wxConfig to which you want to save the configuration.} +\docparam{path}{Optional path in config tree. If not given, the current path is used.}