X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d17f05afeb41c64fab410cd3178a78596da55e38..f6ed38239c20927281363f3828323e05b4917c0e:/docs/latex/wx/htcell.tex diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index e585ffa682..fc54ec8317 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -16,7 +16,11 @@ perform special actions such as color or font change. \wxheading{Derived from} -wxObject +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + \wxheading{See Also} @@ -129,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}} @@ -182,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} @@ -199,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}. @@ -217,6 +227,12 @@ you should use wxHtmlBinderCell instead. \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}} @@ -229,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}