]> git.saurik.com Git - wxWidgets.git/blame - src/html/htmlwin.cpp
Added chapter on collection and container classes to contents
[wxWidgets.git] / src / html / htmlwin.cpp
CommitLineData
5526e819
VS
1/////////////////////////////////////////////////////////////////////////////
2// Name: htmlwin.cpp
3// Purpose: wxHtmlWindow class for parsing & displaying HTML (implementation)
4// Author: Vaclav Slavik
69941f05 5// RCS-ID: $Id$
5526e819
VS
6// Copyright: (c) 1999 Vaclav Slavik
7// Licence: wxWindows Licence
8/////////////////////////////////////////////////////////////////////////////
9
10
11#ifdef __GNUG__
12#pragma implementation
13#endif
14
3096bd2f 15#include "wx/wxprec.h"
5526e819
VS
16
17#include "wx/defs.h"
f6bcfd97 18#if wxUSE_HTML && wxUSE_STREAMS
5526e819
VS
19
20#ifdef __BORDLANDC__
21#pragma hdrstop
22#endif
23
24#ifndef WXPRECOMP
3096bd2f 25#include "wx/wx.h"
5526e819
VS
26#endif
27
69941f05 28#include "wx/html/htmlwin.h"
69941f05 29#include "wx/html/forcelnk.h"
f3c82859 30#include "wx/log.h"
5526e819 31
5526e819
VS
32
33//-----------------------------------------------------------------------------
34// wxHtmlWindow
35//-----------------------------------------------------------------------------
36
37
38
3096bd2f 39#include "wx/arrimpl.cpp"
5526e819
VS
40WX_DEFINE_OBJARRAY(HtmlHistoryArray)
41
42
269e8200 43wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
f6bcfd97 44 long style, const wxString& name) : wxScrolledWindow(parent, id, pos, size, style | wxVSCROLL | wxHSCROLL, name)
5526e819
VS
45{
46 m_tmpMouseMoved = FALSE;
846914d1 47 m_tmpLastLink = NULL;
89de9af3 48 m_tmpCanDrawLocks = 0;
5526e819
VS
49 m_FS = new wxFileSystem();
50 m_RelatedStatusBar = -1;
51 m_RelatedFrame = NULL;
52 m_TitleFormat = "%s";
d5db80c2 53 m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
5526e819
VS
54 m_Cell = NULL;
55 m_Parser = new wxHtmlWinParser(this);
56 m_Parser -> SetFS(m_FS);
57 SetBorders(10);
58 m_HistoryPos = -1;
59 m_HistoryOn = TRUE;
a547ebff 60 m_Style = style;
5526e819
VS
61 SetPage("<html><body></body></html>");
62}
63
64
65
66wxHtmlWindow::~wxHtmlWindow()
67{
68 HistoryClear();
69
70 if (m_Cell) delete m_Cell;
71
5526e819
VS
72 delete m_Parser;
73 delete m_FS;
74}
75
76
77
78void wxHtmlWindow::SetRelatedFrame(wxFrame* frame, const wxString& format)
79{
80 m_RelatedFrame = frame;
81 m_TitleFormat = format;
82}
83
84
85
86void wxHtmlWindow::SetRelatedStatusBar(int bar)
87{
88 m_RelatedStatusBar = bar;
89}
269e8200
RD
90
91
92
8eb2940f 93void wxHtmlWindow::SetFonts(wxString normal_face, wxString fixed_face, const int *sizes)
5526e819 94{
d5db80c2
VS
95 wxString op = m_OpenedPage;
96
8eb2940f 97 m_Parser -> SetFonts(normal_face, fixed_face, sizes);
fb5700fe 98 SetPage(wxT("<html><body></body></html>")); // fonts changed => contents invalid
d5db80c2 99 if (!op.IsEmpty()) LoadPage(op);
5526e819
VS
100}
101
102
103
104bool wxHtmlWindow::SetPage(const wxString& source)
105{
106 wxClientDC *dc = new wxClientDC(this);
107
108 dc -> SetMapMode(wxMM_TEXT);
109 SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF));
d5db80c2 110 m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
5526e819 111 m_Parser -> SetDC(dc);
f61815af 112 if (m_Cell) {
89de9af3
VS
113 delete m_Cell;
114 m_Cell = NULL;
f61815af 115 }
5526e819
VS
116 m_Cell = (wxHtmlContainerCell*) m_Parser -> Parse(source);
117 delete dc;
efba2b89
VS
118 m_Cell -> SetIndent(m_Borders, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS);
119 m_Cell -> SetAlignHor(wxHTML_ALIGN_CENTER);
5526e819 120 CreateLayout();
89de9af3 121 if (m_tmpCanDrawLocks == 0) Refresh();
5526e819
VS
122 return TRUE;
123}
124
125
126bool wxHtmlWindow::LoadPage(const wxString& location)
127{
128 wxFSFile *f;
129 bool rt_val;
fc7dfaf8
VS
130 bool needs_refresh = FALSE;
131
169ee06c 132 SetCursor(*wxHOURGLASS_CURSOR);
fc7dfaf8 133 wxYield(); Refresh(FALSE);
5526e819 134
89de9af3 135 m_tmpCanDrawLocks++;
5526e819
VS
136 if (m_HistoryOn && (m_HistoryPos != -1)) { // store scroll position into history item
137 int x, y;
138 ViewStart(&x, &y);
139 m_History[m_HistoryPos].SetPos(y);
140 }
141
fc7dfaf8 142 if (location[0] == wxT('#')) { // local anchor
5526e819 143 wxString anch = location.Mid(1) /*1 to end*/;
89de9af3 144 m_tmpCanDrawLocks--;
5526e819 145 rt_val = ScrollToAnchor(anch);
fc7dfaf8
VS
146 m_tmpCanDrawLocks++;
147 }
148 else if (location.Find(wxT('#')) != wxNOT_FOUND && location.BeforeFirst(wxT('#')) == m_OpenedPage) {
149 wxString anch = location.AfterFirst(wxT('#'));
150 m_tmpCanDrawLocks--;
151 rt_val = ScrollToAnchor(anch);
152 m_tmpCanDrawLocks++;
153 }
154 else if (location.Find(wxT('#')) != wxNOT_FOUND &&
155 (m_FS -> GetPath() + location.BeforeFirst(wxT('#'))) == m_OpenedPage) {
156 wxString anch = location.AfterFirst(wxT('#'));
157 m_tmpCanDrawLocks--;
158 rt_val = ScrollToAnchor(anch);
159 m_tmpCanDrawLocks++;
5526e819
VS
160 }
161
162 else {
fc7dfaf8 163 needs_refresh = TRUE;
5526e819
VS
164 // load&display it:
165 if (m_RelatedStatusBar != -1) {
166 m_RelatedFrame -> SetStatusText(_("Connecting..."), m_RelatedStatusBar);
fc7dfaf8 167 Refresh(FALSE);
5526e819
VS
168 }
169
170 f = m_FS -> OpenFile(location);
fc7dfaf8 171
5526e819
VS
172 if (f == NULL) {
173 wxString err;
174
f6bcfd97 175 wxLogError(_("Unable to open requested HTML document: %s"), location.c_str());
89de9af3 176 m_tmpCanDrawLocks--;
169ee06c
VS
177
178 SetCursor(*wxSTANDARD_CURSOR);
5526e819
VS
179 return FALSE;
180 }
181
182 else {
183 wxNode *node;
184 wxString src = wxEmptyString;
185
186 if (m_RelatedStatusBar != -1) {
187 wxString msg = _("Loading : ") + location;
188 m_RelatedFrame -> SetStatusText(msg, m_RelatedStatusBar);
fc7dfaf8 189 Refresh(FALSE);
5526e819
VS
190 }
191
192 node = m_Filters.GetFirst();
193 while (node){
194 wxHtmlFilter *h = (wxHtmlFilter*) node -> GetData();
195 if (h -> CanRead(*f)) {
196 src = h -> ReadFile(*f);
197 break;
198 }
199 node = node -> GetNext();
200 }
a76015e6 201 if (src == wxEmptyString) {
89de9af3
VS
202 if (m_DefaultFilter == NULL) m_DefaultFilter = GetDefaultFilter();
203 src = m_DefaultFilter -> ReadFile(*f);
204 }
5526e819
VS
205
206 m_FS -> ChangePathTo(f -> GetLocation());
207 rt_val = SetPage(src);
208 m_OpenedPage = f -> GetLocation();
209 if (f -> GetAnchor() != wxEmptyString) {
fc7dfaf8 210 wxYield();
5526e819 211 ScrollToAnchor(f -> GetAnchor());
5526e819
VS
212 }
213
214 delete f;
215
216 if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(_("Done"), m_RelatedStatusBar);
217 }
218 }
219
220 if (m_HistoryOn) { // add this page to history there:
221 int c = m_History.GetCount() - (m_HistoryPos + 1);
222
223 m_HistoryPos++;
224 for (int i = 0; i < c; i++)
225 m_History.Remove(m_HistoryPos);
226 m_History.Add(new HtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
227 }
228
096824d7
VS
229 if (m_OpenedPageTitle == wxEmptyString)
230 OnSetTitle(wxFileNameFromPath(m_OpenedPage));
169ee06c 231 SetCursor(*wxSTANDARD_CURSOR);
fc7dfaf8
VS
232
233 if (needs_refresh) {
234 wxYield();
235 m_tmpCanDrawLocks--;
236 Refresh();
237 }
238 else
239 m_tmpCanDrawLocks--;
240
5526e819
VS
241 return rt_val;
242}
243
244
245
246bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
247{
efba2b89 248 const wxHtmlCell *c = m_Cell -> Find(wxHTML_COND_ISANCHOR, &anchor);
f3c82859
VS
249 if (!c)
250 {
f6bcfd97 251 wxLogWarning(_("HTML anchor %s does not exist."), anchor.c_str());
f3c82859
VS
252 return FALSE;
253 }
5526e819
VS
254 else {
255 int y;
269e8200 256
5526e819 257 for (y = 0; c != NULL; c = c -> GetParent()) y += c -> GetPosY();
efba2b89 258 Scroll(-1, y / wxHTML_SCROLL_STEP);
5526e819
VS
259 m_OpenedAnchor = anchor;
260 return TRUE;
261 }
262}
263
264
d5db80c2 265void wxHtmlWindow::OnSetTitle(const wxString& title)
5526e819
VS
266{
267 if (m_RelatedFrame) {
268 wxString tit;
269 tit.Printf(m_TitleFormat, title.c_str());
270 m_RelatedFrame -> SetTitle(tit);
271 }
d5db80c2 272 m_OpenedPageTitle = title;
5526e819
VS
273}
274
275
276
277
278
279void wxHtmlWindow::CreateLayout()
280{
281 int ClientWidth, ClientHeight;
282
283 if (!m_Cell) return;
a547ebff 284
f6bcfd97 285 if (m_Style & wxHW_SCROLLBAR_NEVER) {
08d038e7 286 SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // always off
a547ebff
VS
287 GetClientSize(&ClientWidth, &ClientHeight);
288 m_Cell -> Layout(ClientWidth);
289 }
290
291 else {
292 GetClientSize(&ClientWidth, &ClientHeight);
a547ebff 293 m_Cell -> Layout(ClientWidth);
f3bcfd9b
VS
294 if (ClientHeight < m_Cell -> GetHeight() + GetCharHeight()) {
295 SetScrollbars(
296 wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP,
297 m_Cell -> GetWidth() / wxHTML_SCROLL_STEP,
298 (m_Cell -> GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
299 /*cheat: top-level frag is always container*/);
a547ebff 300 }
89de9af3 301 else { /* we fit into window, no need for scrollbars */
08d038e7 302 SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // disable...
89de9af3
VS
303 GetClientSize(&ClientWidth, &ClientHeight);
304 m_Cell -> Layout(ClientWidth); // ...and relayout
305 }
a547ebff 306 }
5526e819
VS
307}
308
269e8200 309
5526e819
VS
310
311void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path)
312{
313 wxString oldpath;
314 wxString tmp;
d5db80c2
VS
315 int p_fontsizes[7];
316 wxString p_fff, p_ffn;
5526e819
VS
317
318 if (path != wxEmptyString) {
319 oldpath = cfg -> GetPath();
320 cfg -> SetPath(path);
321 }
322
323 m_Borders = cfg -> Read("wxHtmlWindow/Borders", m_Borders);
d5db80c2
VS
324 p_fff = cfg -> Read("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
325 p_ffn = cfg -> Read("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
5526e819 326 for (int i = 0; i < 7; i++) {
66a77a74 327 tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
d5db80c2 328 p_fontsizes[i] = cfg -> Read(tmp, m_Parser -> m_FontsSizes[i]);
5526e819 329 }
8eb2940f 330 SetFonts(p_ffn, p_fff, p_fontsizes);
5526e819
VS
331
332 if (path != wxEmptyString)
333 cfg -> SetPath(oldpath);
334}
335
336
337
338void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path)
339{
340 wxString oldpath;
341 wxString tmp;
342
343 if (path != wxEmptyString) {
344 oldpath = cfg -> GetPath();
345 cfg -> SetPath(path);
346 }
347
348 cfg -> Write("wxHtmlWindow/Borders", (long) m_Borders);
349 cfg -> Write("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
350 cfg -> Write("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
5526e819 351 for (int i = 0; i < 7; i++) {
66a77a74 352 tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
5526e819
VS
353 cfg -> Write(tmp, (long) m_Parser -> m_FontsSizes[i]);
354 }
355
356 if (path != wxEmptyString)
357 cfg -> SetPath(oldpath);
358}
359
360
361
362bool wxHtmlWindow::HistoryBack()
363{
364 wxString a, l;
365
366 if (m_HistoryPos < 1) return FALSE;
367
368 m_HistoryPos--;
369
370 l = m_History[m_HistoryPos].GetPage();
371 a = m_History[m_HistoryPos].GetAnchor();
372 m_HistoryOn = FALSE;
89de9af3 373 m_tmpCanDrawLocks++;
5526e819 374 if (a == wxEmptyString) LoadPage(l);
fc7dfaf8 375 else LoadPage(l + wxT("#") + a);
5526e819 376 m_HistoryOn = TRUE;
c88293a4 377 wxYield();
89de9af3 378 m_tmpCanDrawLocks--;
c88293a4 379 Scroll(0, m_History[m_HistoryPos].GetPos());
5526e819
VS
380 Refresh();
381 return TRUE;
382}
383
384
385
386bool wxHtmlWindow::HistoryForward()
387{
388 wxString a, l;
389
390 if (m_HistoryPos == -1) return FALSE;
391 if (m_HistoryPos >= (int)m_History.GetCount() - 1)return FALSE;
392
393 m_OpenedPage = wxEmptyString; // this will disable adding new entry into history in LoadPage()
394
395 m_HistoryPos++;
396 l = m_History[m_HistoryPos].GetPage();
397 a = m_History[m_HistoryPos].GetAnchor();
398 m_HistoryOn = FALSE;
89de9af3 399 m_tmpCanDrawLocks++;
5526e819 400 if (a == wxEmptyString) LoadPage(l);
fc7dfaf8 401 else LoadPage(l + wxT("#") + a);
5526e819 402 m_HistoryOn = TRUE;
c88293a4 403 wxYield();
89de9af3 404 m_tmpCanDrawLocks--;
c88293a4 405 Scroll(0, m_History[m_HistoryPos].GetPos());
5526e819
VS
406 Refresh();
407 return TRUE;
408}
409
410
411
412void wxHtmlWindow::HistoryClear()
413{
414 m_History.Empty();
415 m_HistoryPos = -1;
416}
417
418
419
420wxList wxHtmlWindow::m_Filters;
a76015e6 421wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL;
66806a0b
VS
422wxCursor *wxHtmlWindow::s_cur_hand = NULL;
423wxCursor *wxHtmlWindow::s_cur_arrow = NULL;
a76015e6
VS
424
425void wxHtmlWindow::CleanUpStatics()
426{
427 if (m_DefaultFilter) delete m_DefaultFilter;
428 m_DefaultFilter = NULL;
269e8200
RD
429 m_Filters.DeleteContents(TRUE);
430 m_Filters.Clear();
66806a0b
VS
431 if (s_cur_hand) delete s_cur_hand;
432 if (s_cur_arrow) delete s_cur_arrow;
a76015e6
VS
433}
434
435
5526e819
VS
436
437void wxHtmlWindow::AddFilter(wxHtmlFilter *filter)
438{
5526e819
VS
439 m_Filters.Append(filter);
440}
441
442
443
444
0b2dadd3 445void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link)
5526e819 446{
0b2dadd3 447 LoadPage(link.GetHref());
5526e819
VS
448}
449
450
451
452void wxHtmlWindow::OnDraw(wxDC& dc)
453{
454 int x, y;
455 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
456 int v_y, v_h;
457
89de9af3 458 if (m_tmpCanDrawLocks > 0) return;
fc7dfaf8 459
5526e819 460 dc.SetMapMode(wxMM_TEXT);
2faa3a6b
VS
461#if 0
462/* VS - I don't think this is neccessary any longer
463 MSC_VER 1200 means MSVC 6.0 and it works fine */
5526e819
VS
464#if defined(_MSC_VER) && (_MSC_VER == 1200)
465 ::SetMapMode((HDC)dc.GetHDC(), MM_TEXT);
2faa3a6b 466#endif
5526e819
VS
467#endif
468 dc.SetBackgroundMode(wxTRANSPARENT);
469 ViewStart(&x, &y);
470
471 while (upd) {
472 v_y = upd.GetY();
473 v_h = upd.GetH();
efba2b89 474 if (m_Cell) m_Cell -> Draw(dc, 0, 0, y * wxHTML_SCROLL_STEP + v_y, y * wxHTML_SCROLL_STEP + v_h + v_y);
5526e819
VS
475 upd++;
476 }
477}
478
479
480
481
482void wxHtmlWindow::OnSize(wxSizeEvent& event)
483{
484 wxScrolledWindow::OnSize(event);
485 CreateLayout();
f6bcfd97 486 Refresh();
5526e819
VS
487}
488
489
5526e819
VS
490void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
491{
492 m_tmpMouseMoved = TRUE;
493
494 if (event.ButtonDown()) {
495 int sx, sy;
496 wxPoint pos;
497 wxString lnk;
498
efba2b89 499 ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
5526e819
VS
500 pos = event.GetPosition();
501
502 if (m_Cell)
0b2dadd3 503 m_Cell -> OnMouseClick(this, sx + pos.x, sy + pos.y, event);
5526e819
VS
504 }
505}
506
507
508
509void wxHtmlWindow::OnIdle(wxIdleEvent& event)
510{
66806a0b
VS
511 if (s_cur_hand == NULL)
512 {
513 s_cur_hand = new wxCursor(wxCURSOR_HAND);
514 s_cur_arrow = new wxCursor(wxCURSOR_ARROW);
515 }
5526e819
VS
516
517 if (m_tmpMouseMoved && (m_Cell != NULL)) {
518 int sx, sy;
519 int x, y;
846914d1 520 wxHtmlLinkInfo *lnk;
5526e819 521
efba2b89 522 ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
5526e819
VS
523 wxGetMousePosition(&x, &y);
524 ScreenToClient(&x, &y);
525 lnk = m_Cell -> GetLink(sx + x, sy + y);
526
622ea783 527 if (lnk != m_tmpLastLink) {
846914d1 528 if (lnk == NULL) {
66806a0b 529 SetCursor(*s_cur_arrow);
622ea783
VS
530 if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(wxEmptyString, m_RelatedStatusBar);
531 }
532 else {
66806a0b 533 SetCursor(*s_cur_hand);
846914d1
VS
534 if (m_RelatedStatusBar != -1)
535 m_RelatedFrame -> SetStatusText(lnk -> GetHref(), m_RelatedStatusBar);
622ea783
VS
536 }
537 m_tmpLastLink = lnk;
5526e819
VS
538 }
539 m_tmpMouseMoved = FALSE;
540 }
541}
542
543
544
545
546IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)
547
548BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow)
549 EVT_SIZE(wxHtmlWindow::OnSize)
550 EVT_LEFT_DOWN(wxHtmlWindow::OnMouseEvent)
551 EVT_MOTION(wxHtmlWindow::OnMouseEvent)
552 EVT_IDLE(wxHtmlWindow::OnIdle)
5526e819
VS
553END_EVENT_TABLE()
554
555
556
557
558
a76015e6
VS
559// A module to allow initialization/cleanup
560// without calling these functions from app.cpp or from
561// the user's application.
562
563class wxHtmlWinModule: public wxModule
564{
565DECLARE_DYNAMIC_CLASS(wxHtmlWinModule)
566public:
567 wxHtmlWinModule() : wxModule() {}
568 bool OnInit() { return TRUE; }
569 void OnExit() { wxHtmlWindow::CleanUpStatics(); }
570};
571
572IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule, wxModule)
573
5526e819
VS
574
575
576
577///// default mod handlers are forced there:
578
c88293a4
VS
579FORCE_LINK(m_layout)
580FORCE_LINK(m_fonts)
581FORCE_LINK(m_image)
582FORCE_LINK(m_list)
583FORCE_LINK(m_dflist)
584FORCE_LINK(m_pre)
585FORCE_LINK(m_hline)
586FORCE_LINK(m_links)
587FORCE_LINK(m_tables)
fa146dd7 588FORCE_LINK(m_meta)
5526e819
VS
589
590
483ff5a5 591#endif