X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..b8b37cedd39bae3a3653003a7f8ae5fecf4df78f:/docs/latex/wx/htcell.tex diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index bb10e8d0c7..61f802338f 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} @@ -127,6 +133,18 @@ 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} @@ -153,6 +171,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} @@ -205,13 +236,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 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} @@ -220,12 +252,18 @@ 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. -\docparam{x, y}{coordinates of mouse click (this is relative to cell's origin} +\newsince{2.7.0} (before \tt{OnMouseClick} method served a similar purpose). -\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}