From 3660fc40ad00d17d21bf0057a30c099179b6eae8 Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Wed, 28 Jul 1999 05:52:04 +0000 Subject: [PATCH] Fixed some stupid TEX errors... git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3177 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/htcell.tex | 28 +++++++++++++--------------- docs/latex/wx/htfilter.tex | 10 ++++++---- docs/latex/wx/htparser.tex | 16 ++++++++-------- docs/latex/wx/htwidget.tex | 3 ++- docs/latex/wx/txtstrm.tex | 6 +++--- 5 files changed, 32 insertions(+), 31 deletions(-) diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index a6e2620b3d..5d58c1283a 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -39,7 +39,7 @@ Constructor. \func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}} -Sets parent container of this cell. This is called from +Sets parent container of this cell. This is called from \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}. \membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent} @@ -53,7 +53,7 @@ Returns pointer to parent container. \constfunc{int}{GetPosX}{\void} Returns X position within parent (the value is relative to parent's -upper left corner). The returned value is meaningful only if +upper left corner). The returned value is meaningful only if parent's \helpref{Layout}{wxhtmlcelllayout} was called before! \membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy} @@ -61,7 +61,7 @@ parent's \helpref{Layout}{wxhtmlcelllayout} was called before! \constfunc{int}{GetPosY}{\void} Returns Y position within parent (the value is relative to parent's -upper left corner). The returned value is meaningful only if +upper left corner). The returned value is meaningful only if parent's \helpref{Layout}{wxhtmlcelllayout} was called before! \membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth} @@ -89,7 +89,7 @@ Returns descent value of the cell (m_Descent member). See explanation: \constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}} Returns hypertext link if associated with this cell or empty string otherwise. -(Note : this makes sense only for visible tags). +(Note : this makes sense only for visible tags). \wxheading{Parameters} @@ -122,7 +122,7 @@ is wxEmptyString (no link)) \func{void}{SetNext}{\param{wxHtmlCell }{*cell}} -Sets the next cell in the list. This shouldn't be called by user - it is +Sets the next cell in the list. This shouldn't be called by user - it is to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell} \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout} @@ -138,9 +138,9 @@ This method performs 2 actions: based on actual width {\it w} \end{enumerate} -It must be called before displaying cells structure because -m\_PosX and m\_PosY are undefined (or invalid) -before calling Layout. +It must be called before displaying cells structure because +m\_PosX and m\_PosY are undefined (or invalid) +before calling Layout. \membersection{wxHtmlCell::Draw}\label{wxhtmlcelldraw} @@ -166,9 +166,9 @@ used to optimize rendering speed} \func{virtual void}{DrawInvisible}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}} -This method is called instead of \helpref{Draw{wxhtmlcelldraw} when the +This method is called instead of \helpref{Draw}{wxhtmlcelldraw} when the cell is certainly out of the screen (and thus invisible). This is not -nonsense - some tags (like \helpref{wxHtmlColourCell}{wxhtmlcolourcell} +nonsense - some tags (like \helpref{wxHtmlColourCell}{wxhtmlcolourcell} or font setter) must be drawn even if they are invisible! \wxheading{Parameters} @@ -177,7 +177,7 @@ or font setter) must be drawn even if they are invisible! \docparam{x,y}{Coordinates of parent's upper left corner. You must add this to m\_PosX,m\_PosY when passing coordinates to dc's methods -Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)} } +Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)}} \membersection{wxHtmlCell::Find}\label{wxhtmlcellfind} @@ -186,11 +186,11 @@ Example : {\tt dc -> DrawText("hello", x + m\_PosX, y + m\_PosY)} } Returns pointer to itself if this cell matches condition (or if any of the cells following in the list matches), NULL otherwise. -(In other words if you call top-level container's Find it will +(In other words if you call top-level container's Find it will return pointer to the first cell that matches the condition) It is recommended way how to obtain pointer to particular cell or -to cell of some type (e.g. wxHtmlAnchorCell reacts on +to cell of some type (e.g. wxHtmlAnchorCell reacts on HTML_COND_ISANCHOR condition) \wxheading{Parameters} @@ -236,5 +236,3 @@ button is pressed, FALSE otherwise} - - diff --git a/docs/latex/wx/htfilter.tex b/docs/latex/wx/htfilter.tex index a07f36b53c..8307d80382 100644 --- a/docs/latex/wx/htfilter.tex +++ b/docs/latex/wx/htfilter.tex @@ -30,7 +30,7 @@ Constructor. \func{bool}{CanRead}{\param{const wxFSFile\& }{file}} -Returns TRUE if this filter is capable of reading file {\it file}. +Returns TRUE if this filter is capable of reading file {\it file}. Example: @@ -43,7 +43,8 @@ bool MyFilter::CanRead(const wxFSFile& file) \membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile} -\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file} +\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}} + Reads the file and returns string with HTML document. @@ -52,8 +53,9 @@ Example: \begin{verbatim} wxString MyImgFilter::ReadFile(const wxFSFile& file) { - return ""; } \end{verbatim} + diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex index 3724999272..a403848a38 100644 --- a/docs/latex/wx/htparser.tex +++ b/docs/latex/wx/htparser.tex @@ -13,10 +13,10 @@ consists of begining and ending tag and of text between these It is independent from wxHtmlWindow and can be used as stand-alone parser (Julian Smart's idea of speech-only HTML viewer or wget-like utility - -see InetGet sample for example). +see InetGet sample for example). It uses system of tag handlers to parse the HTML document. Tag handlers -are not staticaly shared by all instances but are created for each +are not staticaly shared by all instances but are created for each wxHtmlParser instance. The reason is that the handler may contain document-specific temporary data used during parsing (e.g. complicated structures like tables) @@ -40,7 +40,7 @@ wxObject \func{}{wxHtmlParser}{\void} -Constructor. +Constructor. \membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs} @@ -111,8 +111,8 @@ Parses the m\_Source from begin\_pos to end\_pos-1. \func{virtual wxObject*}{GetProduct}{\void} -Returns product of parsing. Returned value is result of parsing -of the document. The type of this result depends on internal +Returns product of parsing. Returned value is result of parsing +of the document. The type of this result depends on internal representation in derived parser (but it must be derived from wxObject!). See wxHtmlWinParser for details. @@ -161,7 +161,7 @@ Why is this neccessary? Imagine wxHtmlWinParser : when handling FONT tag it creates some fonts. These fonts are then used by wxHtmlWindow to display the text. But wxHtmWinParser object is needed only when parsing the document - it may be deleted then. But fonts CAN'T be deleted - they -must exist as long as the window is displaying text. +must exist as long as the window is displaying text. GetTempData() solves the problem. @@ -172,13 +172,13 @@ GetTempData() solves the problem. Must be overwriten in derived class. This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing} -each time a part of text is parsed. {\it txt} is NOT only one word, it is +each time a part of text is parsed. {\it txt} is NOT only one word, it is substring of input. It is not formatted or preprocessed (so white spaces are unmodified) \membersection{wxHtmlParser::AddTag}\label{wxhtmlparseraddtag} -\func{void}{AddTag}{\param{const wxHtmlTag\& }{tag} +\func{void}{AddTag}{\param{const wxHtmlTag\& }{tag}} This may (and may not) be overwriten in derived class. diff --git a/docs/latex/wx/htwidget.tex b/docs/latex/wx/htwidget.tex index 550f781f99..b84169d9fa 100644 --- a/docs/latex/wx/htwidget.tex +++ b/docs/latex/wx/htwidget.tex @@ -34,5 +34,6 @@ which it is displayed!} \docparam{w}{Floating width. If non-zero width of {\it wnd} window is adjusted so that it is always {\it w} percents of parent container's width. (For example w = 100 means that the window -will always have same width as parent container) +will always have same width as parent container)} + diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex index d4cf2b9f4d..cf5f519a12 100644 --- a/docs/latex/wx/txtstrm.tex +++ b/docs/latex/wx/txtstrm.tex @@ -16,7 +16,7 @@ For example: wxString line; text >> i1; // read a 8 bit integer. - text >> i1 >> f2; // read a 8 bit integer followed by float. + text >> i1 >> f2; // read a 8 bit integer followed by float. text >> line; // read a text line \end{verbatim} @@ -72,7 +72,7 @@ Reads a double (IEEE encoded) from the stream. \func{wxString}{wxTextInputStream::ReadString}{\void} Reads a line from the stream. A line is a string which ends with -$\backslack$n or $\backslash$r$\backslash$n or $\backslash$r. +$\backslash$n or $\backslash$r$\backslash$n or $\backslash$r. % ---------------------------------------------------------------------------- % wxTextOutputStream @@ -91,7 +91,7 @@ For example: output << 1234; output << 1.23456; \end{verbatim} - + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxTextOutputStream::wxTextOutputStream}\label{wxdataoutputstreamconstr}