Blindly added wxImageList::replace( int, bitmap, mask )

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

diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex
index 54781c468c3cd38b8fef67787acf53abe91a98b7..602480ea64c4d8361e65ea8d3d8d8c44cf1eb404 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}
 


@@ -45,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}


@@ -127,12 +133,30 @@ Returns descent value of the cell (m\_Descent member).
 \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}
 
 Returns height of the cell (m\_Height member).
 
 \membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight}
 
 \constfunc{int}{GetHeight}{\void}
 
 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}
 
 \constfunc{virtual wxHtmlLinkInfo*}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}
 \membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink}
 
 \constfunc{virtual wxHtmlLinkInfo*}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}}


@@ -147,6 +171,16 @@ See \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 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)}
 
 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)}
 

+\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}
+

 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 
 \constfunc{wxHtmlCell*}{GetNext}{\void}
 \membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext}
 
 \constfunc{wxHtmlCell*}{GetNext}{\void}


@@ -199,13 +233,14 @@ 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{const wxMouseEvent\& }{event}}
+\func{virtual bool}{ProcessMouseClick}{\param{wxHtmlWindowInterface* }{window}, \param{const wxPoint\& }{pos}, \param{const wxMouseEvent\& }{event}}

 
 

-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}.
+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}
 


@@ -214,18 +249,27 @@ 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.
+
+\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}