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