added and documented wxDC::DrawCheckMark()

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

diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex
index 311186ecbf2c3a004cbff1206ecabdf54810e4e8..e585ffa6823a5e3d6df32d0df01df67f43a87a01 100644 (file)
--- a/docs/latex/wx/htcell.tex
+++ b/docs/latex/wx/htcell.tex
@@ -6,7 +6,7 @@
 \section{\class{wxHtmlCell}}\label{wxhtmlcell}
 
 Internal data structure. It represents fragments of parsed HTML
 \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.
+page, the so-called {\bf cell} - a word, picture, table, horizontal line and so on.

 It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and 
 \helpref{wxHtmlWinParser}{wxhtmlwinparser} to represent HTML page in memory.
 
 It is used by \helpref{wxHtmlWindow}{wxhtmlwindow} and 
 \helpref{wxHtmlWinParser}{wxhtmlwinparser} to represent HTML page in memory.
 


@@ -31,7 +31,6 @@ wxObject
 
 Constructor.
 
 
 Constructor.
 

-

 \membersection{wxHtmlCell::AdjustPagebreak}\label{wxhtmlcelladjustpagebreak}
 
 \func{virtual bool}{AdjustPagebreak}{\param{int * }{pagebreak}}
 \membersection{wxHtmlCell::AdjustPagebreak}\label{wxhtmlcelladjustpagebreak}
 
 \func{virtual bool}{AdjustPagebreak}{\param{int * }{pagebreak}}


@@ -44,7 +43,7 @@ few pixels up.
 
 Returns TRUE if pagebreak was modified, FALSE otherwise
 
 
 Returns TRUE if pagebreak was modified, FALSE otherwise
 

-Usage : 
+Usage: 

 \begin{verbatim}
 while (container->AdjustPagebreak(&p)) {}
 \end{verbatim}
 \begin{verbatim}
 while (container->AdjustPagebreak(&p)) {}
 \end{verbatim}


@@ -63,10 +62,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)}}
 
 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}
 
 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}
 used to optimize rendering speed}
 
 \membersection{wxHtmlCell::DrawInvisible}\label{wxhtmlcelldrawinvisible}


@@ -97,7 +96,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
 
 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}
 
 
 \wxheading{Parameters}
 


@@ -107,39 +106,42 @@ HTML_COND_ISANCHOR condition)
 
 \wxheading{Defined conditions}
 
 
 \wxheading{Defined conditions}
 

-\begin{twocollist}
-\twocolitem{{\bf HTML_COND_ISANCHOR}}{Finds particular anchor.
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxHTML\_COND\_ISANCHOR}}{Finds particular anchor. 

 {\it param} is pointer to wxString with name of the anchor.}
 {\it param} is pointer to wxString with name of the anchor.}

-\twocolitem{{\bf HTML_COND_USER}}{User-defined conditions start
-from this number}
+\twocolitem{{\bf wxHTML\_COND\_USER}}{User-defined conditions start
+from this number.}

 \end{twocollist}
 
 \membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent}
 
 \constfunc{int}{GetDescent}{\void}
 
 \end{twocollist}
 
 \membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent}
 
 \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}
 
 \image{}{descent.bmp}

+}

 
 \membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight}
 
 \constfunc{int}{GetHeight}{\void}
 
 
 \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}
 
 
 \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.
-(Note : this makes sense only for visible tags).
+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
 
 \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}
 
 
 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 


@@ -174,7 +176,7 @@ parent's \helpref{Layout}{wxhtmlcelllayout} was called before!
 
 \constfunc{int}{GetWidth}{\void}
 
 
 \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}
 
 
 \membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout}
 


@@ -182,7 +184,7 @@ Returns width of the cell (m_Width member).
 
 This method performs 2 actions:
 
 
 This method performs 2 actions:
 

-\begin{enumerate}
+\begin{enumerate}\itemsep=0pt

 \item adjusts 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)
 \item adjusts 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)


@@ -195,7 +197,7 @@ before calling Layout.
 
 \membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick}
 
 
 \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
 within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is
 
 This function is simple event handler. Each time user clicks mouse button over a cell
 within \helpref{wxHtmlWindow}{wxhtmlwindow} this method of that cell is called. Default behavior is


@@ -203,8 +205,8 @@ that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
 
 \wxheading{Note}
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -217,10 +219,10 @@ button is pressed, FALSE otherwise}
 
 \membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
 
 
 \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
 
 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}
 
 
 \membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}
 


@@ -240,5 +242,5 @@ Sets parent container of this cell. This is called from
 
 \func{void}{SetPos}{\param{int }{x}, \param{int }{y}}
 
 
 \func{void}{SetPos}{\param{int }{x}, \param{int }{y}}
 

-Sets cell's position within parent container.
+Sets the cell's position within parent container.