ugh. Nesting the (per class) plugin sentries can require them to

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

diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex
index d7456b77c5712b8887e97218da5468ec285c6981..0d4ce6ecb4b43ef82ded9eac63c731cc6e0d3df0 100644 (file)
--- 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
 %
 
 % 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
 \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}. 
 
 \helpref{SetPage(text)}{wxhtmlwindowsetpage} or 
 \helpref{LoadPage(filename)}{wxhtmlwindowloadpage}. 
 

-

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-wxScrolledWindow
+\helpref{wxScrolledWindow}{wxscrolledwindow}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wxhtml/wxhtmlwin.h>
+<wx/html/htmlwin.h>

 
 \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
 
 
 \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
 


@@ -33,60 +31,59 @@ wxScrolledWindow
 
 Default constructor.
 
 
 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 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}
 
 
 \wxheading{Parameters}
 

-\docparam{style}{wxHW_SCROLLBAR_NEVER,  or wxHW_SCROLLBAR_AUTO. 
-Affects appearance of vertical scrollbar in the window.}
+\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::AppendToPage}\label{wxhtmlwindowappendtopage}

 
 

-\begin{verbatim}
-htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
-\end{verbatim}
+\func{bool}{AppendToPage}{\param{const wxString\& }{source}}

 
 

-If you want to load document from some location use
-\helpref{LoadPage}{wxhtmlwindowloadpage} instead.
+Appends HTML fragment to currently displayed text and refreshes the window. 

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{source}{The HTML document source to be displayed.}
-
+\docparam{source}{HTML code fragment}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-FALSE if an error occured, TRUE otherwise
-
-\membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
-
-\func{bool}{LoadPage}{\param{const wxString\& }{location}}
+FALSE if an error occurred, TRUE otherwise.

 
 

-Unlike SetPage this function first loads HTML page from {\it location}
-and then displays it. See example:
+\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}

 
 

-\begin{verbatim}
-htmlwin -> SetPage("help/myproject/index.htm");
-\end{verbatim}
+\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}

 
 

-\wxheading{Parameters}
+Returns pointer to the top-level container.

 
 

-\docparam{location}{The address of document. See \helpref{wxFileSystem}{wxfilesystem} for details on address format and behaviour of "opener".}
+See also: \helpref{Cells Overview}{cells}, 
+\helpref{Printing Overview}{printing}

 
 

-\wxheading{Return value}
+\membersection{wxHtmlWindow::GetOpenedAnchor}\label{wxhtmlwindowgetopenedanchor}

 
 

-FALSE if an error occured, TRUE otherwise
+\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}
 
 
 \membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}


@@ -96,18 +93,11 @@ 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.
 
 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}

 
 

-\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.
-
-
-
+Returns title of the opened page or wxEmptyString if current page does not contain {\tt <TITLE>} tag.

 
 \membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
 
 
 \membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
 


@@ -115,75 +105,105 @@ frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
 
 Returns the related frame.
 
 
 Returns the related frame.
 

+\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}

 
 

-\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
+\func{bool}{HistoryBack}{\void}

 
 

-\func{void}{SetRelatedStatusBar}{\param{int }{bar}}
+Moves back to the previous page. (each page displayed using 
+\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)

 
 

-{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
-this sets statusbar slot where messages will be displayed.
-(Default is -1 = no messages.)
+\membersection{wxHtmlWindow::HistoryCanBack}\label{wxhtmlwindowhistorycanback}

 
 

-\wxheading{Parameters}
+\func{bool}{HistoryCanBack}{\void}

 
 

-\docparam{bar}{statusbar slot number (0..n)}
+Returns true if it is possible to go back in the history (i.e. HistoryBack()
+won't fail).

 
 

-\membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
+\membersection{wxHtmlWindow::HistoryCanForward}\label{wxhtmlwindowhistorycanforward}

 
 

-\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{bool}{HistoryCanForward}{\void}

 
 

-This function sets font sizes and faces.
+Returns true if it is possible to go forward in the history (i.e. HistoryBack()
+won't fail).

 
 

-\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.}
+\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}

 
 

-\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.}
+\func{void}{HistoryClear}{\void}

 
 

-\docparam{fixed_face}{The same thing for fixed face ( <TT>..</TT> )}
+Clears history.

 
 

-\docparam{fixed_italic_mode}{The same thing for fixed face.}
+\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}

 
 

-\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> )}
+\func{bool}{HistoryForward}{\void}

 
 

-\wxheading{Defaults}
+Moves to next page in history.

 
 

-Under wxGTK:
+\membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}

 
 

-\begin{verbatim}
-    SetFonts("", wxSLANT, "", wxSLANT, {10, 12, 14, 16, 19, 24, 32});
-\end{verbatim}
+\func{virtual bool}{LoadPage}{\param{const wxString\& }{location}}

 
 

-Under Windows:
+Unlike SetPage this function first loads HTML page from {\it location} 
+and then displays it. See example:

 
 \begin{verbatim}
 
 \begin{verbatim}

-    SetFonts("", wxSLANT, "", wxSLANT, {7, 8, 10, 12, 16, 22, 30});
+htmlwin -> SetPage("help/myproject/index.htm");

 \end{verbatim}
 
 \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)
+\wxheading{Parameters}

 
 

+\docparam{location}{The address of document. See \helpref{wxFileSystem}{wxfilesystem} for details on address format and behaviour of "opener".}

 
 

-\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
+\wxheading{Return value}

 
 

-\func{void}{SetBorders}{\param{int }{b}}
+FALSE if an error occurred, TRUE otherwise

 
 

-This function sets the space between border of window and HTML contents. See image:
+\membersection{wxHtmlWindow::OnCellClicked}\label{wxhtmlwindowoncellclicked}

 
 

-\image{}{border.bmp}
+\func{virtual void}{OnCellClicked}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxMouseEvent\& }{event}}
+
+This method is called when a mouse button is clicked inside wxHtmlWindow.
+The default behaviour is to call 
+\helpref{OnLinkClicked}{wxhtmlwindowonlinkclicked} if the cell contains a
+hypertext link.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{b}{indentation from borders in pixels}
+\docparam{cell}{The cell inside which the mouse was clicked, always a simple
+(i.e. non container) cell}
+
+\docparam{x, y}{The logical coordinates of the click point}
+
+\docparam{event}{The mouse event containing other information about the click}
+
+\membersection{wxHtmlWindow::OnCellMouseHover}\label{wxhtmlwindowoncellmousehover}
+
+\func{virtual void}{OnCellMouseHover}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}}
+
+This method is called when a mouse moves over an HTML cell.
+
+\wxheading{Parameters}
+
+\docparam{cell}{The cell inside which the mouse is currently, always a simple
+(i.e. non container) cell}
+
+\docparam{x, y}{The logical coordinates of the click point}
+
+\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
+
+\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}
+
+\func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}}
+
+Called on parsing {\tt <TITLE>} tag.

 
 
 \membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
 
 
 \membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}


@@ -194,84 +214,119 @@ 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}
 
 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.
+Read values: all things set by SetFonts, SetBorders.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{cfg}{wxConfig from which you wanna read configuration}
+\docparam{cfg}{wxConfig from which you want to read the configuration.}

 
 \docparam{path}{Optional path in config tree. If not given current path is used.}
 
 
 \docparam{path}{Optional path in config tree. If not given current path is used.}
 

+\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}

 
 

-\membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
+\func{void}{SetBorders}{\param{int }{b}}

 
 

-\func{virtual void}{WriteCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
+This function sets the space between border of window and HTML contents. See image:

 
 

-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}
+\helponly{\image{}{border.bmp}}
+
+\wxheading{Parameters}
+
+\docparam{b}{indentation from borders in pixels}
+
+\membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}

 
 

-Saved values : all things set by SetFonts, SetBorders.
+\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes}}
+
+This function sets font sizes and faces.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{cfg}{wxConfig to which you wanna save configuration}
+\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{path}{Optional path in config tree. If not given current path is used.}
+\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
+( <FONT SIZE=-2> to <FONT SIZE=+4> )}

 
 

-\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}
+\wxheading{Defaults}

 
 

-\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}
+Under wxGTK:

 
 

-Returns pointer to the top-level container.
+\begin{verbatim}
+    SetFonts("", "", {10, 12, 14, 16, 19, 24, 32});
+\end{verbatim}

 
 

-See also : 
-\helpref{Cells Overview}{cells},
-\helpref{Printing Overview}{printing}
+Under Windows:

 
 

+\begin{verbatim}
+    SetFonts("", "", {7, 8, 10, 12, 16, 22, 30});
+\end{verbatim}

 
 

-\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
+Athough it seems different the fact is that the fonts are of approximately
+same size under both platforms (due to wxMSW / wxGTK inconsistency)

 
 

-\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}
-\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:

 
 

+\begin{verbatim}
+htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
+\end{verbatim}

 
 

-\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
+If you want to load a document from some location use 
+\helpref{LoadPage}{wxhtmlwindowloadpage} instead.

 
 

-\func{bool}{HistoryBack}{\void}
+\wxheading{Parameters}

 
 

-Moves back to the previous page. (each page displayed using 
-\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
+\docparam{source}{The HTML document source to be displayed.}

 
 

+\wxheading{Return value}

 
 

-\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
+FALSE if an error occurred, TRUE otherwise.

 
 

-\func{bool}{HistoryForward}{\void}
+\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}

 
 

-Moves to next page in history.
+\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}

 
 

-\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
+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.

 
 

-\func{void}{HistoryClear}{\void}
+\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}

 
 

-Clears history.
+\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.)

 
 

-\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
+\wxheading{Parameters}
+
+\docparam{bar}{statusbar slot number (0..n)}

 
 

-\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.
+\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 of whether the 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 want to save the configuration.}

 
 

+\docparam{path}{Optional path in config tree. If not given, the current path is used.}