]>
Commit | Line | Data |
---|---|---|
5526e819 VS |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: htmlwin.h | |
3 | // Purpose: wxHtmlWindow class for parsing & displaying HTML | |
4 | // Author: Vaclav Slavik | |
69941f05 | 5 | // RCS-ID: $Id$ |
5526e819 VS |
6 | // Copyright: (c) 1999 Vaclav Slavik |
7 | // Licence: wxWindows Licence | |
8 | ///////////////////////////////////////////////////////////////////////////// | |
9 | ||
10 | ||
69941f05 VS |
11 | #ifndef _WX_HTMLWIN_H_ |
12 | #define _WX_HTMLWIN_H_ | |
5526e819 VS |
13 | |
14 | #ifdef __GNUG__ | |
15 | #pragma interface | |
16 | #endif | |
17 | ||
18 | #include "wx/defs.h" | |
19 | #if wxUSE_HTML | |
20 | ||
69941f05 VS |
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" | |
5526e819 VS |
29 | |
30 | ||
31 | //-------------------------------------------------------------------------------- | |
32 | // wxHtmlWindow | |
3ef01ce5 | 33 | // (This is probably the only class you will directly use.) |
5526e819 VS |
34 | // Purpose of this class is to display HTML page (either local |
35 | // file or downloaded via HTTP protocol) in a window. Width | |
36 | // of window is constant - given in constructor - virtual height | |
37 | // is changed dynamicly depending on page size. | |
38 | // Once the window is created you can set it's content by calling | |
3ef01ce5 | 39 | // SetPage(text) or LoadPage(filename). |
5526e819 VS |
40 | //-------------------------------------------------------------------------------- |
41 | ||
42 | ||
43 | // item of history list | |
44 | class WXDLLEXPORT HtmlHistoryItem : public wxObject | |
45 | { | |
5526e819 VS |
46 | public: |
47 | HtmlHistoryItem(const wxString& p, const wxString& a) {m_Page = p, m_Anchor = a, m_Pos = 0;} | |
48 | int GetPos() const {return m_Pos;} | |
49 | void SetPos(int p) {m_Pos = p;} | |
50 | const wxString& GetPage() const {return m_Page;} | |
51 | const wxString& GetAnchor() const {return m_Anchor;} | |
69941f05 VS |
52 | |
53 | private: | |
54 | wxString m_Page; | |
55 | wxString m_Anchor; | |
56 | int m_Pos; | |
5526e819 VS |
57 | }; |
58 | ||
5526e819 | 59 | |
89966d5c | 60 | WX_DECLARE_EXPORTED_OBJARRAY(HtmlHistoryItem, HtmlHistoryArray); |
5526e819 VS |
61 | |
62 | ||
8eb2940f | 63 | |
5526e819 VS |
64 | class WXDLLEXPORT wxHtmlWindow : public wxScrolledWindow |
65 | { | |
66 | DECLARE_DYNAMIC_CLASS(wxHtmlWindow) | |
67 | ||
5526e819 VS |
68 | public: |
69 | wxHtmlWindow() : wxScrolledWindow() {}; | |
3ef01ce5 | 70 | wxHtmlWindow(wxWindow *parent, wxWindowID id = -1, |
5526e819 | 71 | const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, |
d5db80c2 | 72 | long style = wxHW_SCROLLBAR_AUTO, |
ea8fe90e | 73 | const wxString& name = "htmlWindow"); |
5526e819 VS |
74 | ~wxHtmlWindow(); |
75 | ||
76 | bool SetPage(const wxString& source); | |
77 | // Set HTML page and display it. !! source is HTML document itself, | |
3ef01ce5 | 78 | // it is NOT address/filename of HTML document. If you want to |
5526e819 VS |
79 | // specify document location, use LoadPage() istead |
80 | // Return value : FALSE if an error occured, TRUE otherwise | |
3ef01ce5 | 81 | |
5526e819 VS |
82 | bool LoadPage(const wxString& location); |
83 | // Load HTML page from given location. Location can be either | |
84 | // a) /usr/wxGTK2/docs/html/wx.htm | |
85 | // b) http://www.somewhere.uk/document.htm | |
86 | // c) ftp://ftp.somesite.cz/pub/something.htm | |
87 | // In case there is no prefix (http:,ftp:), the method | |
88 | // will try to find it itself (1. local file, then http or ftp) | |
89 | // After the page is loaded, the method calls SetPage() to display it. | |
90 | // Note : you can also use path relative to previously loaded page | |
91 | // Return value : same as SetPage | |
92 | ||
93 | wxString GetOpenedPage() const {return m_OpenedPage;} | |
94 | // Returns full location of opened page | |
5656c6ef VS |
95 | wxString GetOpenedAnchor() const {return m_OpenedAnchor;} |
96 | // Returns anchor within opened page | |
d5db80c2 VS |
97 | wxString GetOpenedPageTitle() const {return m_OpenedPageTitle;} |
98 | // Returns <TITLE> of opened page or empty string otherwise | |
99 | ||
5526e819 VS |
100 | void SetRelatedFrame(wxFrame* frame, const wxString& format); |
101 | // sets frame in which page title will be displayed. Format is format of | |
3ef01ce5 | 102 | // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s |
5526e819 VS |
103 | wxFrame* GetRelatedFrame() const {return m_RelatedFrame;} |
104 | ||
105 | void SetRelatedStatusBar(int bar); | |
106 | // after(!) calling SetRelatedFrame, this sets statusbar slot where messages | |
107 | // will be displayed. Default is -1 = no messages. | |
108 | ||
8eb2940f | 109 | void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes); |
5526e819 | 110 | // sets fonts to be used when displaying HTML page. |
5526e819 | 111 | |
d5db80c2 | 112 | virtual void OnSetTitle(const wxString& title); |
5526e819 VS |
113 | // Sets the title of the window |
114 | // (depending on the information passed to SetRelatedFrame() method) | |
115 | ||
116 | void SetBorders(int b) {m_Borders = b;} | |
117 | // Sets space between text and window borders. | |
118 | ||
119 | virtual void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString); | |
120 | // saves custom settings into cfg config. it will use the path 'path' | |
121 | // if given, otherwise it will save info into currently selected path. | |
122 | // saved values : things set by SetFonts, SetBorders. | |
123 | virtual void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString); | |
124 | // ... | |
125 | ||
126 | bool HistoryBack(); | |
127 | bool HistoryForward(); | |
128 | // Goes to previous/next page (in browsing history) | |
129 | // Returns TRUE if successful, FALSE otherwise | |
130 | void HistoryClear(); | |
131 | // Resets history | |
132 | ||
133 | wxHtmlContainerCell* GetInternalRepresentation() const {return m_Cell;} | |
134 | // Returns pointer to conteiners/cells structure. | |
135 | // It should be used ONLY when printing | |
136 | ||
137 | static void AddFilter(wxHtmlFilter *filter); | |
138 | // Adds input filter | |
139 | ||
1be096c9 | 140 | virtual void OnLinkClicked(const wxHtmlLinkInfo& link); |
5526e819 VS |
141 | // called when users clicked on hypertext link. Default behavior is to |
142 | // call LoadPage(loc) | |
3ef01ce5 | 143 | |
1be096c9 | 144 | static void CleanUpStatics(); |
a76015e6 | 145 | // cleans static variables |
5526e819 | 146 | |
3ef01ce5 RD |
147 | wxHtmlWinParser *GetParser() const { return m_Parser; } |
148 | // return a pointer to the parser. | |
149 | ||
5526e819 VS |
150 | protected: |
151 | bool ScrollToAnchor(const wxString& anchor); | |
152 | // Scrolls to anchor of this name. (Anchor is #news | |
153 | // or #features etc. it is part of address sometimes: | |
154 | // http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/index.html#news) | |
155 | // Return value : TRUE if anchor exists, FALSE otherwise | |
156 | ||
157 | void CreateLayout(); | |
158 | // prepare layout (= fill m_PosX, m_PosY for fragments) based on actual size of | |
159 | // window. This method also setup scrollbars | |
160 | ||
161 | void OnDraw(wxDC& dc); | |
162 | void OnSize(wxSizeEvent& event); | |
163 | void OnMouseEvent(wxMouseEvent& event); | |
164 | void OnIdle(wxIdleEvent& event); | |
3ef01ce5 | 165 | |
1be096c9 | 166 | virtual wxHtmlFilter *GetDefaultFilter() {return new wxHtmlFilterPlainText;} |
a76015e6 | 167 | // returns new filter (will be stored into m_DefaultFilter variable) |
5526e819 | 168 | |
622ea783 | 169 | |
69941f05 VS |
170 | protected: |
171 | wxHtmlContainerCell *m_Cell; | |
172 | // This is pointer to the first cell in parsed data. | |
173 | // (Note: the first cell is usually top one = all other cells are sub-cells of this one) | |
174 | wxHtmlWinParser *m_Parser; | |
175 | // parser which is used to parse HTML input. | |
176 | // Each wxHtmlWindow has it's own parser because sharing one global | |
177 | // parser would be problematic (because of reentrancy) | |
178 | wxString m_OpenedPage; | |
179 | // contains name of actualy opened page or empty string if no page opened | |
180 | wxString m_OpenedAnchor; | |
181 | // contains name of current anchor within m_OpenedPage | |
d5db80c2 VS |
182 | wxString m_OpenedPageTitle; |
183 | // contains title of actualy opened page or empty string if no <TITLE> tag | |
69941f05 VS |
184 | wxFileSystem* m_FS; |
185 | // class for opening files (file system) | |
5526e819 | 186 | |
69941f05 VS |
187 | wxFrame *m_RelatedFrame; |
188 | wxString m_TitleFormat; | |
189 | int m_RelatedStatusBar; | |
190 | // frame in which page title should be displayed & number of it's statusbar | |
191 | // reserved for usage with this html window | |
5526e819 | 192 | |
69941f05 VS |
193 | int m_Borders; |
194 | // borders (free space between text and window borders) | |
195 | // defaults to 10 pixels. | |
5526e819 | 196 | |
69941f05 | 197 | int m_Style; |
5526e819 | 198 | |
622ea783 VS |
199 | private: |
200 | bool m_tmpMouseMoved; | |
201 | // a flag indicated if mouse moved | |
202 | // (if TRUE we will try to change cursor in last call to OnIdle) | |
846914d1 | 203 | wxHtmlLinkInfo *m_tmpLastLink; |
622ea783 | 204 | // contains last link name |
89de9af3 VS |
205 | int m_tmpCanDrawLocks; |
206 | // if >0 contents of the window is not redrawn | |
622ea783 VS |
207 | // (in order to avoid ugly bliking) |
208 | ||
209 | static wxList m_Filters; | |
210 | // list of HTML filters | |
211 | static wxHtmlFilter *m_DefaultFilter; | |
212 | // this filter is used when no filter is able to read some file | |
213 | ||
214 | HtmlHistoryArray m_History; | |
215 | int m_HistoryPos; | |
216 | // browser history | |
217 | bool m_HistoryOn; | |
218 | // if this FLAG is false, items are not added to history | |
219 | ||
5526e819 | 220 | |
69941f05 VS |
221 | DECLARE_EVENT_TABLE() |
222 | }; | |
5526e819 VS |
223 | |
224 | ||
69941f05 VS |
225 | #endif |
226 | ||
227 | #endif // _WX_HTMLWIN_H_ |