]> git.saurik.com Git - wxWidgets.git/blob - include/wx/html/htmlwin.h
include stdlib.h to get malloc/free decl
[wxWidgets.git] / 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
11 #ifndef _WX_HTMLWIN_H_
12 #define _WX_HTMLWIN_H_
13
14 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
15 #pragma interface "htmlwin.h"
16 #endif
17
18 #include "wx/defs.h"
19 #if wxUSE_HTML
20
21 #include "wx/window.h"
22 #include "wx/scrolwin.h"
23 #include "wx/config.h"
24 #include "wx/html/winpars.h"
25 #include "wx/html/htmlcell.h"
26 #include "wx/filesys.h"
27 #include "wx/html/htmlfilt.h"
28 #include "wx/filename.h"
29
30 class wxHtmlProcessor;
31 class wxHtmlWinModule;
32 class wxHtmlHistoryArray;
33 class wxHtmlProcessorList;
34 class WXDLLIMPEXP_HTML wxHtmlWinAutoScrollTimer;
35
36
37 // wxHtmlWindow flags:
38 #define wxHW_SCROLLBAR_NEVER 0x0002
39 #define wxHW_SCROLLBAR_AUTO 0x0004
40 #define wxHW_NO_SELECTION 0x0008
41
42 #define wxHW_DEFAULT_STYLE wxHW_SCROLLBAR_AUTO
43
44
45 // enums for wxHtmlWindow::OnOpeningURL
46 enum wxHtmlOpeningStatus
47 {
48 wxHTML_OPEN,
49 wxHTML_BLOCK,
50 wxHTML_REDIRECT
51 };
52
53 // ----------------------------------------------------------------------------
54 // wxHtmlWindow
55 // (This is probably the only class you will directly use.)
56 // Purpose of this class is to display HTML page (either local
57 // file or downloaded via HTTP protocol) in a window. Width of
58 // window is constant - given in constructor - virtual height
59 // is changed dynamicly depending on page size. Once the
60 // window is created you can set it's content by calling
61 // SetPage(text) or LoadPage(filename).
62 // ----------------------------------------------------------------------------
63
64 class WXDLLIMPEXP_HTML wxHtmlWindow : public wxScrolledWindow
65 {
66 DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
67 friend class wxHtmlWinModule;
68
69 public:
70 wxHtmlWindow() { Init(); }
71 wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
72 const wxPoint& pos = wxDefaultPosition,
73 const wxSize& size = wxDefaultSize,
74 long style = wxHW_DEFAULT_STYLE,
75 const wxString& name = wxT("htmlWindow"))
76 {
77 Init();
78 Create(parent, id, pos, size, style, name);
79 }
80 ~wxHtmlWindow();
81
82 bool Create(wxWindow *parent, wxWindowID id = -1,
83 const wxPoint& pos = wxDefaultPosition,
84 const wxSize& size = wxDefaultSize,
85 long style = wxHW_SCROLLBAR_AUTO,
86 const wxString& name = wxT("htmlWindow"));
87
88 // Set HTML page and display it. !! source is HTML document itself,
89 // it is NOT address/filename of HTML document. If you want to
90 // specify document location, use LoadPage() istead
91 // Return value : FALSE if an error occured, TRUE otherwise
92 bool SetPage(const wxString& source);
93
94 // Append to current page
95 bool AppendToPage(const wxString& source);
96
97 // Load HTML page from given location. Location can be either
98 // a) /usr/wxGTK2/docs/html/wx.htm
99 // b) http://www.somewhere.uk/document.htm
100 // c) ftp://ftp.somesite.cz/pub/something.htm
101 // In case there is no prefix (http:,ftp:), the method
102 // will try to find it itself (1. local file, then http or ftp)
103 // After the page is loaded, the method calls SetPage() to display it.
104 // Note : you can also use path relative to previously loaded page
105 // Return value : same as SetPage
106 virtual bool LoadPage(const wxString& location);
107
108 // Loads HTML page from file
109 bool LoadFile(const wxFileName& filename);
110
111 // Returns full location of opened page
112 wxString GetOpenedPage() const {return m_OpenedPage;}
113 // Returns anchor within opened page
114 wxString GetOpenedAnchor() const {return m_OpenedAnchor;}
115 // Returns <TITLE> of opened page or empty string otherwise
116 wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;}
117
118 // Sets frame in which page title will be displayed. Format is format of
119 // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
120 void SetRelatedFrame(wxFrame* frame, const wxString& format);
121 wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
122
123 // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
124 // will be displayed. Default is -1 = no messages.
125 void SetRelatedStatusBar(int bar);
126
127 // Sets fonts to be used when displaying HTML page.
128 void SetFonts(wxString normal_face, wxString fixed_face,
129 const int *sizes = NULL);
130
131 // Sets space between text and window borders.
132 void SetBorders(int b) {m_Borders = b;}
133
134 // Saves custom settings into cfg config. it will use the path 'path'
135 // if given, otherwise it will save info into currently selected path.
136 // saved values : things set by SetFonts, SetBorders.
137 virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
138 // ...
139 virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
140
141 // Goes to previous/next page (in browsing history)
142 // Returns TRUE if successful, FALSE otherwise
143 bool HistoryBack();
144 bool HistoryForward();
145 bool HistoryCanBack();
146 bool HistoryCanForward();
147 // Resets history
148 void HistoryClear();
149
150 // Returns pointer to conteiners/cells structure.
151 // It should be used ONLY when printing
152 wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;}
153
154 // Adds input filter
155 static void AddFilter(wxHtmlFilter *filter);
156
157 // Returns a pointer to the parser.
158 wxHtmlWinParser *GetParser() const { return m_Parser; }
159
160 // Adds HTML processor to this instance of wxHtmlWindow:
161 void AddProcessor(wxHtmlProcessor *processor);
162 // Adds HTML processor to wxHtmlWindow class as whole:
163 static void AddGlobalProcessor(wxHtmlProcessor *processor);
164
165 // -- Callbacks --
166
167 // Sets the title of the window
168 // (depending on the information passed to SetRelatedFrame() method)
169 virtual void OnSetTitle(const wxString& title);
170
171 // Called when the mouse hovers over a cell: (x, y) are logical coords
172 // Default behaviour is to do nothing at all
173 virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
174
175 // Called when user clicks on a cell. Default behavior is to call
176 // OnLinkClicked() if this cell corresponds to a hypertext link
177 virtual void OnCellClicked(wxHtmlCell *cell,
178 wxCoord x, wxCoord y,
179 const wxMouseEvent& event);
180
181 // Called when user clicked on hypertext link. Default behavior is to
182 // call LoadPage(loc)
183 virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
184
185 // Called when wxHtmlWindow wants to fetch data from an URL (e.g. when
186 // loading a page or loading an image). The data are downloaded if and only if
187 // OnOpeningURL returns TRUE. If OnOpeningURL returns wxHTML_REDIRECT,
188 // it must set *redirect to the new URL
189 virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType WXUNUSED(type),
190 const wxString& WXUNUSED(url),
191 wxString *WXUNUSED(redirect)) const
192 { return wxHTML_OPEN; }
193
194 #if wxUSE_CLIPBOARD
195 // Helper functions to select parts of page:
196 void SelectWord(const wxPoint& pos);
197 void SelectLine(const wxPoint& pos);
198 void SelectAll();
199 #endif
200
201 protected:
202 void Init();
203
204 // Scrolls to anchor of this name. (Anchor is #news
205 // or #features etc. it is part of address sometimes:
206 // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
207 // Return value : TRUE if anchor exists, FALSE otherwise
208 bool ScrollToAnchor(const wxString& anchor);
209
210 // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
211 // actual size of window. This method also setup scrollbars
212 void CreateLayout();
213
214 void OnEraseBackground(wxEraseEvent& event);
215 void OnPaint(wxPaintEvent& event);
216 void OnSize(wxSizeEvent& event);
217 void OnMouseMove(wxMouseEvent& event);
218 void OnMouseDown(wxMouseEvent& event);
219 void OnMouseUp(wxMouseEvent& event);
220 #if wxUSE_CLIPBOARD
221 void OnKeyUp(wxKeyEvent& event);
222 void OnDoubleClick(wxMouseEvent& event);
223 void OnCopy(wxCommandEvent& event);
224 void OnMouseEnter(wxMouseEvent& event);
225 void OnMouseLeave(wxMouseEvent& event);
226 #endif // wxUSE_CLIPBOARD
227
228 virtual void OnInternalIdle();
229
230 // Returns new filter (will be stored into m_DefaultFilter variable)
231 virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
232
233 // cleans static variables
234 static void CleanUpStatics();
235
236 // Returns true if text selection is enabled (wxClipboard must be available
237 // and wxHW_NO_SELECTION not used)
238 bool IsSelectionEnabled() const;
239
240 enum ClipboardType
241 {
242 Primary,
243 Secondary
244 };
245
246 // Copies selection to clipboard if the clipboard support is available
247 //
248 // returns true if anything was copied to clipboard, false otherwise
249 bool CopySelection(ClipboardType t = Secondary);
250
251 #if wxUSE_CLIPBOARD
252 // Convert selection to text:
253 wxString SelectionToText();
254
255 // Automatic scrolling during selection:
256 void StopAutoScrolling();
257 #endif // wxUSE_CLIPBOARD
258
259 protected:
260 // This is pointer to the first cell in parsed data. (Note: the first cell
261 // is usually top one = all other cells are sub-cells of this one)
262 wxHtmlContainerCell *m_Cell;
263 // parser which is used to parse HTML input.
264 // Each wxHtmlWindow has it's own parser because sharing one global
265 // parser would be problematic (because of reentrancy)
266 wxHtmlWinParser *m_Parser;
267 // contains name of actualy opened page or empty string if no page opened
268 wxString m_OpenedPage;
269 // contains name of current anchor within m_OpenedPage
270 wxString m_OpenedAnchor;
271 // contains title of actualy opened page or empty string if no <TITLE> tag
272 wxString m_OpenedPageTitle;
273 // class for opening files (file system)
274 wxFileSystem* m_FS;
275
276 wxFrame *m_RelatedFrame;
277 wxString m_TitleFormat;
278 // frame in which page title should be displayed & number of it's statusbar
279 // reserved for usage with this html window
280 int m_RelatedStatusBar;
281
282 // borders (free space between text and window borders)
283 // defaults to 10 pixels.
284 int m_Borders;
285
286 int m_Style;
287
288 // current text selection or NULL
289 wxHtmlSelection *m_selection;
290
291 // true if the user is dragging mouse to select text
292 bool m_makingSelection;
293
294 #if wxUSE_CLIPBOARD
295 // time of the last doubleclick event, used to detect tripleclicks
296 // (tripleclicks are used to select whole line):
297 wxLongLong m_lastDoubleClick;
298
299 // helper class to automatically scroll the window if the user is selecting
300 // text and the mouse leaves wxHtmlWindow:
301 wxHtmlWinAutoScrollTimer *m_timerAutoScroll;
302 #endif // wxUSE_CLIPBOARD
303
304 private:
305 // window content for double buffered rendering:
306 wxBitmap *m_backBuffer;
307
308 // variables used when user is selecting text
309 wxPoint m_tmpSelFromPos;
310 wxHtmlCell *m_tmpSelFromCell;
311
312 // a flag indicated if mouse moved
313 // (if TRUE we will try to change cursor in last call to OnIdle)
314 bool m_tmpMouseMoved;
315 // contains last link name
316 wxHtmlLinkInfo *m_tmpLastLink;
317 // contains the last (terminal) cell which contained the mouse
318 wxHtmlCell *m_tmpLastCell;
319 // if >0 contents of the window is not redrawn
320 // (in order to avoid ugly blinking)
321 int m_tmpCanDrawLocks;
322
323 // list of HTML filters
324 static wxList m_Filters;
325 // this filter is used when no filter is able to read some file
326 static wxHtmlFilter *m_DefaultFilter;
327
328 wxHtmlHistoryArray *m_History;
329 // browser history
330 int m_HistoryPos;
331 // if this FLAG is false, items are not added to history
332 bool m_HistoryOn;
333
334 // html processors array:
335 wxHtmlProcessorList *m_Processors;
336 static wxHtmlProcessorList *m_GlobalProcessors;
337
338 DECLARE_EVENT_TABLE()
339 DECLARE_NO_COPY_CLASS(wxHtmlWindow)
340 };
341
342
343 #endif // wxUSE_HTML
344
345 #endif // _WX_HTMLWIN_H_
346