X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f533a674ae352c1dd0a28ccd8ecf225a1ca29332..d2d93fdde48ef1dcbda52bad88fd39b7bd3a5458:/docs/latex/wx/htwinprs.tex diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex index 0f322c46a5..6c06f93d3a 100644 --- a/docs/latex/wx/htwinprs.tex +++ b/docs/latex/wx/htwinprs.tex @@ -3,6 +3,7 @@ % htmlwinparser.tex at 14/Mar/99 20:13:37 % + \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser} This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and @@ -14,8 +15,6 @@ its mail goal is to parse HTML input so that it can be displayed in \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} @@ -63,9 +62,6 @@ Creates font based on current setting (see 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} @@ -114,12 +110,28 @@ m_WParser -> GetContainer() -> InsertCell(new ...); 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::GetFontFace}\label{wxhtmlwinparsergetfontface} + +\constfunc{wxString}{GetFontFace}{\void} + +Returns actual font face name. + + \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed} \constfunc{int}{GetFontFixed}{\void} @@ -145,6 +157,13 @@ Returns actual font size (HTML size varies from -2 to +4) 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} \constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void} @@ -161,6 +180,14 @@ wxEmptyString otherwise.) 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} @@ -176,7 +203,7 @@ title only if some window is associated, otherwise it does nothing) Opens new container and returns pointer to it (see \helpref{Overview}{cells}). -% + \membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor} \func{void}{SetActualColor}{\param{const wxColour\& }{clr}} @@ -192,22 +219,25 @@ Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.) 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} -\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} @@ -215,6 +245,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. +\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 } tag or not). + \membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed} \func{void}{SetFontFixed}{\param{int }{x}} @@ -227,6 +265,7 @@ 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. + \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize} \func{void}{SetFontSize}{\param{int }{s}} @@ -245,6 +284,16 @@ Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE. 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} \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}