added wxMemoryFSHandler docs

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

diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index d8019eb86b30f7c28be8e6bd0305bda67624bf1f..9e3237254516d8fa3dc6528c8c3818fef9178c68 100644 (file)
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -3,25 +3,29 @@
 % htmlwinparser.tex at 14/Mar/99 20:13:37
 %
 
 % htmlwinparser.tex at 14/Mar/99 20:13:37
 %
 

+

 \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
 
 \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
 

-This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and 
+This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and

 its mail goal is to parse HTML input so that it can be displayed in
 its mail goal is to parse HTML input so that it can be displayed in

-\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special 
+\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special

 \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
 
 \wxheading{Notes}
 
 \begin{enumerate}
 \item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.
 \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
 
 \wxheading{Notes}
 
 \begin{enumerate}
 \item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.

-\item This parser produces temporary data! You should call 
-\helpref{delete GetTempData()}{wxhtmlparsergettempdata}!

 \end{enumerate}
 
 \wxheading{Derived from}
 
 \helpref{wxHtmlParser}{wxhtmlparser}
 
 \end{enumerate}
 
 \wxheading{Derived from}
 
 \helpref{wxHtmlParser}{wxhtmlparser}
 

+
+\wxheading{Include files}
+
+<wx/html/winpars.h>
+

 \wxheading{See Also}
 
 \helpref{Handlers overview}{handlers}
 \wxheading{See Also}
 
 \helpref{Handlers overview}{handlers}


@@ -54,7 +58,7 @@ and returns pointer to it (see \helpref{Overview}{cells}).
 
 \func{virtual wxFont*}{CreateCurrentFont}{\void}
 
 
 \func{virtual wxFont*}{CreateCurrentFont}{\void}
 

-Creates font based on current setting (see 
+Creates font based on current setting (see

 \helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
 \helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
 \helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
 \helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
 \helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
 \helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},


@@ -63,9 +67,6 @@ Creates font based on current setting (see
 and returns pointer to it.
 (If the font was already created only a pointer is returned.)
 
 and returns pointer to it.
 (If the font was already created only a pointer is returned.)
 

-Fonts created during parsing are temporary data and are not freed on DoneParser. 
-You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata}
-to free the memory!

 
 \membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
 
 
 \membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
 


@@ -114,12 +115,28 @@ m_WParser -> GetContainer() -> InsertCell(new ...);
 
 Returns pointer to the DC used during parsing.
 
 
 Returns pointer to the DC used during parsing.
 

+
+\membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter}
+
+\constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void}
+
+Returns \helpref{wxEncodingConverter}{wxencodingconverter} class used
+to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding}
+and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
+

 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \constfunc{int}{GetFontBold}{\void}
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \constfunc{int}{GetFontBold}{\void}
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 

+\membersection{wxHtmlWinParser::GetFontFace}\label{wxhtmlwinparsergetfontface}
+
+\constfunc{wxString}{GetFontFace}{\void}
+
+Returns actual font face name.
+
+

 \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
 
 \constfunc{int}{GetFontFixed}{\void}
 \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
 
 \constfunc{int}{GetFontFixed}{\void}


@@ -145,13 +162,21 @@ Returns actual font size (HTML size varies from -2 to +4)
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 

+\membersection{wxHtmlWinParser::GetInputEncoding}\label{wxhtmlwinparsergetinputencoding}
+
+\constfunc{wxFontEncoding}{GetInputEncoding}{\void}
+
+Returns input encoding.
+
+

 \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
 
 \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
 

-\constfunc{const wxString\&}{GetLink}{\void}
+\constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void}

 
 

-Returns actual hypertext link. (This value is non-empty string
+Returns actual hypertext link. (This value has non-empty
+\helpref{Href}{wxhtmllinkinfogethref} string

 if the parser is between {\tt <A>} and {\tt </A>} tags,
 if the parser is between {\tt <A>} and {\tt </A>} tags,

-wxEmptyString otherwise.
+wxEmptyString otherwise.)

 
 
 \membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
 
 
 \membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}


@@ -160,6 +185,14 @@ wxEmptyString otherwise.
 
 Returns color of hypertext link text.
 
 
 Returns color of hypertext link text.
 

+
+\membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding}
+
+\constfunc{wxFontEncoding}{GetOutputEncoding}{\void}
+
+Returns output encoding, i.e. closest match to document's input encoding
+that is supported by operating system.
+

 \membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
 
 \func{wxWindow*}{GetWindow}{\void}
 \membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
 
 \func{wxWindow*}{GetWindow}{\void}


@@ -175,37 +208,41 @@ title only if some window is associated, otherwise it does nothing)
 
 Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
 
 
 Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
 

-%
+

 \membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
 
 \func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
 
 \membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
 
 \func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
 

-Sets actual text color. Note: this DOESN'T change the color! 
+Sets actual text color. Note: this DOESN'T change the color!

 You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 
 \func{void}{SetAlign}{\param{int }{a}}
 
 You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 
 \func{void}{SetAlign}{\param{int }{a}}
 

-Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
+Sets default horizontal alignment (see
+\helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)

 Alignment of newly opened container is set to this value.
 
 Alignment of newly opened container is set to this value.
 

-%\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
-%
-%\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
-%
-%Allows you to directly set opened container. This is not recommended - you should use OpenContainer
-%whereever possible.
-%
+
+\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
+
+\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
+
+Allows you to directly set opened container. This is not recommended - you should use OpenContainer
+whereever possible.
+

 
 \membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
 
 
 \membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
 

-\func{virtual void}{SetDC}{\param{wxDC }{*dc}, \param{double }{pixel_scale = 1.0}
+\func{virtual void}{SetDC}{\param{wxDC }{*dc}, \param{double }{pixel\_scale = 1.0}}
+
+Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
+{\it pixel\_scale}  can be used when rendering to high-resolution 
+DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in 
+HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
+inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)

 
 

-Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}! {\it pixel_scale} 
-can be used when rendering to high-resolution DCs (e.g. printer) to adjust size of pixel metrics.
-(Many dimensions in HTML are given in pixels - e.g. image sizes. 300x300 image would be only one
-inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)

 
 \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
 
 
 \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
 


@@ -213,6 +250,14 @@ inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
 
 Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
 
 
 Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
 

+\membersection{wxHtmlWinParser::SetFontFace}\label{wxhtmlwinparsersetfontface}
+
+\func{void}{SetFontFace}{\param{const wxString\& }{face}}
+
+Sets current font face to {\it face}. This affects either fixed size
+font or proportional, depending on context (whether the parser is 
+inside {\tt <TT>} tag or not).
+

 \membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
 
 \func{void}{SetFontFixed}{\param{int }{x}}
 \membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
 
 \func{void}{SetFontFixed}{\param{int }{x}}


@@ -225,11 +270,12 @@ Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
 
 Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
 
 
 Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
 

+

 \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
 
 \func{void}{SetFontSize}{\param{int }{s}}
 
 \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
 
 \func{void}{SetFontSize}{\param{int }{s}}
 

-Sets actual font size (HTML size varies from -2 to +4)
+Sets actual font size (HTML size varies from 1 to 7)

 
 \membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
 
 
 \membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
 


@@ -239,15 +285,27 @@ Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
 
 \membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}
 
 
 \membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}
 

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

 
 Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
 
 
 Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
 

+
+\membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
+
+\func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}}
+
+Sets input encoding. The parser uses this information to build conversion
+tables from document's encoding to some encoding supported by operating
+system.
+
+

 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 

-\func{void}{SetLink}{\param{const wxString\& }{link}}
+\func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}

 
 

-Sets actual hypertext link. wxEmptyString means no link.
+Sets actual hypertext link. Empty link is represented
+by \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo} with {\it Href} equal
+to wxEmptyString.

 
 \membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
 
 
 \membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
 


@@ -255,3 +313,4 @@ Sets actual hypertext link. wxEmptyString means no link.
 
 Sets color of hypertext link.
 
 
 Sets color of hypertext link.
 

+