X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/459d4207931244c83ae56e26583fcaab88d74ec1..10ff9c616e00e4074dfdc2ac9e354605cc129c22:/docs/latex/wx/htcell.tex diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index 0922d7cba8..5bfff0e864 100644 --- 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} @@ -16,7 +22,15 @@ perform special actions such as color or font change. \wxheading{Derived from} -wxObject +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxHtml}{librarieslist} \wxheading{See Also} @@ -41,7 +55,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} @@ -123,12 +137,30 @@ Returns descent value of the cell (m\_Descent member). \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::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}} @@ -143,6 +175,19 @@ 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)} +\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} \constfunc{wxHtmlCell*}{GetNext}{\void} @@ -182,10 +227,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} @@ -195,13 +240,14 @@ It must be called before displaying cells structure because 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 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} @@ -210,18 +256,30 @@ you should use wxHtmlBinderCell instead. \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}} -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} @@ -229,7 +287,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}