X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9ebb7cade2df5aeb8531950d2a79cd57a336bcec..e244be154eba9165ee6b109931b07e0532cd387b:/docs/latex/wx/htmllbox.tex diff --git a/docs/latex/wx/htmllbox.tex b/docs/latex/wx/htmllbox.tex index d7cc8f62cd..def468fc46 100644 --- a/docs/latex/wx/htmllbox.tex +++ b/docs/latex/wx/htmllbox.tex @@ -30,11 +30,28 @@ example) but you will only need to override a single +\wxheading{Library} + +\helpref{wxHtml}{librarieslist} + \wxheading{See also} \helpref{wxSimpleHtmlListBox}{wxsimplehtmllistbox} +\wxheading{Event handling} + +To process input from a wxHtmlListBox, use these event handler macros to direct input to member +functions that take a \helpref{wxHtmlCellEvent}{wxhtmlcellevent} argument or a \helpref{wxHtmlLinkEvent}{wxhtmllinkevent}. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_HTML\_CELL\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} was clicked.} +\twocolitem{{\bf EVT\_HTML\_CELL\_HOVER(id, func)}}{The mouse passed over a \helpref{wxHtmlCell}{wxhtmlcell}.} +\twocolitem{{\bf EVT\_HTML\_LINK\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} which contains an hyperlink was clicked.} +\end{twocollist} + + \latexignore{\rtfignore{\wxheading{Members}}} @@ -67,7 +84,7 @@ Creates the control and optionally sets the initial number of items in it \helpref{SetItemCount()}{wxvlistboxsetitemcount}). There are no special styles defined for wxHtmlListBox, in particular the -wxListBox styles (with the exception of {\tt wxLB_MULTIPLE}) can not be used here. +wxListBox styles (with the exception of {\tt wxLB\_MULTIPLE}) can not be used here. Returns {\tt true} on success or {\tt false} if the control couldn't be created @@ -147,6 +164,7 @@ This function may be overridden to decorate HTML returned by \func{virtual void}{OnLinkClicked}{\param{size\_t }{n}, \param{const wxHtmlLinkInfo\& }{link}} Called when the user clicks on hypertext link. Does nothing by default. +Overloading this method is deprecated; intercept the event instead. \wxheading{Parameters} @@ -213,11 +231,15 @@ or {\tt } tags. +\wxheading{Library} + +\helpref{wxHtml}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxHLB\_DEFAULT\_STYLE}}{The default style: wxSUNKEN_BORDER} +\twocolitem{\windowstyle{wxHLB\_DEFAULT\_STYLE}}{The default style: wxBORDER\_SUNKEN} \twocolitem{\windowstyle{wxHLB\_MULTIPLE}}{Multiple-selection list: the user can toggle multiple items on and off.} \end{twocollist} @@ -226,7 +248,10 @@ See also \helpref{window styles overview}{windowstyles}. \wxheading{Event handling} -A wxSimpleHtmlListBox emits the same events used by \helpref{wxListBox}{wxlistbox}: +A wxSimpleHtmlListBox emits the same events used by \helpref{wxListBox}{wxlistbox} and by +\helpref{wxHtmlListBox}{wxhtmllistbox}. + +The event handlers for the following events take a \helpref{wxCommandEvent}{wxcommandevent}: \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt @@ -236,6 +261,16 @@ when an item on the list is selected.} when the listbox is double-clicked.} \end{twocollist} +The event handlers for the following events take a \helpref{wxHtmlCellEvent}{wxhtmlcellevent} +or a \helpref{wxHtmlLinkEvent}{wxhtmllinkevent}: + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_HTML\_CELL\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} was clicked.} +\twocolitem{{\bf EVT\_HTML\_CELL\_HOVER(id, func)}}{The mouse passed over a \helpref{wxHtmlCell}{wxhtmlcell}.} +\twocolitem{{\bf EVT\_HTML\_LINK\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} which contains an hyperlink was clicked.} +\end{twocollist} + \latexignore{\rtfignore{\wxheading{Members}}}