X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/704a4b7524e05d7bf4d208eb1b30be9989abef4c..a8cb1d29e7fe349142d8d6be9fc9afe986340611:/docs/latex/wx/htcell.tex diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index a6e2620b3d..58b81d46b1 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -3,19 +3,17 @@ % htmlcell.tex at 21/Mar/99 22:45:23 % - \section{\class{wxHtmlCell}}\label{wxhtmlcell} Internal data structure. It represents fragments of parsed HTML page, so-called {\bf cell} - a word, picture, table, horizontal line and so on. -It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and +It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and \helpref{wxHtmlWinParser}{wxhtmlwinparser} to represent HTML page in memory. You can divide cells into two groups : {\it visible} cells with non-zero width and height and {\it helper} cells (usually with zero width and height) that perform special actions such as color or font change. - \wxheading{Derived from} wxObject @@ -23,23 +21,21 @@ wxObject \wxheading{See Also} \helpref{Cells Overview}{cells}, -\helpref{wxHtmlContainerCell}{wxhtmlcontainercell}, +\helpref{wxHtmlContainerCell}{wxhtmlcontainercell} \latexignore{\rtfignore{\wxheading{Members}}} - \membersection{wxHtmlCell::wxHtmlCell}\label{wxhtmlcellwxhtmlcell} \func{}{wxHtmlCell}{\void} Constructor. - \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent} \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 +49,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 +57,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 +85,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} @@ -110,7 +106,6 @@ interested in details). Sets cell's position within parent container. - \membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink} \func{void}{SetLink}{\param{const wxString\& }{link}} @@ -122,7 +117,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 +133,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 +161,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,8 +172,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 +180,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} @@ -208,11 +202,8 @@ HTML_COND_ISANCHOR condition) from this number} \end{twocollist} - - \membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick} - \func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{bool }{left}, \param{bool }{middle}, \param{bool }{right}} This function is simple event handler. Each time user clicks mouse button over a cell @@ -222,19 +213,14 @@ that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}. \wxheading{Note} If you need more "advanced" behaviour (for example you'd like to catch mouse movement events or -key events or whatsooever) you should use \helpref{wxHtmlBinderCell}{wxhtmlbindercell} instead. +key events or whatsoever) you should use wxHtmlBinderCell instead. \wxheading{Parameters} -\docparam{parent}{parent window (always wxHtmlWindow!!)} +\docparam{parent}{parent window (always wxHtmlWindow!)} \docparam{x, y}{coordinates of mouse click (this is relative to cell's origin} \docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right button is pressed, FALSE otherwise} - - - - -