]> git.saurik.com Git - wxWidgets.git/blob - include/wx/html/htmlwin.h
moved MGL initialization to earlier stage (crashes otherwise...) and implemented...
[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 #ifdef __GNUG__
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/treectrl.h"
25 #include "wx/html/winpars.h"
26 #include "wx/html/htmlcell.h"
27 #include "wx/filesys.h"
28 #include "wx/html/htmlfilt.h"
29
30 class wxHtmlProcessor;
31 class wxHtmlWinModule;
32 class wxHtmlHistoryArray;
33 class wxHtmlProcessorList;
34
35 //--------------------------------------------------------------------------------
36 // wxHtmlWindow
37 // (This is probably the only class you will directly use.)
38 // Purpose of this class is to display HTML page (either local
39 // file or downloaded via HTTP protocol) in a window. Width
40 // of window is constant - given in constructor - virtual height
41 // is changed dynamicly depending on page size.
42 // Once the window is created you can set it's content by calling
43 // SetPage(text) or LoadPage(filename).
44 //--------------------------------------------------------------------------------
45
46 class WXDLLEXPORT wxHtmlWindow : public wxScrolledWindow
47 {
48 DECLARE_DYNAMIC_CLASS(wxHtmlWindow)
49 friend class wxHtmlWinModule;
50
51 public:
52 wxHtmlWindow() : wxScrolledWindow() {};
53 wxHtmlWindow(wxWindow *parent, wxWindowID id = -1,
54 const wxPoint& pos = wxDefaultPosition,
55 const wxSize& size = wxDefaultSize,
56 long style = wxHW_SCROLLBAR_AUTO,
57 const wxString& name = "htmlWindow");
58 ~wxHtmlWindow();
59
60 // Set HTML page and display it. !! source is HTML document itself,
61 // it is NOT address/filename of HTML document. If you want to
62 // specify document location, use LoadPage() istead
63 // Return value : FALSE if an error occured, TRUE otherwise
64 bool SetPage(const wxString& source);
65
66 // Load HTML page from given location. Location can be either
67 // a) /usr/wxGTK2/docs/html/wx.htm
68 // b) http://www.somewhere.uk/document.htm
69 // c) ftp://ftp.somesite.cz/pub/something.htm
70 // In case there is no prefix (http:,ftp:), the method
71 // will try to find it itself (1. local file, then http or ftp)
72 // After the page is loaded, the method calls SetPage() to display it.
73 // Note : you can also use path relative to previously loaded page
74 // Return value : same as SetPage
75 virtual bool LoadPage(const wxString& location);
76
77 // Returns full location of opened page
78 wxString GetOpenedPage() const {return m_OpenedPage;}
79 // Returns anchor within opened page
80 wxString GetOpenedAnchor() const {return m_OpenedAnchor;}
81 // Returns <TITLE> of opened page or empty string otherwise
82 wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;}
83
84 // Sets frame in which page title will be displayed. Format is format of
85 // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
86 void SetRelatedFrame(wxFrame* frame, const wxString& format);
87 wxFrame* GetRelatedFrame() const {return m_RelatedFrame;}
88
89 // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
90 // will be displayed. Default is -1 = no messages.
91 void SetRelatedStatusBar(int bar);
92
93 // Sets fonts to be used when displaying HTML page.
94 void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
95
96 // Sets the title of the window
97 // (depending on the information passed to SetRelatedFrame() method)
98 virtual void OnSetTitle(const wxString& title);
99
100 // Sets space between text and window borders.
101 void SetBorders(int b) {m_Borders = b;}
102
103 // Saves custom settings into cfg config. it will use the path 'path'
104 // if given, otherwise it will save info into currently selected path.
105 // saved values : things set by SetFonts, SetBorders.
106 virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
107 // ...
108 virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
109
110 // Goes to previous/next page (in browsing history)
111 // Returns TRUE if successful, FALSE otherwise
112 bool HistoryBack();
113 bool HistoryForward();
114 bool HistoryCanBack();
115 bool HistoryCanForward();
116 // Resets history
117 void HistoryClear();
118
119 // Returns pointer to conteiners/cells structure.
120 // It should be used ONLY when printing
121 wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;}
122
123 // Adds input filter
124 static void AddFilter(wxHtmlFilter *filter);
125
126 // Called when the mouse hovers over a cell: (x, y) are logical coords
127 //
128 // Default behaviour is to do nothing at all
129 virtual void OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
130
131 // Called when user clicks on a cell. Default behavior is to call
132 // OnLinkClicked() if this cell corresponds to a hypertext link
133 virtual void OnCellClicked(wxHtmlCell *cell,
134 wxCoord x, wxCoord y,
135 const wxMouseEvent& event);
136
137 // Called when user clicked on hypertext link. Default behavior is to
138 // call LoadPage(loc)
139 virtual void OnLinkClicked(const wxHtmlLinkInfo& link);
140
141 // Returns a pointer to the parser.
142 wxHtmlWinParser *GetParser() const { return m_Parser; }
143
144 // Adds HTML processor to this instance of wxHtmlWindow:
145 void AddProcessor(wxHtmlProcessor *processor);
146 // Adds HTML processor to wxHtmlWindow class as whole:
147 static void AddGlobalProcessor(wxHtmlProcessor *processor);
148
149 // what would we do with it?
150 virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
151
152 protected:
153 // Scrolls to anchor of this name. (Anchor is #news
154 // or #features etc. it is part of address sometimes:
155 // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news)
156 // Return value : TRUE if anchor exists, FALSE otherwise
157 bool ScrollToAnchor(const wxString& anchor);
158
159 // Prepares layout (= fill m_PosX, m_PosY for fragments) based on
160 // actual size of window. This method also setup scrollbars
161 void CreateLayout();
162
163 void OnDraw(wxDC& dc);
164 void OnSize(wxSizeEvent& event);
165 void OnMouseEvent(wxMouseEvent& event);
166 void OnIdle(wxIdleEvent& event);
167
168 // Returns new filter (will be stored into m_DefaultFilter variable)
169 virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;}
170
171 // cleans static variables
172 static void CleanUpStatics();
173
174 protected:
175 // This is pointer to the first cell in parsed data.
176 // (Note: the first cell is usually top one = all other cells are sub-cells of this one)
177 wxHtmlContainerCell *m_Cell;
178 // parser which is used to parse HTML input.
179 // Each wxHtmlWindow has it's own parser because sharing one global
180 // parser would be problematic (because of reentrancy)
181 wxHtmlWinParser *m_Parser;
182 // contains name of actualy opened page or empty string if no page opened
183 wxString m_OpenedPage;
184 // contains name of current anchor within m_OpenedPage
185 wxString m_OpenedAnchor;
186 // contains title of actualy opened page or empty string if no <TITLE> tag
187 wxString m_OpenedPageTitle;
188 // class for opening files (file system)
189 wxFileSystem* m_FS;
190
191 wxFrame *m_RelatedFrame;
192 wxString m_TitleFormat;
193 // frame in which page title should be displayed & number of it's statusbar
194 // reserved for usage with this html window
195 int m_RelatedStatusBar;
196
197 // borders (free space between text and window borders)
198 // defaults to 10 pixels.
199 int m_Borders;
200
201 int m_Style;
202
203 private:
204 // a flag indicated if mouse moved
205 // (if TRUE we will try to change cursor in last call to OnIdle)
206 bool m_tmpMouseMoved;
207 // contains last link name
208 wxHtmlLinkInfo *m_tmpLastLink;
209 // contains the last (terminal) cell which contained the mouse
210 wxHtmlCell *m_tmpLastCell;
211 // if >0 contents of the window is not redrawn
212 // (in order to avoid ugly blinking)
213 int m_tmpCanDrawLocks;
214
215 // list of HTML filters
216 static wxList m_Filters;
217 // this filter is used when no filter is able to read some file
218 static wxHtmlFilter *m_DefaultFilter;
219
220 static wxCursor *s_cur_hand;
221 static wxCursor *s_cur_arrow;
222
223 wxHtmlHistoryArray *m_History;
224 // browser history
225 int m_HistoryPos;
226 // if this FLAG is false, items are not added to history
227 bool m_HistoryOn;
228
229 // html processors array:
230 wxHtmlProcessorList *m_Processors;
231 static wxHtmlProcessorList *m_GlobalProcessors;
232
233 DECLARE_EVENT_TABLE()
234 };
235
236
237 #endif
238
239 #endif // _WX_HTMLWIN_H_