don't call wxYield() from EnsureVisible(), this is too dangerous - and unnecessary...

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

diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex
index bc8494274d8704f373619672f1c90b27f61bea2e..54781c468c3cd38b8fef67787acf53abe91a98b7 100644 (file)
--- a/docs/latex/wx/htcell.tex
+++ b/docs/latex/wx/htcell.tex
@@ -16,7 +16,11 @@ perform special actions such as color or font change.
 
 \wxheading{Derived from}
 
-wxObject
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/html/htmlcell.h>
 
 \wxheading{See Also}
 
@@ -62,10 +66,10 @@ Renders the cell.
 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)}}
 
-\docparam{view_y1}{y-coord of the first line visible in window. This is
+\docparam{view\_y1}{y-coord of the first line visible in window. This is
 used to optimize rendering speed}
 
-\docparam{view_y2}{y-coord of the last line visible in window. This is
+\docparam{view\_y2}{y-coord of the last line visible in window. This is
 used to optimize rendering speed}
 
 \membersection{wxHtmlCell::DrawInvisible}\label{wxhtmlcelldrawinvisible}
@@ -96,7 +100,7 @@ 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
-HTML_COND_ISANCHOR condition)
+wxHTML\_COND\_ISANCHOR condition)
 
 \wxheading{Parameters}
 
@@ -107,9 +111,9 @@ HTML_COND_ISANCHOR condition)
 \wxheading{Defined conditions}
 
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf HTML_COND_ISANCHOR}}{Finds particular anchor. 
+\twocolitem{{\bf wxHTML\_COND\_ISANCHOR}}{Finds particular anchor. 
 {\it param} is pointer to wxString with name of the anchor.}
-\twocolitem{{\bf HTML_COND_USER}}{User-defined conditions start
+\twocolitem{{\bf wxHTML\_COND\_USER}}{User-defined conditions start
 from this number.}
 \end{twocollist}
 
@@ -117,28 +121,31 @@ from this number.}
 
 \constfunc{int}{GetDescent}{\void}
 
-Returns descent value of the cell (m_Descent member). See explanation:
+Returns descent value of the cell (m\_Descent member). 
+\helponly{See explanation:
 
 \image{}{descent.bmp}
+}
 
 \membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight}
 
 \constfunc{int}{GetHeight}{\void}
 
-Returns height of the cell (m_Height member).
+Returns height of the cell (m\_Height member).
 
 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 
-\constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}
+\constfunc{virtual wxHtmlLinkInfo*}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}
 
-Returns hypertext link if associated with this cell or empty string otherwise.
+Returns hypertext link if associated with this cell or NULL otherwise.
+See \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 (Note: this makes sense only for visible tags).
 
 \wxheading{Parameters}
 
 \docparam{x,y}{Coordinates of position where the user pressed mouse button.
 These coordinates are used e.g. by COLORMAP. Values are relative to the
-upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)}
+upper left corner of THIS cell (i.e. from 0 to m\_Width or m\_Height)}
 
 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 
@@ -173,16 +180,16 @@ parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
 
 \constfunc{int}{GetWidth}{\void}
 
-Returns width of the cell (m_Width member).
+Returns width of the cell (m\_Width member).
 
 \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout}
 
 \func{virtual void}{Layout}{\param{int }{w}}
 
-This method performs 2 actions:
+This method performs two actions:
 
 \begin{enumerate}\itemsep=0pt
-\item adjusts cell's width according to the fact that maximal possible width is {\it w}.
+\item adjusts the cell's width according to the fact that maximal possible width is {\it w}.
 (this has sense when working with horizontal lines, tables etc.)
 \item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members)
 based on actual width {\it w}
@@ -194,16 +201,16 @@ before calling Layout.
 
 \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}}
+\func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int}{x}, \param{int }{y}, \param{const wxMouseEvent\& }{event}}
 
-This function is simple event handler. Each time user clicks mouse button over a cell
+This function is simple event handler. Each time the user clicks mouse button over a cell
 within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is
 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 whatsoever) you should use wxHtmlBinderCell instead.
+If you need more "advanced" event handling
+you should use wxHtmlBinderCell instead.
 
 \wxheading{Parameters}
 
@@ -216,17 +223,17 @@ button is pressed, FALSE otherwise}
 
 \membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
 
-\func{void}{SetLink}{\param{const wxString\& }{link}}
+\func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
 
 Sets the hypertext link asocciated with this cell. (Default value
-is wxEmptyString (no link))
+is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
 
 \membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}
 
 \func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
 
 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}
+to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}.
 
 \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}