File/DirExists() are const now

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

diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex
index 311186ecbf2c3a004cbff1206ecabdf54810e4e8..bb10e8d0c7836606740624bf0073442156bf192f 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.
 


@@ -16,7 +16,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}
 


@@ -31,7 +35,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}}


@@ -42,9 +45,9 @@ 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 : 
+Usage: 

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


@@ -63,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)}}
 
 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 +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
 
 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 +110,48 @@ 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::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}
 

-\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,16 +186,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}
-\item adjusts cell's width according to the fact that maximal possible width is {\it w}.
+\begin{enumerate}\itemsep=0pt
+\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}


@@ -195,16 +207,16 @@ 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
+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}
 
 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}
 
 
 \wxheading{Parameters}
 


@@ -212,22 +224,28 @@ key events or whatsoever) you should use wxHtmlBinderCell instead.
 
 \docparam{x, y}{coordinates of mouse click (this is relative to cell's origin}
 
 
 \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}
+\docparam{left, middle, right}{boolean flags for mouse buttons. true if the left/middle/right
+button is pressed, false otherwise}
+
+\membersection{wxHtmlCell::SetId}\label{wxhtmlcellsetid}
+
+\func{void}{SetId}{\param{const wxString\& }{id}}
+
+Sets unique cell identifier. Default value is no identifier, i.e. empty string.

 
 \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
-is wxEmptyString (no link))
+Sets the hypertext link associated with this cell. (Default value
+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
 
 \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}
 
 
 \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}
 


@@ -240,5 +258,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.