| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/html/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 behaviour 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 | #if wxUSE_CONFIG |
| 322 | // Saves custom settings into cfg config. it will use the path 'path' |
| 323 | // if given, otherwise it will save info into currently selected path. |
| 324 | // saved values : things set by SetFonts, SetBorders. |
| 325 | virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString); |
| 326 | // ... |
| 327 | virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString); |
| 328 | #endif // wxUSE_CONFIG |
| 329 | |
| 330 | // Goes to previous/next page (in browsing history) |
| 331 | // Returns true if successful, false otherwise |
| 332 | bool HistoryBack(); |
| 333 | bool HistoryForward(); |
| 334 | bool HistoryCanBack(); |
| 335 | bool HistoryCanForward(); |
| 336 | // Resets history |
| 337 | void HistoryClear(); |
| 338 | |
| 339 | // Returns pointer to conteiners/cells structure. |
| 340 | // It should be used ONLY when printing |
| 341 | wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;} |
| 342 | |
| 343 | // Adds input filter |
| 344 | static void AddFilter(wxHtmlFilter *filter); |
| 345 | |
| 346 | // Returns a pointer to the parser. |
| 347 | wxHtmlWinParser *GetParser() const { return m_Parser; } |
| 348 | |
| 349 | // Adds HTML processor to this instance of wxHtmlWindow: |
| 350 | void AddProcessor(wxHtmlProcessor *processor); |
| 351 | // Adds HTML processor to wxHtmlWindow class as whole: |
| 352 | static void AddGlobalProcessor(wxHtmlProcessor *processor); |
| 353 | |
| 354 | |
| 355 | // -- Callbacks -- |
| 356 | |
| 357 | // Sets the title of the window |
| 358 | // (depending on the information passed to SetRelatedFrame() method) |
| 359 | virtual void OnSetTitle(const wxString& title); |
| 360 | |
| 361 | // Called when user clicked on hypertext link. Default behaviour is to |
| 362 | // call LoadPage(loc) |
| 363 | virtual void OnLinkClicked(const wxHtmlLinkInfo& link); |
| 364 | |
| 365 | // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when |
| 366 | // loading a page or loading an image). The data are downloaded if and only if |
| 367 | // OnOpeningURL returns true. If OnOpeningURL returns wxHTML_REDIRECT, |
| 368 | // it must set *redirect to the new URL |
| 369 | virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type), |
| 370 | const wxString& WXUNUSED(url), |
| 371 | wxString *WXUNUSED(redirect)) const |
| 372 | { return wxHTML_OPEN; } |
| 373 | |
| 374 | #if wxUSE_CLIPBOARD |
| 375 | // Helper functions to select parts of page: |
| 376 | void SelectWord(const wxPoint& pos); |
| 377 | void SelectLine(const wxPoint& pos); |
| 378 | void SelectAll(); |
| 379 | |
| 380 | // Convert selection to text: |
| 381 | wxString SelectionToText() { return DoSelectionToText(m_selection); } |
| 382 | |
| 383 | // Converts current page to text: |
| 384 | wxString ToText(); |
| 385 | #endif // wxUSE_CLIPBOARD |
| 386 | |
| 387 | virtual void OnInternalIdle(); |
| 388 | |
| 389 | /// Returns standard HTML cursor as used by wxHtmlWindow |
| 390 | static wxCursor GetDefaultHTMLCursor(HTMLCursor type); |
| 391 | |
| 392 | protected: |
| 393 | void Init(); |
| 394 | |
| 395 | // Scrolls to anchor of this name. (Anchor is #news |
| 396 | // or #features etc. it is part of address sometimes: |
| 397 | // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news) |
| 398 | // Return value : true if anchor exists, false otherwise |
| 399 | bool ScrollToAnchor(const wxString& anchor); |
| 400 | |
| 401 | // Prepares layout (= fill m_PosX, m_PosY for fragments) based on |
| 402 | // actual size of window. This method also setup scrollbars |
| 403 | void CreateLayout(); |
| 404 | |
| 405 | void OnPaint(wxPaintEvent& event); |
| 406 | void OnSize(wxSizeEvent& event); |
| 407 | void OnMouseMove(wxMouseEvent& event); |
| 408 | void OnMouseDown(wxMouseEvent& event); |
| 409 | void OnMouseUp(wxMouseEvent& event); |
| 410 | #if wxUSE_CLIPBOARD |
| 411 | void OnKeyUp(wxKeyEvent& event); |
| 412 | void OnDoubleClick(wxMouseEvent& event); |
| 413 | void OnCopy(wxCommandEvent& event); |
| 414 | void OnClipboardEvent(wxClipboardTextEvent& event); |
| 415 | void OnMouseEnter(wxMouseEvent& event); |
| 416 | void OnMouseLeave(wxMouseEvent& event); |
| 417 | void OnMouseCaptureLost(wxMouseCaptureLostEvent& event); |
| 418 | #endif // wxUSE_CLIPBOARD |
| 419 | |
| 420 | // Returns new filter (will be stored into m_DefaultFilter variable) |
| 421 | virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;} |
| 422 | |
| 423 | // cleans static variables |
| 424 | static void CleanUpStatics(); |
| 425 | |
| 426 | // Returns true if text selection is enabled (wxClipboard must be available |
| 427 | // and wxHW_NO_SELECTION not used) |
| 428 | bool IsSelectionEnabled() const; |
| 429 | |
| 430 | enum ClipboardType |
| 431 | { |
| 432 | Primary, |
| 433 | Secondary |
| 434 | }; |
| 435 | |
| 436 | // Copies selection to clipboard if the clipboard support is available |
| 437 | // |
| 438 | // returns true if anything was copied to clipboard, false otherwise |
| 439 | bool CopySelection(ClipboardType t = Secondary); |
| 440 | |
| 441 | #if wxUSE_CLIPBOARD |
| 442 | // Automatic scrolling during selection: |
| 443 | void StopAutoScrolling(); |
| 444 | #endif // wxUSE_CLIPBOARD |
| 445 | |
| 446 | wxString DoSelectionToText(wxHtmlSelection *sel); |
| 447 | |
| 448 | public: |
| 449 | // wxHtmlWindowInterface methods: |
| 450 | virtual void SetHTMLWindowTitle(const wxString& title); |
| 451 | virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link); |
| 452 | virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type, |
| 453 | const wxString& url, |
| 454 | wxString *redirect) const; |
| 455 | virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell, |
| 456 | const wxPoint& pos) const; |
| 457 | virtual wxWindow* GetHTMLWindow(); |
| 458 | virtual wxColour GetHTMLBackgroundColour() const; |
| 459 | virtual void SetHTMLBackgroundColour(const wxColour& clr); |
| 460 | virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg); |
| 461 | virtual void SetHTMLStatusText(const wxString& text); |
| 462 | virtual wxCursor GetHTMLCursor(HTMLCursor type) const; |
| 463 | |
| 464 | // implementation of SetPage() |
| 465 | bool DoSetPage(const wxString& source); |
| 466 | |
| 467 | protected: |
| 468 | // This is pointer to the first cell in parsed data. (Note: the first cell |
| 469 | // is usually top one = all other cells are sub-cells of this one) |
| 470 | wxHtmlContainerCell *m_Cell; |
| 471 | // parser which is used to parse HTML input. |
| 472 | // Each wxHtmlWindow has its own parser because sharing one global |
| 473 | // parser would be problematic (because of reentrancy) |
| 474 | wxHtmlWinParser *m_Parser; |
| 475 | // contains name of actually opened page or empty string if no page opened |
| 476 | wxString m_OpenedPage; |
| 477 | // contains name of current anchor within m_OpenedPage |
| 478 | wxString m_OpenedAnchor; |
| 479 | // contains title of actually opened page or empty string if no <TITLE> tag |
| 480 | wxString m_OpenedPageTitle; |
| 481 | // class for opening files (file system) |
| 482 | wxFileSystem* m_FS; |
| 483 | |
| 484 | // frame in which page title should be displayed & number of its statusbar |
| 485 | // reserved for usage with this html window |
| 486 | wxFrame *m_RelatedFrame; |
| 487 | #if wxUSE_STATUSBAR |
| 488 | int m_RelatedStatusBarIndex; |
| 489 | wxStatusBar* m_RelatedStatusBar; |
| 490 | #endif // wxUSE_STATUSBAR |
| 491 | wxString m_TitleFormat; |
| 492 | |
| 493 | // borders (free space between text and window borders) |
| 494 | // defaults to 10 pixels. |
| 495 | int m_Borders; |
| 496 | |
| 497 | // current text selection or NULL |
| 498 | wxHtmlSelection *m_selection; |
| 499 | |
| 500 | // true if the user is dragging mouse to select text |
| 501 | bool m_makingSelection; |
| 502 | |
| 503 | #if wxUSE_CLIPBOARD |
| 504 | // time of the last doubleclick event, used to detect tripleclicks |
| 505 | // (tripleclicks are used to select whole line): |
| 506 | wxMilliClock_t m_lastDoubleClick; |
| 507 | |
| 508 | // helper class to automatically scroll the window if the user is selecting |
| 509 | // text and the mouse leaves wxHtmlWindow: |
| 510 | wxHtmlWinAutoScrollTimer *m_timerAutoScroll; |
| 511 | #endif // wxUSE_CLIPBOARD |
| 512 | |
| 513 | private: |
| 514 | // erase the window background using m_bmpBg or just solid colour if we |
| 515 | // don't have any background image |
| 516 | void DoEraseBackground(wxDC& dc); |
| 517 | |
| 518 | // window content for double buffered rendering, may be invalid until it is |
| 519 | // really initialized in OnPaint() |
| 520 | wxBitmap m_backBuffer; |
| 521 | |
| 522 | // background image, may be invalid |
| 523 | wxBitmap m_bmpBg; |
| 524 | |
| 525 | // variables used when user is selecting text |
| 526 | wxPoint m_tmpSelFromPos; |
| 527 | wxHtmlCell *m_tmpSelFromCell; |
| 528 | |
| 529 | // if >0 contents of the window is not redrawn |
| 530 | // (in order to avoid ugly blinking) |
| 531 | int m_tmpCanDrawLocks; |
| 532 | |
| 533 | // list of HTML filters |
| 534 | static wxList m_Filters; |
| 535 | // this filter is used when no filter is able to read some file |
| 536 | static wxHtmlFilter *m_DefaultFilter; |
| 537 | |
| 538 | // html processors array: |
| 539 | wxHtmlProcessorList *m_Processors; |
| 540 | static wxHtmlProcessorList *m_GlobalProcessors; |
| 541 | |
| 542 | // browser history |
| 543 | wxHtmlHistoryArray *m_History; |
| 544 | int m_HistoryPos; |
| 545 | // if this FLAG is false, items are not added to history |
| 546 | bool m_HistoryOn; |
| 547 | |
| 548 | // standard mouse cursors |
| 549 | static wxCursor *ms_cursorLink; |
| 550 | static wxCursor *ms_cursorText; |
| 551 | |
| 552 | DECLARE_EVENT_TABLE() |
| 553 | wxDECLARE_NO_COPY_CLASS(wxHtmlWindow); |
| 554 | }; |
| 555 | |
| 556 | class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent; |
| 557 | |
| 558 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent ); |
| 559 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent ); |
| 560 | wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent ); |
| 561 | |
| 562 | |
| 563 | /*! |
| 564 | * Html cell window event |
| 565 | */ |
| 566 | |
| 567 | class WXDLLIMPEXP_HTML wxHtmlCellEvent : public wxCommandEvent |
| 568 | { |
| 569 | public: |
| 570 | wxHtmlCellEvent() {} |
| 571 | wxHtmlCellEvent(wxEventType commandType, int id, |
| 572 | wxHtmlCell *cell, const wxPoint &pt, |
| 573 | const wxMouseEvent &ev) |
| 574 | : wxCommandEvent(commandType, id) |
| 575 | { |
| 576 | m_cell = cell; |
| 577 | m_pt = pt; |
| 578 | m_mouseEvent = ev; |
| 579 | m_bLinkWasClicked = false; |
| 580 | } |
| 581 | |
| 582 | wxHtmlCell* GetCell() const { return m_cell; } |
| 583 | wxPoint GetPoint() const { return m_pt; } |
| 584 | wxMouseEvent GetMouseEvent() const { return m_mouseEvent; } |
| 585 | |
| 586 | void SetLinkClicked(bool linkclicked) { m_bLinkWasClicked=linkclicked; } |
| 587 | bool GetLinkClicked() const { return m_bLinkWasClicked; } |
| 588 | |
| 589 | // default copy ctor, assignment operator and dtor are ok |
| 590 | virtual wxEvent *Clone() const { return new wxHtmlCellEvent(*this); } |
| 591 | |
| 592 | private: |
| 593 | wxHtmlCell *m_cell; |
| 594 | wxMouseEvent m_mouseEvent; |
| 595 | wxPoint m_pt; |
| 596 | |
| 597 | bool m_bLinkWasClicked; |
| 598 | |
| 599 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlCellEvent) |
| 600 | }; |
| 601 | |
| 602 | |
| 603 | |
| 604 | /*! |
| 605 | * Html link event |
| 606 | */ |
| 607 | |
| 608 | class WXDLLIMPEXP_HTML wxHtmlLinkEvent : public wxCommandEvent |
| 609 | { |
| 610 | public: |
| 611 | wxHtmlLinkEvent() {} |
| 612 | wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo) |
| 613 | : wxCommandEvent(wxEVT_COMMAND_HTML_LINK_CLICKED, id) |
| 614 | { |
| 615 | m_linkInfo = linkinfo; |
| 616 | } |
| 617 | |
| 618 | const wxHtmlLinkInfo &GetLinkInfo() const { return m_linkInfo; } |
| 619 | |
| 620 | // default copy ctor, assignment operator and dtor are ok |
| 621 | virtual wxEvent *Clone() const { return new wxHtmlLinkEvent(*this); } |
| 622 | |
| 623 | private: |
| 624 | wxHtmlLinkInfo m_linkInfo; |
| 625 | |
| 626 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlLinkEvent) |
| 627 | }; |
| 628 | |
| 629 | |
| 630 | typedef void (wxEvtHandler::*wxHtmlCellEventFunction)(wxHtmlCellEvent&); |
| 631 | typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&); |
| 632 | |
| 633 | #define wxHtmlCellEventHandler(func) \ |
| 634 | wxEVENT_HANDLER_CAST(wxHtmlCellEventFunction, func) |
| 635 | #define wxHtmlLinkEventHandler(func) \ |
| 636 | wxEVENT_HANDLER_CAST(wxHtmlLinkEventFunction, func) |
| 637 | |
| 638 | #define EVT_HTML_CELL_CLICKED(id, fn) \ |
| 639 | wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn)) |
| 640 | #define EVT_HTML_CELL_HOVER(id, fn) \ |
| 641 | wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_HOVER, id, wxHtmlCellEventHandler(fn)) |
| 642 | #define EVT_HTML_LINK_CLICKED(id, fn) \ |
| 643 | wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_LINK_CLICKED, id, wxHtmlLinkEventHandler(fn)) |
| 644 | |
| 645 | |
| 646 | #endif // wxUSE_HTML |
| 647 | |
| 648 | #endif // _WX_HTMLWIN_H_ |
| 649 | |