docs/latex/wx/htwindow.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % htmlwindow.tex at 14/Mar/99 20:13:37
   4 %
   5
   6 \section{\class{wxHtmlWindow}}\label{wxhtmlwindow}
   7
   8 wxHtmlWindow is probably the only class you will directly use
   9 unless you want to do something special (like adding new tag
  10 handlers or MIME filters).
  11
  12 The purpose of this class is to display HTML pages (either local
  13 file or downloaded via HTTP protocol) in a window. The width
  14 of the window is constant - given in the constructor - and virtual height
  15 is changed dynamically depending on page size.
  16 Once the window is created you can set its content by calling
  17 \helpref{SetPage(text)}{wxhtmlwindowsetpage},
  18 \helpref{LoadPage(filename)}{wxhtmlwindowloadpage} or
  19 \helpref{LoadFile}{wxhtmlwindowloadfile}.
  20
  21 \wxheading{Note}
  22
  23 wxHtmlWindow uses the \helpref{wxImage}{wximage} class for displaying images.
  24 Don't forget to initialize all image formats you need before loading any page!
  25 (See \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers} and
  26 \helpref{wxImage::AddHandler}{wximageaddhandler}.)
  27
  28 \wxheading{Derived from}
  29
  30 \helpref{wxScrolledWindow}{wxscrolledwindow}
  31
  32 \wxheading{Include files}
  33
  34 <wx/html/htmlwin.h>
  35
  36 \wxheading{Library}
  37
  38 \helpref{wxHtml}{librarieslist}
  39
  40 \wxheading{Window styles}
  41
  42 \twocolwidtha{5cm}
  43 \begin{twocollist}\itemsep=0pt
  44 \twocolitem{\windowstyle{wxHW\_SCROLLBAR\_NEVER}}{Never display scrollbars, not
  45 even when the page is larger than the window.}
  46 \twocolitem{\windowstyle{wxHW\_SCROLLBAR\_AUTO}}{Display scrollbars only if
  47 page's size exceeds window's size.}
  48 \twocolitem{\windowstyle{wxHW\_NO\_SELECTION}}{Don't allow the user to select
  49 text.}
  50 \end{twocollist}
  51
  52
  53 \wxheading{Event handling}
  54
  55 To process input from a wxHtmlWindow, use these event handler macros to direct input to member
  56 functions that take a \helpref{wxHtmlCellEvent}{wxhtmlcellevent} argument or a \helpref{wxHtmlLinkEvent}{wxhtmllinkevent}.
  57
  58 \twocolwidtha{7cm}
  59 \begin{twocollist}\itemsep=0pt
  60 \twocolitem{{\bf EVT\_HTML\_CELL\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} was clicked.}
  61 \twocolitem{{\bf EVT\_HTML\_CELL\_HOVER(id, func)}}{The mouse passed over a \helpref{wxHtmlCell}{wxhtmlcell}.}
  62 \twocolitem{{\bf EVT\_HTML\_LINK\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} which contains an hyperlink was clicked.}
  63 \end{twocollist}
  64
  65
  66 \wxheading{See also}
  67
  68 \helpref{wxHtmlLinkEvent}{wxhtmllinkevent}, \helpref{wxHtmlCellEvent}{wxhtmlcellevent}
  69
  70
  71
  72 \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
  73
  74 \func{}{wxHtmlWindow}{\void}
  75
  76 Default constructor.
  77
  78 \func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxHW\_DEFAULT\_STYLE}, \param{const wxString\& }{name = "htmlWindow"}}
  79
  80 Constructor. The parameters are the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor.
  81
  82 \wxheading{Parameters}
  83
  84 \docparam{style}{Window style. See \helpref{wxHtmlWindow}{wxhtmlwindow}.}
  85
  86 \membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
  87
  88 \func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}}
  89
  90 Adds \helpref{input filter}{filters} to the static list of available
  91 filters. These filters are present by default:
  92
  93 \begin{itemize}\itemsep=0pt
  94 \item {\tt text/html} MIME type
  95 \item {\tt image/*} MIME types
  96 \item Plain Text filter (this filter is used if no other filter matches)
  97 \end{itemize}
  98
  99 \membersection{wxHtmlWindow::AppendToPage}\label{wxhtmlwindowappendtopage}
 100
 101 \func{bool}{AppendToPage}{\param{const wxString\& }{source}}
 102
 103 Appends HTML fragment to currently displayed text and refreshes the window.
 104
 105 \wxheading{Parameters}
 106
 107 \docparam{source}{HTML code fragment}
 108
 109 \wxheading{Return value}
 110
 111 false if an error occurred, true otherwise.
 112
 113 \membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation}
 114
 115 \constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void}
 116
 117 Returns pointer to the top-level container.
 118
 119 See also: \helpref{Cells Overview}{cells},
 120 \helpref{Printing Overview}{printing}
 121
 122 \membersection{wxHtmlWindow::GetOpenedAnchor}\label{wxhtmlwindowgetopenedanchor}
 123
 124 \func{wxString}{GetOpenedAnchor}{\void}
 125
 126 Returns anchor within currently opened page
 127 (see \helpref{GetOpenedPage}{wxhtmlwindowgetopenedpage}).
 128 If no page is opened or if the displayed page wasn't
 129 produced by call to LoadPage, empty string is returned.
 130
 131
 132 \membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage}
 133
 134 \func{wxString}{GetOpenedPage}{\void}
 135
 136 Returns full location of the opened page. If no page is opened or if the displayed page wasn't
 137 produced by call to LoadPage, empty string is returned.
 138
 139 \membersection{wxHtmlWindow::GetOpenedPageTitle}\label{wxhtmlwindowgetopenedpagetitle}
 140
 141 \func{wxString}{GetOpenedPageTitle}{\void}
 142
 143 Returns title of the opened page or wxEmptyString if current page does not contain {\tt <TITLE>} tag.
 144
 145 \membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe}
 146
 147 \constfunc{wxFrame*}{GetRelatedFrame}{\void}
 148
 149 Returns the related frame.
 150
 151 \membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback}
 152
 153 \func{bool}{HistoryBack}{\void}
 154
 155 Moves back to the previous page. (each page displayed using
 156 \helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.)
 157
 158 \membersection{wxHtmlWindow::HistoryCanBack}\label{wxhtmlwindowhistorycanback}
 159
 160 \func{bool}{HistoryCanBack}{\void}
 161
 162 Returns true if it is possible to go back in the history (i.e. HistoryBack()
 163 won't fail).
 164
 165 \membersection{wxHtmlWindow::HistoryCanForward}\label{wxhtmlwindowhistorycanforward}
 166
 167 \func{bool}{HistoryCanForward}{\void}
 168
 169 Returns true if it is possible to go forward in the history (i.e. HistoryBack()
 170 won't fail).
 171
 172
 173 \membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear}
 174
 175 \func{void}{HistoryClear}{\void}
 176
 177 Clears history.
 178
 179 \membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward}
 180
 181 \func{bool}{HistoryForward}{\void}
 182
 183 Moves to next page in history.
 184
 185 \membersection{wxHtmlWindow::LoadFile}\label{wxhtmlwindowloadfile}
 186
 187 \func{virtual bool}{LoadFile}{\param{const wxFileName\& }{filename}}
 188
 189 Loads HTML page from file and displays it.
 190
 191 \wxheading{Return value}
 192
 193 false if an error occurred, true otherwise
 194
 195 \wxheading{See also}
 196
 197 \helpref{LoadPage}{wxhtmlwindowloadpage}
 198
 199 \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage}
 200
 201 \func{virtual bool}{LoadPage}{\param{const wxString\& }{location}}
 202
 203 Unlike SetPage this function first loads HTML page from {\it location}
 204 and then displays it. See example:
 205
 206 \begin{verbatim}
 207 htmlwin->LoadPage("help/myproject/index.htm");
 208 \end{verbatim}
 209
 210 \wxheading{Parameters}
 211
 212 \docparam{location}{The address of document. See \helpref{wxFileSystem}{wxfilesystem} for details on address format and behaviour of "opener".}
 213
 214 \wxheading{Return value}
 215
 216 false if an error occurred, true otherwise
 217
 218 \wxheading{See also}
 219
 220 \helpref{LoadFile}{wxhtmlwindowloadfile}
 221
 222 \membersection{wxHtmlWindow::OnCellClicked}\label{wxhtmlwindowoncellclicked}
 223
 224 \func{virtual bool}{OnCellClicked}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxMouseEvent\& }{event}}
 225
 226 This method is called when a mouse button is clicked inside wxHtmlWindow.
 227
 228 The default behaviour is to emit a \helpref{wxHtmlCellEvent}{wxhtmlcellevent}
 229 and, if the event was not processed or skipped, call
 230 \helpref{OnLinkClicked}{wxhtmlwindowonlinkclicked} if the cell contains an
 231 hypertext link.
 232
 233 Overloading this method is deprecated; intercept the event instead.
 234
 235
 236 \wxheading{Parameters}
 237
 238 \docparam{cell}{The cell inside which the mouse was clicked, always a simple
 239 (i.e. non-container) cell}
 240
 241 \docparam{x, y}{The logical coordinates of the click point}
 242
 243 \docparam{event}{The mouse event containing other information about the click}
 244
 245 \wxheading{Return value}
 246
 247 \true if a link was clicked, \false otherwise.
 248
 249 \membersection{wxHtmlWindow::OnCellMouseHover}\label{wxhtmlwindowoncellmousehover}
 250
 251 \func{virtual void}{OnCellMouseHover}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}}
 252
 253 This method is called when a mouse moves over an HTML cell.
 254 Default behaviour is to emit a \helpref{wxHtmlCellEvent}{wxhtmlcellevent}.
 255 Overloading this method is deprecated; intercept the event instead.
 256
 257 \wxheading{Parameters}
 258
 259 \docparam{cell}{The cell inside which the mouse is currently, always a simple
 260 (i.e. non-container) cell}
 261
 262 \docparam{x, y}{The logical coordinates of the click point}
 263
 264 \membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked}
 265
 266 \func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}}
 267
 268 Called when user clicks on hypertext link. Default behaviour is to emit a
 269 \helpref{wxHtmlLinkEvent}{wxhtmllinkevent} and, if the event was not processed
 270 or skipped, call \helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else.
 271 Overloading this method is deprecated; intercept the event instead.
 272
 273 Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.
 274
 275 \membersection{wxHtmlWindow::OnOpeningURL}\label{wxhtmlwindowonopeningurl}
 276
 277 \func{virtual wxHtmlOpeningStatus}{OnOpeningURL}{\param{wxHtmlURLType }{type},\param{const wxString\& }{url}, \param{wxString *}{redirect}}
 278
 279 Called when an URL is being opened (either when the user clicks on a link or
 280 an image is loaded). The URL will be opened only if OnOpeningURL returns
 281 {\tt wxHTML\_OPEN}. This method is called by
 282 \helpref{wxHtmlParser::OpenURL}{wxhtmlparseropenurl}.
 283 You can override OnOpeningURL to selectively block some
 284 URLs (e.g. for security reasons) or to redirect them elsewhere. Default
 285 behaviour is to always return {\tt wxHTML\_OPEN}.
 286
 287 \wxheading{Parameters}
 288
 289 \docparam{type}{Indicates type of the resource. Is one of
 290 \begin{twocollist}\itemsep=0pt
 291 \twocolitem{{\bf wxHTML\_URL\_PAGE}}{Opening a HTML page.}
 292 \twocolitem{{\bf wxHTML\_URL\_IMAGE}}{Opening an image.}
 293 \twocolitem{{\bf wxHTML\_URL\_OTHER}}{Opening a resource that doesn't fall into
 294 any other category.}
 295 \end{twocollist}}
 296
 297 \docparam{url}{URL being opened.}
 298
 299 \docparam{redirect}{Pointer to wxString variable that must be filled with an
 300 URL if OnOpeningURL returns {\tt wxHTML\_REDIRECT}.}
 301
 302 \wxheading{Return value}
 303 \begin{twocollist}\itemsep=0pt
 304 \twocolitem{{\bf wxHTML\_OPEN}}{Open the URL.}
 305 \twocolitem{{\bf wxHTML\_BLOCK}}{Deny access to the URL, \helpref{wxHtmlParser::OpenURL}{wxhtmlparseropenurl} will return NULL.}
 306 \twocolitem{{\bf wxHTML\_REDIRECT}}{Don't open {\it url}, redirect to another
 307 URL. OnOpeningURL must fill {\it *redirect} with the new URL. OnOpeningURL will
 308 be called again on returned URL.}
 309 \end{twocollist}
 310
 311 \membersection{wxHtmlWindow::OnSetTitle}\label{wxhtmlwindowonsettitle}
 312
 313 \func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}}
 314
 315 Called on parsing {\tt <TITLE>} tag.
 316
 317
 318 \membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization}
 319
 320 \func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
 321
 322 This reads custom settings from wxConfig. It uses the path 'path'
 323 if given, otherwise it saves info into currently selected path.
 324 The values are stored in sub-path {\tt wxHtmlWindow}
 325
 326 Read values: all things set by SetFonts, SetBorders.
 327
 328 \wxheading{Parameters}
 329
 330 \docparam{cfg}{wxConfig from which you want to read the configuration.}
 331
 332 \docparam{path}{Optional path in config tree. If not given current path is used.}
 333
 334 \membersection{wxHtmlWindow::SelectAll}\label{wxhtmlwindowselectall}
 335
 336 \func{void}{SelectAll}{\void}
 337
 338 Selects all text in the window.
 339
 340 \wxheading{See also}
 341
 342 \helpref{SelectLine}{wxhtmlwindowselectline},
 343 \helpref{SelectWord}{wxhtmlwindowselectword}
 344
 345 \membersection{wxHtmlWindow::SelectionToText}\label{wxhtmlwindowselectiontotext}
 346
 347 \func{wxString}{SelectionToText}{\void}
 348
 349 Returns current selection as plain text. Returns empty string if no text
 350 is currently selected.
 351
 352 \membersection{wxHtmlWindow::SelectLine}\label{wxhtmlwindowselectline}
 353
 354 \func{void}{SelectLine}{\param{const wxPoint\& }{pos}}
 355
 356 Selects the line of text that \arg{pos} points at. Note that \arg{pos}
 357 is relative to the top of displayed page, not to window's origin, use
 358 \helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition}
 359 to convert physical coordinate.
 360
 361 \wxheading{See also}
 362
 363 \helpref{SelectAll}{wxhtmlwindowselectall},
 364 \helpref{SelectWord}{wxhtmlwindowselectword}
 365
 366 \membersection{wxHtmlWindow::SelectWord}\label{wxhtmlwindowselectword}
 367
 368 \func{void}{SelectWord}{\param{const wxPoint\& }{pos}}
 369
 370 Selects the word at position \arg{pos}. Note that \arg{pos}
 371 is relative to the top of displayed page, not to window's origin, use
 372 \helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition}
 373 to convert physical coordinate.
 374
 375 \wxheading{See also}
 376
 377 \helpref{SelectAll}{wxhtmlwindowselectall},
 378 \helpref{SelectLine}{wxhtmlwindowselectline}
 379
 380 \membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
 381
 382 \func{void}{SetBorders}{\param{int }{b}}
 383
 384 This function sets the space between border of window and HTML contents. See image:
 385
 386 \helponly{\image{}{border.bmp}}
 387
 388 \wxheading{Parameters}
 389
 390 \docparam{b}{indentation from borders in pixels}
 391
 392 \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts}
 393
 394 \func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
 395
 396 This function sets font sizes and faces.
 397
 398 \wxheading{Parameters}
 399
 400 \docparam{normal\_face}{This is face name for normal (i.e. non-fixed) font.
 401 It can be either empty string (then the default face is chosen) or
 402 platform-specific face name. Examples are "helvetica" under Unix or
 403 "Times New Roman" under Windows.}
 404
 405 \docparam{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )}
 406
 407 \docparam{sizes}{This is an array of 7 items of {\it int} type.
 408 The values represent size of font with HTML size from -2 to +4
 409 ( <FONT SIZE=-2> to <FONT SIZE=+4> ). Default sizes are used if {\it sizes}
 410 is NULL.}
 411
 412 \wxheading{Defaults}
 413
 414 Default font sizes are defined by constants wxHTML\_FONT\_SIZE\_1,
 415 wxHTML\_FONT\_SIZE\_2, ..., wxHTML\_FONT\_SIZE\_7. Note that they differ among
 416 platforms. Default face names are empty strings.
 417
 418 \membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage}
 419
 420 \func{bool}{SetPage}{\param{const wxString\& }{source}}
 421
 422 Sets HTML page and display it. This won't {\bf load} the page!!
 423 It will display the {\it source}. See example:
 424
 425 \begin{verbatim}
 426 htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
 427 \end{verbatim}
 428
 429 If you want to load a document from some location use
 430 \helpref{LoadPage}{wxhtmlwindowloadpage} instead.
 431
 432 \wxheading{Parameters}
 433
 434 \docparam{source}{The HTML document source to be displayed.}
 435
 436 \wxheading{Return value}
 437
 438 false if an error occurred, true otherwise.
 439
 440 \membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}
 441
 442 \func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}}
 443
 444 Sets the frame in which page title will be displayed. {\it format} is format of
 445 frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This
 446 \%s is substituted with HTML page title.
 447
 448 \membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar}
 449
 450 \func{void}{SetRelatedStatusBar}{\param{int }{bar}}
 451
 452 {\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe},
 453 this sets statusbar slot where messages will be displayed.
 454 (Default is -1 = no messages.)
 455
 456 \wxheading{Parameters}
 457
 458 \docparam{bar}{statusbar slot number (0..n)}
 459
 460 \membersection{wxHtmlWindow::ToText}\label{wxhtmlwindowtotext}
 461
 462 \func{wxString}{ToText}{\void}
 463
 464 Returns content of currently displayed page as plain text.
 465
 466 \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization}
 467
 468 \func{virtual void}{WriteCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}}
 469
 470 Saves custom settings into wxConfig. It uses the path 'path'
 471 if given, otherwise it saves info into currently selected path.
 472 Regardless of whether the path is given or not, the function creates sub-path
 473 {\tt wxHtmlWindow}.
 474
 475 Saved values: all things set by SetFonts, SetBorders.
 476
 477 \wxheading{Parameters}
 478
 479 \docparam{cfg}{wxConfig to which you want to save the configuration.}
 480
 481 \docparam{path}{Optional path in config tree. If not given, the current path is used.}
 482
 483
 484
 485
 486
 487
 488
 489 \section{\class{wxHtmlLinkEvent}}\label{wxhtmllinkevent}
 490
 491 This event class is used for the events generated by \helpref{wxHtmlWindow}{wxhtmlwindow}.
 492
 493 \wxheading{Derived from}
 494
 495 \helpref{wxCommandEvent}{wxcommandevent}\\
 496 \helpref{wxEvent}{wxevent}\\
 497 \helpref{wxObject}{wxobject}
 498
 499 \wxheading{Include files}
 500
 501 <wx/html/htmlwin.h>
 502
 503 \wxheading{Library}
 504
 505 \helpref{wxHtml}{librarieslist}
 506
 507 \wxheading{Event handling}
 508
 509 To process input from a wxHtmlLinkEvent, use one of these event handler macros to
 510 direct input to member function that take a \helpref{wxHtmlLinkEvent}{wxhtmllinkevent} argument:
 511
 512 \twocolwidtha{7cm}
 513 \begin{twocollist}
 514 \twocolitem{{\bf EVT\_HTML\_LINK\_CLICKED(id, func)}}{User clicked on an hyperlink.}
 515 \end{twocollist}
 516
 517
 518 \latexignore{\rtfignore{\wxheading{Members}}}
 519
 520 \membersection{wxHtmlLinkEvent::wxHtmlLinkEvent}\label{wxhtmllinkeventctor}
 521
 522 \func{}{wxHyperlinkEvent}{\param{int}{ id}, \param{const wxHtmlLinkInfo \&}{ linkinfo}}
 523
 524 The constructor is not normally used by the user code.
 525
 526
 527 \membersection{wxHtmlLinkEvent::GetLinkInfo}\label{wxhtmllinkeventgetlinkinfo}
 528
 529 \constfunc{const wxHtmlLinkInfo &}{GetLinkInfo}{\void}
 530
 531 Returns the \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo} which contains info about the cell clicked and the hyperlink it contains.
 532
 533
 534
 535
 536
 537
 538 \section{\class{wxHtmlCellEvent}}\label{wxhtmlcellevent}
 539
 540 This event class is used for the events generated by \helpref{wxHtmlWindow}{wxhtmlwindow}.
 541
 542 \wxheading{Derived from}
 543
 544 \helpref{wxCommandEvent}{wxcommandevent}\\
 545 \helpref{wxEvent}{wxevent}\\
 546 \helpref{wxObject}{wxobject}
 547
 548 \wxheading{Include files}
 549
 550 <wx/html/htmlwin.h>
 551
 552 \wxheading{Library}
 553
 554 \helpref{wxHtml}{librarieslist}
 555
 556 \wxheading{Event handling}
 557
 558 To process input from a wxHtmlCellEvent, use one of these event handler macros to
 559 direct input to member function that take a \helpref{wxHtmlCellEvent}{wxhtmlcellevent} argument:
 560
 561 \twocolwidtha{7cm}
 562 \begin{twocollist}
 563 \twocolitem{{\bf EVT\_HTML\_CELL\_HOVER(id, func)}}{User moved the mouse over a \helpref{wxHtmlCell}{wxhtmlcell}.}
 564 \twocolitem{{\bf EVT\_HTML\_CELL\_CLICKED(id, func)}}{User clicked on a \helpref{wxHtmlCell}{wxhtmlcell}. When handling this event, remember to use \helpref{wxHtmlCell::SetLinkClicked(true)}{wxhtmlcelleventsetlinkclicked} if the cell contains a link.}
 565 \end{twocollist}
 566
 567
 568 \latexignore{\rtfignore{\wxheading{Members}}}
 569
 570 \membersection{wxHtmlCellEvent::wxHtmlCellEvent}\label{wxhtmlcelleventctor}
 571
 572 \func{}{wxHtmlCellEvent}{\param{wxEventType}{ commandType}, \param{int}{ id}, \param{wxHtmlCell *}{ cell}, \param{const wxPoint \&}{ point}}
 573
 574 The constructor is not normally used by the user code.
 575
 576
 577 \membersection{wxHtmlCellEvent::GetCell}\label{wxhtmlcelleventgetcell}
 578
 579 \constfunc{wxHtmlCell *}{GetCell}{\void}
 580
 581 Returns the \helpref{wxHtmlCellEvent}{wxhtmlcellevent} associated with the event.
 582
 583
 584 \membersection{wxHtmlCellEvent::GetPoint}\label{wxhtmlcelleventgetpoint}
 585
 586 \constfunc{wxPoint}{GetPoint}{\void}
 587
 588 Returns the \helpref{wxPoint}{wxpoint} associated with the event.
 589
 590
 591 \membersection{wxHtmlCellEvent::SetLinkClicked}\label{wxhtmlcelleventsetlinkclicked}
 592
 593 \func{bool}{SetLinkClicked}{\param{bool}{ linkclicked}}
 594
 595 Call this function with {\tt linkclicked} set to \true if the cell which has been clicked contained a link or
 596 \false otherwise (which is the default). With this function the event handler can return info to the
 597 wxHtmlWindow which sent the event.
 598
 599
 600 \membersection{wxHtmlCellEvent::GetLinkClicked}\label{wxhtmlcelleventgetlinkclicked}
 601
 602 \constfunc{bool}{GetLinkClicked}{\void}
 603
 604 Returns \true if \helpref{SetLinkClicked(true)}{wxhtmlcelleventsetlinkclicked} has previously been called;
 605 \false otherwise.
 606