git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3177
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
\func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}}
\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}
\helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
\membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent}
\constfunc{int}{GetPosX}{\void}
Returns X position within parent (the value is relative to parent's
\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}
parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
\membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy}
\constfunc{int}{GetPosY}{\void}
Returns Y position within parent (the value is relative to parent's
\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}
parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
\membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth}
\constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}
Returns hypertext link if associated with this cell or empty string otherwise.
\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).
\func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
\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}
to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}
\membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout}
based on actual width {\it w}
\end{enumerate}
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}
\membersection{wxHtmlCell::Draw}\label{wxhtmlcelldraw}
\func{virtual void}{DrawInvisible}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}}
\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
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}
or font setter) must be drawn even if they are invisible!
\wxheading{Parameters}
\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
\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}
\membersection{wxHtmlCell::Find}\label{wxhtmlcellfind}
Returns pointer to itself if this cell matches condition (or if any of the cells
following in the list matches), NULL otherwise.
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
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}
HTML_COND_ISANCHOR condition)
\wxheading{Parameters}
\func{bool}{CanRead}{\param{const wxFSFile\& }{file}}
\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}.
\membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile}
\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.
Reads the file and returns string with HTML document.
\begin{verbatim}
wxString MyImgFilter::ReadFile(const wxFSFile& file)
{
\begin{verbatim}
wxString MyImgFilter::ReadFile(const wxFSFile& file)
{
- return "<html><body><img src=\"" +
- file.GetLocation() +
+ return "<html><body><img src=\"" +
+ file.GetLocation() +
"\"></body></html>";
}
\end{verbatim}
"\"></body></html>";
}
\end{verbatim}
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 -
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
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)
wxHtmlParser instance. The reason is that the handler may contain
document-specific temporary data used during parsing (e.g. complicated
structures like tables)
\func{}{wxHtmlParser}{\void}
\func{}{wxHtmlParser}{\void}
\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs}
\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs}
\func{virtual wxObject*}{GetProduct}{\void}
\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.
representation in derived parser (but it must be derived from wxObject!).
See wxHtmlWinParser for details.
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
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.
GetTempData() solves the problem.
Must be overwriten in derived class.
This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing}
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}
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.
This may (and may not) be overwriten in derived class.
\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
\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)}
+
wxString line;
text >> i1; // read a 8 bit integer.
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}
text >> line; // read a text line
\end{verbatim}
\func{wxString}{wxTextInputStream::ReadString}{\void}
Reads a line from the stream. A line is a string which ends with
\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
% ----------------------------------------------------------------------------
% wxTextOutputStream
output << 1234;
output << 1.23456;
\end{verbatim}
output << 1234;
output << 1.23456;
\end{verbatim}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxdataoutputstreamconstr}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxdataoutputstreamconstr}