X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..52c14774b3309c1f6baddbcf92df1eb86a322d92:/docs/latex/wx/htcell.tex?ds=sidebyside diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index c2d3e5c4e2..bb10e8d0c7 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -45,7 +45,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. -Returns TRUE if pagebreak was modified, FALSE otherwise +Returns true if pagebreak was modified, false otherwise Usage: \begin{verbatim} @@ -133,6 +133,12 @@ Returns descent value of the cell (m\_Descent 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} \constfunc{virtual wxHtmlLinkInfo*}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}} @@ -186,10 +192,10 @@ Returns width of the cell (m\_Width member). \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} @@ -203,7 +209,7 @@ before calling Layout. \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}. @@ -218,14 +224,20 @@ you should use wxHtmlBinderCell instead. \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} \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} @@ -233,7 +245,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 -to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell} +to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}. \membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent}