Cured some bugs/typos/spacing in docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3296 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-08-05 22:05:15 +00:00
parent e70f5e1301
commit 22d6efa851
45 changed files with 112 additions and 244 deletions

View File

@@ -3,7 +3,6 @@
% htmlwindow.tex at 14/Mar/99 20:13:37
%
\section{\class{wxHtmlWindow}}\label{wxhtmlwindow}
wxHtmlWindow is probably the only class you will directly use
@@ -18,7 +17,6 @@ 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
@@ -40,11 +38,9 @@ Constructor. The parameters are same as in wxScrollWindow ctor.
\wxheading{Parameters}
\docparam{style}{wxHW_SCROLLBAR_NEVER, or wxHW_SCROLLBAR_AUTO.
\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}}
@@ -63,7 +59,6 @@ If you want to load document from some location use
\docparam{source}{The HTML document source to be displayed.}
\wxheading{Return value}
FALSE if an error occured, TRUE otherwise
@@ -87,8 +82,6 @@ htmlwin -> SetPage("help/myproject/index.htm");
FALSE if an error occured, TRUE otherwise
\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
\func{wxString}{GetOpenedPage}{\void}
@@ -96,8 +89,6 @@ FALSE if an error occured, TRUE otherwise
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}}
@@ -106,16 +97,12 @@ 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}}
@@ -172,7 +159,6 @@ Under Windows:
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}}
@@ -185,7 +171,6 @@ This function sets the space between border of window and HTML contents. See ima
\docparam{b}{indentation from borders in pixels}
\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
@@ -202,14 +187,13 @@ Read values : all things set by SetFonts, SetBorders.
\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
Regardless path is given or not the function creates sub-path
{\tt wxHtmlWindow}
Saved values : all things set by SetFonts, SetBorders.
@@ -227,11 +211,9 @@ Saved values : all things set by SetFonts, SetBorders.
Returns pointer to the top-level container.
See also :
\helpref{Cells Overview}{cells},
See also: \helpref{Cells Overview}{cells},
\helpref{Printing Overview}{printing}
\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
@@ -245,7 +227,6 @@ filters. These filters are present by default:
\item Plain Text filter (this filter is used if no other filter matches)
\end{itemize}
\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
\func{bool}{HistoryBack}{\void}
@@ -253,7 +234,6 @@ filters. These filters are present by default:
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}
@@ -266,12 +246,10 @@ Moves to next page in history.
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
Called when user clicks on hypertext link. Default behaviour is to call
\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.