updated wxTextFile docs; some typo corrections

[wxWidgets.git] / docs / latex / wx / htwindow.tex

diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex
index bbca02309e30dc00ba7c9ed3a7889983868a0674..e386da35f973b6386d7f1ac64e384795aa675007 100644 (file)
--- a/docs/latex/wx/htwindow.tex
+++ b/docs/latex/wx/htwindow.tex
@@ -13,17 +13,17 @@ 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
+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}
 
-<wxhtml/wxhtmlwin.h>
+<wx/html/htmlwin.h>
 
 \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
 
@@ -31,7 +31,7 @@ wxScrolledWindow
 
 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"}}
+\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 the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor.
 
@@ -62,6 +62,16 @@ Returns pointer to the top-level container.
 See also: \helpref{Cells Overview}{cells}, 
 \helpref{Printing Overview}{printing}
 
+\membersection{wxHtmlWindow::GetOpenedAnchor}\label{wxhtmlwindowgetopenedanchor}
+
+\func{wxString}{GetOpenedAnchor}{\void}
+
+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}
@@ -88,6 +98,21 @@ Returns the related frame.
 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}
@@ -102,7 +127,7 @@ Moves to next page in history.
 
 \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
 
-\func{bool}{LoadPage}{\param{const wxString\& }{location}}
+\func{virtual bool}{LoadPage}{\param{const wxString\& }{location}}
 
 Unlike SetPage this function first loads HTML page from {\it location} 
 and then displays it. See example:
@@ -117,15 +142,17 @@ 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 wxString\& }{link}}
+\func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}}
 
 Called when user clicks on hypertext link. Default behaviour is to call 
 \helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
 
+Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
+
 
 \membersection{wxHtmlWindow::OnSetTitle}\label{wxhtmlwindowonsettitle}
 
@@ -156,7 +183,7 @@ Read values: all things set by SetFonts, SetBorders.
 
 This function sets the space between border of window and HTML contents. See image:
 
-\image{}{border.bmp}
+\helponly{\image{}{border.bmp}}
 
 \wxheading{Parameters}
 
@@ -218,7 +245,7 @@ If you want to load a document from some location use
 
 \wxheading{Return value}
 
-FALSE if an error occured, TRUE otherwise.
+FALSE if an error occurred, TRUE otherwise.
 
 \membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}