include/wx/html/htmlwin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmlwin.h
   3 // Purpose:     wxHtmlWindow class for parsing & displaying HTML
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999 Vaclav Slavik
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_HTMLWIN_H_
  11 #define _WX_HTMLWIN_H_
  12
  13 #include "wx/defs.h"
  14 #if wxUSE_HTML
  15
  16 #include "wx/window.h"
  17 #include "wx/scrolwin.h"
  18 #include "wx/config.h"
  19 #include "wx/stopwatch.h"
  20 #include "wx/html/winpars.h"
  21 #include "wx/html/htmlcell.h"
  22 #include "wx/filesys.h"
  23 #include "wx/html/htmlfilt.h"
  24 #include "wx/filename.h"
  25 #include "wx/bitmap.h"
  26
  27 class wxHtmlProcessor;
  28 class wxHtmlWinModule;
  29 class wxHtmlHistoryArray;
  30 class wxHtmlProcessorList;
  31 class WXDLLIMPEXP_FWD_HTML wxHtmlWinAutoScrollTimer;
  32 class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent;
  33 class WXDLLIMPEXP_FWD_HTML wxHtmlLinkEvent;
  34 class WXDLLIMPEXP_FWD_CORE wxStatusBar;
  35
  36 // wxHtmlWindow flags:
  37 #define wxHW_SCROLLBAR_NEVER    0x0002
  38 #define wxHW_SCROLLBAR_AUTO     0x0004
  39 #define wxHW_NO_SELECTION       0x0008
  40
  41 #define wxHW_DEFAULT_STYLE      wxHW_SCROLLBAR_AUTO
  42
  43 /// Enum for wxHtmlWindow::OnOpeningURL and wxHtmlWindowInterface::OnOpeningURL
  44 enum wxHtmlOpeningStatus
  45 {
  46     /// Open the requested URL
  47     wxHTML_OPEN,
  48     /// Do not open the URL
  49     wxHTML_BLOCK,
  50     /// Redirect to another URL (returned from OnOpeningURL)
  51     wxHTML_REDIRECT
  52 };
  53
  54 /**
  55     Abstract interface to a HTML rendering window (such as wxHtmlWindow or
  56     wxHtmlListBox) that is passed to wxHtmlWinParser. It encapsulates all
  57     communication from the parser to the window.
  58  */
  59 class WXDLLIMPEXP_HTML wxHtmlWindowInterface
  60 {
  61 public:
  62     /// Ctor
  63     wxHtmlWindowInterface() {}
  64     virtual ~wxHtmlWindowInterface() {}
  65
  66     /**
  67         Called by the parser to set window's title to given text.
  68      */
  69     virtual void SetHTMLWindowTitle(const wxString& title) = 0;
  70
  71     /**
  72         Called when a link is clicked.
  73
  74         @param link information about the clicked link
  75      */
  76     virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link) = 0;
  77
  78     /**
  79         Called when the parser needs to open another URL (e.g. an image).
  80
  81         @param type     Type of the URL request (e.g. image)
  82         @param url      URL the parser wants to open
  83         @param redirect If the return value is wxHTML_REDIRECT, then the
  84                         URL to redirect to will be stored in this variable
  85                         (the pointer must never be NULL)
  86
  87         @return indicator of how to treat the request
  88      */
  89     virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type,
  90                                                  const wxString& url,
  91                                                  wxString *redirect) const = 0;
  92
  93     /**
  94         Converts coordinates @a pos relative to given @a cell to
  95         physical coordinates in the window.
  96      */
  97     virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell,
  98                                        const wxPoint& pos) const = 0;
  99
 100     /// Returns the window used for rendering (may be NULL).
 101     virtual wxWindow* GetHTMLWindow() = 0;
 102
 103     /// Returns background colour to use by default.
 104     virtual wxColour GetHTMLBackgroundColour() const = 0;
 105
 106     /// Sets window's background to colour @a clr.
 107     virtual void SetHTMLBackgroundColour(const wxColour& clr) = 0;
 108
 109     /// Sets window's background to given bitmap.
 110     virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg) = 0;
 111
 112     /// Sets status bar text.
 113     virtual void SetHTMLStatusText(const wxString& text) = 0;
 114
 115     /// Type of mouse cursor
 116     enum HTMLCursor
 117     {
 118         /// Standard mouse cursor (typically an arrow)
 119         HTMLCursor_Default,
 120         /// Cursor shown over links
 121         HTMLCursor_Link,
 122         /// Cursor shown over selectable text
 123         HTMLCursor_Text
 124     };
 125
 126     /**
 127         Returns mouse cursor of given @a type.
 128      */
 129     virtual wxCursor GetHTMLCursor(HTMLCursor type) const = 0;
 130 };
 131
 132 /**
 133     Helper class that implements part of mouse handling for wxHtmlWindow and
 134     wxHtmlListBox. Cursor changes and clicking on links are handled, text
 135     selection is not.
 136  */
 137 class WXDLLIMPEXP_HTML wxHtmlWindowMouseHelper
 138 {
 139 protected:
 140     /**
 141         Ctor.
 142
 143         @param iface Interface to the owner window.
 144      */
 145     wxHtmlWindowMouseHelper(wxHtmlWindowInterface *iface);
 146
 147     /**
 148         Virtual dtor.
 149
 150         It is not really needed in this case but at leats it prevents gcc from
 151         complaining about its absence.
 152      */
 153     virtual ~wxHtmlWindowMouseHelper() { }
 154
 155     /// Returns true if the mouse moved since the last call to HandleIdle
 156     bool DidMouseMove() const { return m_tmpMouseMoved; }
 157
 158     /// Call this from EVT_MOTION event handler
 159     void HandleMouseMoved();
 160
 161     /**
 162         Call this from EVT_LEFT_UP handler (or, alternatively, EVT_LEFT_DOWN).
 163
 164         @param rootCell HTML cell inside which the click occured. This doesn't
 165                         have to be the leaf cell, it can be e.g. toplevel
 166                         container, but the mouse must be inside the container's
 167                         area, otherwise the event would be ignored.
 168         @param pos      Mouse position in coordinates relative to @a cell
 169         @param event    The event that triggered the call
 170      */
 171     bool HandleMouseClick(wxHtmlCell *rootCell,
 172                           const wxPoint& pos, const wxMouseEvent& event);
 173
 174     /**
 175         Call this from OnInternalIdle of the HTML displaying window. Handles
 176         mouse movements and must be used together with HandleMouseMoved.
 177
 178         @param rootCell HTML cell inside which the click occured. This doesn't
 179                         have to be the leaf cell, it can be e.g. toplevel
 180                         container, but the mouse must be inside the container's
 181                         area, otherwise the event would be ignored.
 182         @param pos      Current mouse position in coordinates relative to
 183                         @a cell
 184      */
 185     void HandleIdle(wxHtmlCell *rootCell, const wxPoint& pos);
 186
 187     /**
 188         Called by HandleIdle when the mouse hovers over a cell. Default
 189         behaviour is to do nothing.
 190
 191         @param cell   the cell the mouse is over
 192         @param x, y   coordinates of mouse relative to the cell
 193      */
 194     virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
 195
 196     /**
 197         Called by HandleMouseClick when the user clicks on a cell.
 198         Default behavior is to call wxHtmlWindowInterface::OnLinkClicked()
 199         if this cell corresponds to a hypertext link.
 200
 201         @param cell   the cell the mouse is over
 202         @param x, y   coordinates of mouse relative to the cell
 203         @param event    The event that triggered the call
 204
 205
 206         @return true if a link was clicked, false otherwise.
 207      */
 208     virtual bool OnCellClicked(wxHtmlCell *cell,
 209                                wxCoord x, wxCoord y,
 210                                const wxMouseEvent& event);
 211
 212 protected:
 213     // this flag indicates if the mouse moved (used by HandleIdle)
 214     bool m_tmpMouseMoved;
 215     // contains last link name
 216     wxHtmlLinkInfo *m_tmpLastLink;
 217     // contains the last (terminal) cell which contained the mouse
 218     wxHtmlCell *m_tmpLastCell;
 219
 220 private:
 221     wxHtmlWindowInterface *m_interface;
 222 };
 223
 224 // ----------------------------------------------------------------------------
 225 // wxHtmlWindow
 226 //                  (This is probably the only class you will directly use.)
 227 //                  Purpose of this class is to display HTML page (either local
 228 //                  file or downloaded via HTTP protocol) in a window. Width of
 229 //                  window is constant - given in constructor - virtual height
 230 //                  is changed dynamicly depending on page size.  Once the
 231 //                  window is created you can set it's content by calling
 232 //                  SetPage(text) or LoadPage(filename).
 233 // ----------------------------------------------------------------------------
 234
 235 class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow,
 236                                       public wxHtmlWindowInterface,
 237                                       public wxHtmlWindowMouseHelper
 238 {
 239     DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
 240     friend class wxHtmlWinModule;
 241
 242 public:
 243     wxHtmlWindow() : wxHtmlWindowMouseHelper(this) { Init(); }
 244     wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
 245                  const wxPoint& pos = wxDefaultPosition,
 246                  const wxSize& size = wxDefaultSize,
 247                  long style = wxHW_DEFAULT_STYLE,
 248                  const wxString& name = wxT("htmlWindow"))
 249         : wxHtmlWindowMouseHelper(this)
 250     {
 251         Init();
 252         Create(parent, id, pos, size, style, name);
 253     }
 254     virtual ~wxHtmlWindow();
 255
 256     bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
 257                 const wxPoint& pos = wxDefaultPosition,
 258                 const wxSize& size = wxDefaultSize,
 259                 long style = wxHW_SCROLLBAR_AUTO,
 260                 const wxString& name = wxT("htmlWindow"));
 261
 262     // Set HTML page and display it. !! source is HTML document itself,
 263     // it is NOT address/filename of HTML document. If you want to
 264     // specify document location, use LoadPage() istead
 265     // Return value : false if an error occurred, true otherwise
 266     virtual bool SetPage(const wxString& source);
 267
 268     // Append to current page
 269     bool AppendToPage(const wxString& source);
 270
 271     // Load HTML page from given location. Location can be either
 272     // a) /usr/wxGTK2/docs/html/wx.htm
 273     // b) http://www.somewhere.uk/document.htm
 274     // c) ftp://ftp.somesite.cz/pub/something.htm
 275     // In case there is no prefix (http:,ftp:), the method
 276     // will try to find it itself (1. local file, then http or ftp)
 277     // After the page is loaded, the method calls SetPage() to display it.
 278     // Note : you can also use path relative to previously loaded page
 279     // Return value : same as SetPage
 280     virtual bool LoadPage(const wxString& location);
 281
 282     // Loads HTML page from file
 283     bool LoadFile(const wxFileName& filename);
 284
 285     // Returns full location of opened page
 286     wxString GetOpenedPage() const {return m_OpenedPage;}
 287     // Returns anchor within opened page
 288     wxString GetOpenedAnchor() const {return m_OpenedAnchor;}
 289     // Returns <TITLE> of opened page or empty string otherwise
 290     wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;}
 291
 292     // Sets frame in which page title will  be displayed. Format is format of
 293     // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
 294     void SetRelatedFrame(wxFrame* frame, const wxString& format);
 295     wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
 296
 297 #if wxUSE_STATUSBAR
 298     // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
 299     // will be displayed. Default is -1 = no messages.
 300     void SetRelatedStatusBar(int index);
 301     void SetRelatedStatusBar(wxStatusBar*, int index = 0);
 302 #endif // wxUSE_STATUSBAR
 303
 304     // Sets fonts to be used when displaying HTML page.
 305     void SetFonts(const wxString& normal_face, const wxString& fixed_face,
 306                   const int *sizes = NULL);
 307
 308     // Sets font sizes to be relative to the given size or the system
 309     // default size; use either specified or default font
 310     void SetStandardFonts(int size = -1,
 311                           const wxString& normal_face = wxEmptyString,
 312                           const wxString& fixed_face = wxEmptyString);
 313
 314     // Sets space between text and window borders.
 315     void SetBorders(int b) {m_Borders = b;}
 316
 317     // Sets the bitmap to use for background (currnetly it will be tiled,
 318     // when/if we have CSS support we could add other possibilities...)
 319     void SetBackgroundImage(const wxBitmap& bmpBg) { m_bmpBg = bmpBg; }
 320
 321     // Saves custom settings into cfg config. it will use the path 'path'
 322     // if given, otherwise it will save info into currently selected path.
 323     // saved values : things set by SetFonts, SetBorders.
 324     virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 325     // ...
 326     virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 327
 328     // Goes to previous/next page (in browsing history)
 329     // Returns true if successful, false otherwise
 330     bool HistoryBack();
 331     bool HistoryForward();
 332     bool HistoryCanBack();
 333     bool HistoryCanForward();
 334     // Resets history
 335     void HistoryClear();
 336
 337     // Returns pointer to conteiners/cells structure.
 338     // It should be used ONLY when printing
 339     wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;}
 340
 341     // Adds input filter
 342     static void AddFilter(wxHtmlFilter *filter);
 343
 344     // Returns a pointer to the parser.
 345     wxHtmlWinParser *GetParser() const { return m_Parser; }
 346
 347     // Adds HTML processor to this instance of wxHtmlWindow:
 348     void AddProcessor(wxHtmlProcessor *processor);
 349     // Adds HTML processor to wxHtmlWindow class as whole:
 350     static void AddGlobalProcessor(wxHtmlProcessor *processor);
 351
 352
 353     // -- Callbacks --
 354
 355     // Sets the title of the window
 356     // (depending on the information passed to SetRelatedFrame() method)
 357     virtual void OnSetTitle(const wxString& title);
 358
 359     // Called when user clicked on hypertext link. Default behavior is to
 360     // call LoadPage(loc)
 361     virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
 362
 363     // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
 364     // loading a page or loading an image). The data are downloaded if and only if
 365     // OnOpeningURL returns true. If OnOpeningURL returns wxHTML_REDIRECT,
 366     // it must set *redirect to the new URL
 367     virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
 368                                              const wxString& WXUNUSED(url),
 369                                              wxString *WXUNUSED(redirect)) const
 370         { return wxHTML_OPEN; }
 371
 372 #if wxUSE_CLIPBOARD
 373     // Helper functions to select parts of page:
 374     void SelectWord(const wxPoint& pos);
 375     void SelectLine(const wxPoint& pos);
 376     void SelectAll();
 377
 378     // Convert selection to text:
 379     wxString SelectionToText() { return DoSelectionToText(m_selection); }
 380
 381     // Converts current page to text:
 382     wxString ToText();
 383 #endif // wxUSE_CLIPBOARD
 384
 385     virtual void OnInternalIdle();
 386
 387     /// Returns standard HTML cursor as used by wxHtmlWindow
 388     static wxCursor GetDefaultHTMLCursor(HTMLCursor type);
 389
 390 protected:
 391     void Init();
 392
 393     // Scrolls to anchor of this name. (Anchor is #news
 394     // or #features etc. it is part of address sometimes:
 395     // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
 396     // Return value : true if anchor exists, false otherwise
 397     bool ScrollToAnchor(const wxString& anchor);
 398
 399     // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
 400     // actual size of window. This method also setup scrollbars
 401     void CreateLayout();
 402
 403     void OnPaint(wxPaintEvent& event);
 404     void OnSize(wxSizeEvent& event);
 405     void OnMouseMove(wxMouseEvent& event);
 406     void OnMouseDown(wxMouseEvent& event);
 407     void OnMouseUp(wxMouseEvent& event);
 408 #if wxUSE_CLIPBOARD
 409     void OnKeyUp(wxKeyEvent& event);
 410     void OnDoubleClick(wxMouseEvent& event);
 411     void OnCopy(wxCommandEvent& event);
 412     void OnClipboardEvent(wxClipboardTextEvent& event);
 413     void OnMouseEnter(wxMouseEvent& event);
 414     void OnMouseLeave(wxMouseEvent& event);
 415     void OnMouseCaptureLost(wxMouseCaptureLostEvent& event);
 416 #endif // wxUSE_CLIPBOARD
 417
 418     // Returns new filter (will be stored into m_DefaultFilter variable)
 419     virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
 420
 421     // cleans static variables
 422     static void CleanUpStatics();
 423
 424     // Returns true if text selection is enabled (wxClipboard must be available
 425     // and wxHW_NO_SELECTION not used)
 426     bool IsSelectionEnabled() const;
 427
 428     enum ClipboardType
 429     {
 430         Primary,
 431         Secondary
 432     };
 433
 434     // Copies selection to clipboard if the clipboard support is available
 435     //
 436     // returns true if anything was copied to clipboard, false otherwise
 437     bool CopySelection(ClipboardType t = Secondary);
 438
 439 #if wxUSE_CLIPBOARD
 440     // Automatic scrolling during selection:
 441     void StopAutoScrolling();
 442 #endif // wxUSE_CLIPBOARD
 443
 444     wxString DoSelectionToText(wxHtmlSelection *sel);
 445
 446 public:
 447     // wxHtmlWindowInterface methods:
 448     virtual void SetHTMLWindowTitle(const wxString& title);
 449     virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);
 450     virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type,
 451                                                  const wxString& url,
 452                                                  wxString *redirect) const;
 453     virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell,
 454                                        const wxPoint& pos) const;
 455     virtual wxWindow* GetHTMLWindow();
 456     virtual wxColour GetHTMLBackgroundColour() const;
 457     virtual void SetHTMLBackgroundColour(const wxColour& clr);
 458     virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg);
 459     virtual void SetHTMLStatusText(const wxString& text);
 460     virtual wxCursor GetHTMLCursor(HTMLCursor type) const;
 461
 462     // implementation of SetPage()
 463     bool DoSetPage(const wxString& source);
 464
 465 protected:
 466     // This is pointer to the first cell in parsed data.  (Note: the first cell
 467     // is usually top one = all other cells are sub-cells of this one)
 468     wxHtmlContainerCell *m_Cell;
 469     // parser which is used to parse HTML input.
 470     // Each wxHtmlWindow has it's own parser because sharing one global
 471     // parser would be problematic (because of reentrancy)
 472     wxHtmlWinParser *m_Parser;
 473     // contains name of actualy opened page or empty string if no page opened
 474     wxString m_OpenedPage;
 475     // contains name of current anchor within m_OpenedPage
 476     wxString m_OpenedAnchor;
 477     // contains title of actualy opened page or empty string if no <TITLE> tag
 478     wxString m_OpenedPageTitle;
 479     // class for opening files (file system)
 480     wxFileSystem* m_FS;
 481
 482     // frame in which page title should be displayed & number of it's statusbar
 483     // reserved for usage with this html window
 484     wxFrame *m_RelatedFrame;
 485 #if wxUSE_STATUSBAR
 486     int m_RelatedStatusBarIndex;
 487     wxStatusBar* m_RelatedStatusBar;
 488 #endif // wxUSE_STATUSBAR
 489     wxString m_TitleFormat;
 490
 491     // borders (free space between text and window borders)
 492     // defaults to 10 pixels.
 493     int m_Borders;
 494
 495     // current text selection or NULL
 496     wxHtmlSelection *m_selection;
 497
 498     // true if the user is dragging mouse to select text
 499     bool m_makingSelection;
 500
 501 #if wxUSE_CLIPBOARD
 502     // time of the last doubleclick event, used to detect tripleclicks
 503     // (tripleclicks are used to select whole line):
 504     wxMilliClock_t m_lastDoubleClick;
 505
 506     // helper class to automatically scroll the window if the user is selecting
 507     // text and the mouse leaves wxHtmlWindow:
 508     wxHtmlWinAutoScrollTimer *m_timerAutoScroll;
 509 #endif // wxUSE_CLIPBOARD
 510
 511 private:
 512     // erase the window background using m_bmpBg or just solid colour if we
 513     // don't have any background image
 514     void DoEraseBackground(wxDC& dc);
 515
 516     // window content for double buffered rendering, may be invalid until it is
 517     // really initialized in OnPaint()
 518     wxBitmap m_backBuffer;
 519
 520     // background image, may be invalid
 521     wxBitmap m_bmpBg;
 522
 523     // variables used when user is selecting text
 524     wxPoint     m_tmpSelFromPos;
 525     wxHtmlCell *m_tmpSelFromCell;
 526
 527     // if >0 contents of the window is not redrawn
 528     // (in order to avoid ugly blinking)
 529     int m_tmpCanDrawLocks;
 530
 531     // list of HTML filters
 532     static wxList m_Filters;
 533     // this filter is used when no filter is able to read some file
 534     static wxHtmlFilter *m_DefaultFilter;
 535
 536     // html processors array:
 537     wxHtmlProcessorList *m_Processors;
 538     static wxHtmlProcessorList *m_GlobalProcessors;
 539
 540     // browser history
 541     wxHtmlHistoryArray *m_History;
 542     int m_HistoryPos;
 543     // if this FLAG is false, items are not added to history
 544     bool m_HistoryOn;
 545
 546     // standard mouse cursors
 547     static wxCursor *ms_cursorLink;
 548     static wxCursor *ms_cursorText;
 549
 550     DECLARE_EVENT_TABLE()
 551     wxDECLARE_NO_COPY_CLASS(wxHtmlWindow);
 552 };
 553
 554 class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent;
 555
 556 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent );
 557 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent );
 558 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent );
 559
 560
 561 /*!
 562  * Html cell window event
 563  */
 564
 565 class WXDLLIMPEXP_HTML wxHtmlCellEvent : public wxCommandEvent
 566 {
 567 public:
 568     wxHtmlCellEvent() {}
 569     wxHtmlCellEvent(wxEventType commandType, int id,
 570                     wxHtmlCell *cell, const wxPoint &pt,
 571                     const wxMouseEvent &ev)
 572         : wxCommandEvent(commandType, id)
 573     {
 574         m_cell = cell;
 575         m_pt = pt;
 576         m_mouseEvent = ev;
 577         m_bLinkWasClicked = false;
 578     }
 579
 580     wxHtmlCell* GetCell() const { return m_cell; }
 581     wxPoint GetPoint() const { return m_pt; }
 582     wxMouseEvent GetMouseEvent() const { return m_mouseEvent; }
 583
 584     void SetLinkClicked(bool linkclicked) { m_bLinkWasClicked=linkclicked; }
 585     bool GetLinkClicked() const { return m_bLinkWasClicked; }
 586
 587     // default copy ctor, assignment operator and dtor are ok
 588     virtual wxEvent *Clone() const { return new wxHtmlCellEvent(*this); }
 589
 590 private:
 591     wxHtmlCell *m_cell;
 592     wxMouseEvent m_mouseEvent;
 593     wxPoint m_pt;
 594
 595     bool m_bLinkWasClicked;
 596
 597     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlCellEvent)
 598 };
 599
 600
 601
 602 /*!
 603  * Html link event
 604  */
 605
 606 class WXDLLIMPEXP_HTML wxHtmlLinkEvent : public wxCommandEvent
 607 {
 608 public:
 609     wxHtmlLinkEvent() {}
 610     wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo)
 611         : wxCommandEvent(wxEVT_COMMAND_HTML_LINK_CLICKED, id)
 612     {
 613         m_linkInfo = linkinfo;
 614     }
 615
 616     const wxHtmlLinkInfo &GetLinkInfo() const { return m_linkInfo; }
 617
 618     // default copy ctor, assignment operator and dtor are ok
 619     virtual wxEvent *Clone() const { return new wxHtmlLinkEvent(*this); }
 620
 621 private:
 622     wxHtmlLinkInfo m_linkInfo;
 623
 624     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlLinkEvent)
 625 };
 626
 627
 628 typedef void (wxEvtHandler::*wxHtmlCellEventFunction)(wxHtmlCellEvent&);
 629 typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&);
 630
 631 #define wxHtmlCellEventHandler(func) \
 632     wxEVENT_HANDLER_CAST(wxHtmlCellEventFunction, func)
 633 #define wxHtmlLinkEventHandler(func) \
 634     wxEVENT_HANDLER_CAST(wxHtmlLinkEventFunction, func)
 635
 636 #define EVT_HTML_CELL_CLICKED(id, fn) \
 637     wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn))
 638 #define EVT_HTML_CELL_HOVER(id, fn) \
 639     wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_HOVER, id, wxHtmlCellEventHandler(fn))
 640 #define EVT_HTML_LINK_CLICKED(id, fn) \
 641     wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_LINK_CLICKED, id, wxHtmlLinkEventHandler(fn))
 642
 643
 644 #endif // wxUSE_HTML
 645
 646 #endif // _WX_HTMLWIN_H_
 647