escape more underscores (we need a pre-commit check for those...)

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

diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex
index b59bb47f29bd9b08560ae367e483834983b9febb..61f802338f05a31dd1180f6349785b44b1daa907 100644 (file)
--- a/docs/latex/wx/htcell.tex
+++ b/docs/latex/wx/htcell.tex
@@ -1,7 +1,13 @@
-%
-% automatically generated by HelpGen from
-% htmlcell.tex at 21/Mar/99 22:45:23
-%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        htcell.tex
+%% Purpose:     wxHtmlCell documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:     21/Mar/99 22:45:23
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 
 \section{\class{wxHtmlCell}}\label{wxhtmlcell}
 
 
 \section{\class{wxHtmlCell}}\label{wxhtmlcell}
 


@@ -16,7 +22,11 @@ perform special actions such as color or font change.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-wxObject
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/html/htmlcell.h>

 
 \wxheading{See Also}
 
 
 \wxheading{See Also}
 


@@ -41,7 +51,7 @@ should not be crossed by words, images etc.). If this cell cannot be divided
 into two pieces (each one on another page) then it moves the pagebreak
 few pixels up.
 
 into two pieces (each one on another page) then it moves the pagebreak
 few pixels up.
 

-Returns TRUE if pagebreak was modified, FALSE otherwise
+Returns true if pagebreak was modified, false otherwise

 
 Usage: 
 \begin{verbatim}
 
 Usage: 
 \begin{verbatim}


@@ -62,10 +72,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}


@@ -96,7 +106,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,9 +117,9 @@ HTML_COND_ISANCHOR condition)
 \wxheading{Defined conditions}
 
 \begin{twocollist}\itemsep=0pt
 \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.}
 {\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}
 
 from this number.}
 \end{twocollist}
 


@@ -117,15 +127,35 @@ from this number.}
 
 \constfunc{int}{GetDescent}{\void}
 
 
 \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::GetFirstChild}\label{wxhtmlcellgetfirstchild}
+
+\func{wxHtmlCell*}{GetFirstChild}{\void}
+
+Returns pointer to the first cell in the list.
+You can then use child's \helpref{GetNext}{wxhtmlcellgetnext}
+method to obtain pointer to the next cell in list.
+
+{\bf Note:} This shouldn't be used by the end user. If you need some way of
+finding particular cell in the list, try \helpref{Find}{wxhtmlcellfind} method
+instead.

 
 \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::GetId}\label{wxhtmlcellgetid}
+
+\constfunc{virtual wxString}{GetId}{\void}
+
+Returns unique cell identifier if there is any, empty string otherwise.

 
 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 
 
 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 


@@ -139,7 +169,20 @@ See \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 
 \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
 
 \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::GetMouseCursor}\label{wxhtmlcellgetmousecursor}
+
+\func{virtual wxCursor}{GetMouseCursor}{\param{wxHtmlWindowInterface* }{window}}
+
+Returns cursor to show when mouse pointer is over the cell.
+
+\wxheading{Parameters}
+
+\docparam{window}{interface to the parent HTML window}
+
+\newsince{2.7.0} (before \tt{GetCursor} method served a similar purpose, which is now deprecated).
+

 
 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 
 
 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 


@@ -174,16 +217,16 @@ 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}
 
 \func{virtual void}{Layout}{\param{int }{w}}
 
 
 \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
 
 \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}
 (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}


@@ -193,33 +236,46 @@ It must be called before displaying cells structure because
 m\_PosX and m\_PosY are undefined (or invalid)
 before calling Layout.
 
 m\_PosX and m\_PosY are undefined (or invalid)
 before calling Layout.
 

-\membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick}
+\membersection{wxHtmlCell::ProcessMouseClick}\label{wxhtmlcellprocessmouseclick}

 
 

-\func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{bool }{left}, \param{bool }{middle}, \param{bool }{right}}
+\func{virtual bool}{ProcessMouseClick}{\param{wxHtmlWindowInterface* }{window}, \param{const wxPoint\& }{pos}, \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
-that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
+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 to call
+\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}
 

-\docparam{parent}{parent window (always wxHtmlWindow!)}
+\docparam{window}{interface to the parent HTML window}
+
+\docparam{pos}{coordinates of mouse click (this is relative to cell's origin}
+
+\docparam{event}{mouse event that triggered the call}
+
+\wxheading{Return value}
+
+\true if a link was clicked, \false otherwise.
+
+\newsince{2.7.0} (before \tt{OnMouseClick} method served a similar purpose).
+
+
+\membersection{wxHtmlCell::SetId}\label{wxhtmlcellsetid}

 
 

-\docparam{x, y}{coordinates of mouse click (this is relative to cell's origin}
+\func{void}{SetId}{\param{const wxString\& }{id}}

 
 

-\docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right
-button is pressed, FALSE otherwise}
+Sets unique cell identifier. Default value is no identifier, i.e. empty string.

 
 \membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
 
 \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
 
 
 \membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink}
 
 \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
 

-Sets the hypertext link asocciated with this cell. (Default value
+Sets the hypertext link associated with this cell. (Default value

 is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
 
 \membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}
 is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
 
 \membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext}


@@ -227,7 +283,7 @@ is \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}("", "") (no link))
 \func{void}{SetNext}{\param{wxHtmlCell }{*cell}}
 
 Sets the next cell in the list. This shouldn't be called by user - it is
 \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}
 
 
 \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}