]> git.saurik.com Git - wxWidgets.git/blame - include/wx/html/htmlwin.h
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / include / wx / html / htmlwin.h
CommitLineData
5526e819 1/////////////////////////////////////////////////////////////////////////////
80fdcdb9 2// Name: wx/html/htmlwin.h
5526e819
VS
3// Purpose: wxHtmlWindow class for parsing & displaying HTML
4// Author: Vaclav Slavik
69941f05 5// RCS-ID: $Id$
5526e819 6// Copyright: (c) 1999 Vaclav Slavik
65571936 7// Licence: wxWindows licence
5526e819
VS
8/////////////////////////////////////////////////////////////////////////////
9
69941f05
VS
10#ifndef _WX_HTMLWIN_H_
11#define _WX_HTMLWIN_H_
5526e819 12
5526e819
VS
13#include "wx/defs.h"
14#if wxUSE_HTML
15
69941f05
VS
16#include "wx/window.h"
17#include "wx/scrolwin.h"
18#include "wx/config.h"
33f81fc7 19#include "wx/stopwatch.h"
69941f05
VS
20#include "wx/html/winpars.h"
21#include "wx/html/htmlcell.h"
22#include "wx/filesys.h"
23#include "wx/html/htmlfilt.h"
903972f9 24#include "wx/filename.h"
e05a12c9 25#include "wx/bitmap.h"
5526e819 26
bfb9ee96 27class wxHtmlProcessor;
892aeafc
VS
28class wxHtmlWinModule;
29class wxHtmlHistoryArray;
30class wxHtmlProcessorList;
b5dbe15d
VS
31class WXDLLIMPEXP_FWD_HTML wxHtmlWinAutoScrollTimer;
32class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent;
33class WXDLLIMPEXP_FWD_HTML wxHtmlLinkEvent;
37146d33 34class WXDLLIMPEXP_FWD_CORE wxStatusBar;
6cc4e6b8
VS
35
36// wxHtmlWindow flags:
37#define wxHW_SCROLLBAR_NEVER 0x0002
38#define wxHW_SCROLLBAR_AUTO 0x0004
f65a786f
VS
39#define wxHW_NO_SELECTION 0x0008
40
41#define wxHW_DEFAULT_STYLE wxHW_SCROLLBAR_AUTO
42
bc55e31b 43/// Enum for wxHtmlWindow::OnOpeningURL and wxHtmlWindowInterface::OnOpeningURL
6cc4e6b8
VS
44enum wxHtmlOpeningStatus
45{
bc55e31b 46 /// Open the requested URL
6cc4e6b8 47 wxHTML_OPEN,
bc55e31b 48 /// Do not open the URL
6cc4e6b8 49 wxHTML_BLOCK,
bc55e31b 50 /// Redirect to another URL (returned from OnOpeningURL)
6cc4e6b8
VS
51 wxHTML_REDIRECT
52};
53
bc55e31b
VS
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 */
59class WXDLLIMPEXP_HTML wxHtmlWindowInterface
60{
61public:
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;
88a1b648
VS
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;
bc55e31b
VS
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 */
137class WXDLLIMPEXP_HTML wxHtmlWindowMouseHelper
138{
31297dbb 139protected:
bc55e31b
VS
140 /**
141 Ctor.
142
143 @param iface Interface to the owner window.
144 */
145 wxHtmlWindowMouseHelper(wxHtmlWindowInterface *iface);
146
432ea998
VZ
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
bc55e31b
VS
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.
4c51a665 198 Default behaviour is to call wxHtmlWindowInterface::OnLinkClicked()
bc55e31b
VS
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
212protected:
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
220private:
221 wxHtmlWindowInterface *m_interface;
222};
223
f65a786f 224// ----------------------------------------------------------------------------
5526e819 225// wxHtmlWindow
3ef01ce5 226// (This is probably the only class you will directly use.)
5526e819 227// Purpose of this class is to display HTML page (either local
f65a786f
VS
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
3ef01ce5 232// SetPage(text) or LoadPage(filename).
f65a786f 233// ----------------------------------------------------------------------------
5526e819 234
bc55e31b
VS
235class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow,
236 public wxHtmlWindowInterface,
31297dbb 237 public wxHtmlWindowMouseHelper
5526e819
VS
238{
239 DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
66806a0b 240 friend class wxHtmlWinModule;
5526e819 241
97494971 242public:
bc55e31b 243 wxHtmlWindow() : wxHtmlWindowMouseHelper(this) { Init(); }
6953da00 244 wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
bfb9ee96 245 const wxPoint& pos = wxDefaultPosition,
97494971 246 const wxSize& size = wxDefaultSize,
f65a786f 247 long style = wxHW_DEFAULT_STYLE,
4f417130 248 const wxString& name = wxT("htmlWindow"))
bc55e31b 249 : wxHtmlWindowMouseHelper(this)
4f417130
VS
250 {
251 Init();
252 Create(parent, id, pos, size, style, name);
253 }
d3c7fc99 254 virtual ~wxHtmlWindow();
97494971 255
6953da00 256 bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
4f417130
VS
257 const wxPoint& pos = wxDefaultPosition,
258 const wxSize& size = wxDefaultSize,
259 long style = wxHW_SCROLLBAR_AUTO,
260 const wxString& name = wxT("htmlWindow"));
261
97494971
VS
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
3103e8a9 265 // Return value : false if an error occurred, true otherwise
04f109ec 266 virtual bool SetPage(const wxString& source);
574c939e 267
39029898
VS
268 // Append to current page
269 bool AppendToPage(const wxString& source);
97494971
VS
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
38caaa61 280 virtual bool LoadPage(const wxString& location);
97494971 281
903972f9
VS
282 // Loads HTML page from file
283 bool LoadFile(const wxFileName& filename);
284
97494971
VS
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
67a99992 297#if wxUSE_STATUSBAR
97494971
VS
298 // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
299 // will be displayed. Default is -1 = no messages.
37146d33
VS
300 void SetRelatedStatusBar(int index);
301 void SetRelatedStatusBar(wxStatusBar*, int index = 0);
67a99992 302#endif // wxUSE_STATUSBAR
97494971
VS
303
304 // Sets fonts to be used when displaying HTML page.
fbfb8bcc 305 void SetFonts(const wxString& normal_face, const wxString& fixed_face,
4eecf115 306 const int *sizes = NULL);
97494971 307
10e5c7ea
VS
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);
6953da00 313
97494971
VS
314 // Sets space between text and window borders.
315 void SetBorders(int b) {m_Borders = b;}
316
97e490f8
VZ
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
b4246849 321#if wxUSE_CONFIG
97494971
VS
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);
b4246849 328#endif // wxUSE_CONFIG
97494971
VS
329
330 // Goes to previous/next page (in browsing history)
6953da00 331 // Returns true if successful, false otherwise
97494971
VS
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
6cc4e6b8
VS
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
97e490f8 354
6cc4e6b8
VS
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
4c51a665 361 // Called when user clicked on hypertext link. Default behaviour is to
97494971
VS
362 // call LoadPage(loc)
363 virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
574c939e
KB
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
6953da00 367 // OnOpeningURL returns true. If OnOpeningURL returns wxHTML_REDIRECT,
6cc4e6b8 368 // it must set *redirect to the new URL
574c939e
KB
369 virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
370 const wxString& WXUNUSED(url),
371 wxString *WXUNUSED(redirect)) const
6cc4e6b8 372 { return wxHTML_OPEN; }
6953da00 373
15622068
VZ
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();
6953da00 379
5d3f80be
VS
380 // Convert selection to text:
381 wxString SelectionToText() { return DoSelectionToText(m_selection); }
382
383 // Converts current page to text:
384 wxString ToText();
97e490f8 385#endif // wxUSE_CLIPBOARD
6953da00 386
6f02a879
VZ
387 virtual void OnInternalIdle();
388
88a1b648
VS
389 /// Returns standard HTML cursor as used by wxHtmlWindow
390 static wxCursor GetDefaultHTMLCursor(HTMLCursor type);
bc55e31b 391
97494971 392protected:
4f417130
VS
393 void Init();
394
97494971
VS
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)
6953da00 398 // Return value : true if anchor exists, false otherwise
97494971
VS
399 bool ScrollToAnchor(const wxString& anchor);
400
bfb9ee96 401 // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
97494971
VS
402 // actual size of window. This method also setup scrollbars
403 void CreateLayout();
404
1338c59a 405 void OnPaint(wxPaintEvent& event);
49b489e8 406 void OnEraseBackground(wxEraseEvent& event);
97494971 407 void OnSize(wxSizeEvent& event);
31d8b4ad 408 void OnMouseMove(wxMouseEvent& event);
adf2eb2d
VS
409 void OnMouseDown(wxMouseEvent& event);
410 void OnMouseUp(wxMouseEvent& event);
61233023
VS
411#if wxUSE_CLIPBOARD
412 void OnKeyUp(wxKeyEvent& event);
31eefb99 413 void OnDoubleClick(wxMouseEvent& event);
61233023 414 void OnCopy(wxCommandEvent& event);
0f11c233 415 void OnClipboardEvent(wxClipboardTextEvent& event);
1338c59a
VS
416 void OnMouseEnter(wxMouseEvent& event);
417 void OnMouseLeave(wxMouseEvent& event);
63e819f2 418 void OnMouseCaptureLost(wxMouseCaptureLostEvent& event);
d659d703 419#endif // wxUSE_CLIPBOARD
97494971
VS
420
421 // Returns new filter (will be stored into m_DefaultFilter variable)
422 virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
423
892aeafc 424 // cleans static variables
97494971 425 static void CleanUpStatics();
97494971 426
f65a786f
VS
427 // Returns true if text selection is enabled (wxClipboard must be available
428 // and wxHW_NO_SELECTION not used)
429 bool IsSelectionEnabled() const;
430
61233023
VS
431 enum ClipboardType
432 {
433 Primary,
434 Secondary
435 };
d659d703
VZ
436
437 // Copies selection to clipboard if the clipboard support is available
4bdce112
VZ
438 //
439 // returns true if anything was copied to clipboard, false otherwise
5de65c69 440 bool CopySelection(ClipboardType t = Secondary);
0994d968 441
d659d703 442#if wxUSE_CLIPBOARD
0994d968 443 // Automatic scrolling during selection:
1338c59a 444 void StopAutoScrolling();
d659d703 445#endif // wxUSE_CLIPBOARD
61233023 446
977b867e 447 wxString DoSelectionToText(wxHtmlSelection *sel);
6953da00 448
291324e3 449public:
bc55e31b
VS
450 // wxHtmlWindowInterface methods:
451 virtual void SetHTMLWindowTitle(const wxString& title);
452 virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);
453 virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type,
454 const wxString& url,
455 wxString *redirect) const;
456 virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell,
457 const wxPoint& pos) const;
458 virtual wxWindow* GetHTMLWindow();
459 virtual wxColour GetHTMLBackgroundColour() const;
460 virtual void SetHTMLBackgroundColour(const wxColour& clr);
461 virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg);
462 virtual void SetHTMLStatusText(const wxString& text);
88a1b648 463 virtual wxCursor GetHTMLCursor(HTMLCursor type) const;
bc55e31b 464
73de5077
VS
465 // implementation of SetPage()
466 bool DoSetPage(const wxString& source);
467
468protected:
1338c59a
VS
469 // This is pointer to the first cell in parsed data. (Note: the first cell
470 // is usually top one = all other cells are sub-cells of this one)
97494971 471 wxHtmlContainerCell *m_Cell;
892aeafc 472 // parser which is used to parse HTML input.
e3778b4d 473 // Each wxHtmlWindow has its own parser because sharing one global
892aeafc 474 // parser would be problematic (because of reentrancy)
97494971 475 wxHtmlWinParser *m_Parser;
d13b34d3 476 // contains name of actually opened page or empty string if no page opened
97494971 477 wxString m_OpenedPage;
892aeafc 478 // contains name of current anchor within m_OpenedPage
97494971 479 wxString m_OpenedAnchor;
d13b34d3 480 // contains title of actually opened page or empty string if no <TITLE> tag
97494971 481 wxString m_OpenedPageTitle;
892aeafc 482 // class for opening files (file system)
97494971 483 wxFileSystem* m_FS;
97494971 484
e3778b4d 485 // frame in which page title should be displayed & number of its statusbar
892aeafc 486 // reserved for usage with this html window
37146d33
VS
487 wxFrame *m_RelatedFrame;
488#if wxUSE_STATUSBAR
489 int m_RelatedStatusBarIndex;
490 wxStatusBar* m_RelatedStatusBar;
67a99992 491#endif // wxUSE_STATUSBAR
37146d33 492 wxString m_TitleFormat;
97494971 493
892aeafc
VS
494 // borders (free space between text and window borders)
495 // defaults to 10 pixels.
97494971 496 int m_Borders;
97494971 497
adf2eb2d
VS
498 // current text selection or NULL
499 wxHtmlSelection *m_selection;
500
501 // true if the user is dragging mouse to select text
502 bool m_makingSelection;
503
1338c59a 504#if wxUSE_CLIPBOARD
0994d968
VS
505 // time of the last doubleclick event, used to detect tripleclicks
506 // (tripleclicks are used to select whole line):
33f81fc7 507 wxMilliClock_t m_lastDoubleClick;
0994d968
VS
508
509 // helper class to automatically scroll the window if the user is selecting
510 // text and the mouse leaves wxHtmlWindow:
1338c59a 511 wxHtmlWinAutoScrollTimer *m_timerAutoScroll;
d659d703 512#endif // wxUSE_CLIPBOARD
1338c59a 513
97494971 514private:
03a187cc
VZ
515 // erase the window background using m_bmpBg or just solid colour if we
516 // don't have any background image
517 void DoEraseBackground(wxDC& dc);
518
519 // window content for double buffered rendering, may be invalid until it is
520 // really initialized in OnPaint()
521 wxBitmap m_backBuffer;
d659d703 522
97e490f8
VZ
523 // background image, may be invalid
524 wxBitmap m_bmpBg;
525
adf2eb2d
VS
526 // variables used when user is selecting text
527 wxPoint m_tmpSelFromPos;
528 wxHtmlCell *m_tmpSelFromCell;
d659d703 529
892aeafc
VS
530 // if >0 contents of the window is not redrawn
531 // (in order to avoid ugly blinking)
97494971 532 int m_tmpCanDrawLocks;
97494971 533
892aeafc 534 // list of HTML filters
97494971 535 static wxList m_Filters;
892aeafc 536 // this filter is used when no filter is able to read some file
97494971 537 static wxHtmlFilter *m_DefaultFilter;
97494971 538
518ba663
VZ
539 // html processors array:
540 wxHtmlProcessorList *m_Processors;
541 static wxHtmlProcessorList *m_GlobalProcessors;
542
892aeafc 543 // browser history
518ba663 544 wxHtmlHistoryArray *m_History;
97494971 545 int m_HistoryPos;
892aeafc 546 // if this FLAG is false, items are not added to history
97494971 547 bool m_HistoryOn;
bfb9ee96 548
49b489e8
VZ
549 // Flag used to communicate between OnPaint() and OnEraseBackground(), see
550 // the comments near its use.
551 bool m_isBgReallyErased;
552
88a1b648
VS
553 // standard mouse cursors
554 static wxCursor *ms_cursorLink;
555 static wxCursor *ms_cursorText;
556
69941f05 557 DECLARE_EVENT_TABLE()
c0c133e1 558 wxDECLARE_NO_COPY_CLASS(wxHtmlWindow);
69941f05 559};
5526e819 560
3c778901 561class WXDLLIMPEXP_FWD_HTML wxHtmlCellEvent;
5526e819 562
9b11752c
VZ
563wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent );
564wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent );
565wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_HTML, wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent );
a1c3cdc4
VS
566
567
568/*!
569 * Html cell window event
570 */
571
572class WXDLLIMPEXP_HTML wxHtmlCellEvent : public wxCommandEvent
573{
574public:
575 wxHtmlCellEvent() {}
576 wxHtmlCellEvent(wxEventType commandType, int id,
577 wxHtmlCell *cell, const wxPoint &pt,
578 const wxMouseEvent &ev)
579 : wxCommandEvent(commandType, id)
580 {
581 m_cell = cell;
582 m_pt = pt;
583 m_mouseEvent = ev;
584 m_bLinkWasClicked = false;
585 }
586
587 wxHtmlCell* GetCell() const { return m_cell; }
588 wxPoint GetPoint() const { return m_pt; }
589 wxMouseEvent GetMouseEvent() const { return m_mouseEvent; }
590
591 void SetLinkClicked(bool linkclicked) { m_bLinkWasClicked=linkclicked; }
592 bool GetLinkClicked() const { return m_bLinkWasClicked; }
593
594 // default copy ctor, assignment operator and dtor are ok
595 virtual wxEvent *Clone() const { return new wxHtmlCellEvent(*this); }
596
597private:
598 wxHtmlCell *m_cell;
599 wxMouseEvent m_mouseEvent;
600 wxPoint m_pt;
601
602 bool m_bLinkWasClicked;
603
604 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlCellEvent)
605};
606
607
608
609/*!
610 * Html link event
611 */
612
613class WXDLLIMPEXP_HTML wxHtmlLinkEvent : public wxCommandEvent
614{
615public:
616 wxHtmlLinkEvent() {}
617 wxHtmlLinkEvent(int id, const wxHtmlLinkInfo &linkinfo)
618 : wxCommandEvent(wxEVT_COMMAND_HTML_LINK_CLICKED, id)
619 {
620 m_linkInfo = linkinfo;
621 }
622
623 const wxHtmlLinkInfo &GetLinkInfo() const { return m_linkInfo; }
624
625 // default copy ctor, assignment operator and dtor are ok
626 virtual wxEvent *Clone() const { return new wxHtmlLinkEvent(*this); }
627
628private:
629 wxHtmlLinkInfo m_linkInfo;
630
631 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHtmlLinkEvent)
632};
633
634
635typedef void (wxEvtHandler::*wxHtmlCellEventFunction)(wxHtmlCellEvent&);
636typedef void (wxEvtHandler::*wxHtmlLinkEventFunction)(wxHtmlLinkEvent&);
637
638#define wxHtmlCellEventHandler(func) \
3c778901 639 wxEVENT_HANDLER_CAST(wxHtmlCellEventFunction, func)
a1c3cdc4 640#define wxHtmlLinkEventHandler(func) \
3c778901 641 wxEVENT_HANDLER_CAST(wxHtmlLinkEventFunction, func)
a1c3cdc4
VS
642
643#define EVT_HTML_CELL_CLICKED(id, fn) \
644 wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_CLICKED, id, wxHtmlCellEventHandler(fn))
645#define EVT_HTML_CELL_HOVER(id, fn) \
646 wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_CELL_HOVER, id, wxHtmlCellEventHandler(fn))
647#define EVT_HTML_LINK_CLICKED(id, fn) \
648 wx__DECLARE_EVT1(wxEVT_COMMAND_HTML_LINK_CLICKED, id, wxHtmlLinkEventHandler(fn))
649
650
d659d703 651#endif // wxUSE_HTML
69941f05
VS
652
653#endif // _WX_HTMLWIN_H_
19193a2c 654