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