X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d5db80c26999bab5ad0ee610aeaa59ffb0e9c1c6..5740d24a02d9dbc46cc62268a910f1a23e13003d:/docs/latex/wx/htwindow.tex?ds=sidebyside diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index 0c47bc0c07..a763720138 100644 --- 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} - + \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} @@ -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} @@ -164,7 +191,7 @@ This function sets the space between border of window and HTML contents. See ima \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{const int }{*sizes}} +\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes}} This function sets font sizes and faces. @@ -175,16 +202,8 @@ 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 (..) 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 ( .. )} -\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 ( to )} @@ -194,13 +213,13 @@ 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 @@ -226,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}