1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/html/htmlwin.cpp
3 // Purpose: wxHtmlWindow class for parsing & displaying HTML (implementation)
4 // Author: Vaclav Slavik
6 // Copyright: (c) 1999 Vaclav Slavik
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #include "wx/wxprec.h"
16 #if wxUSE_HTML && wxUSE_STREAMS
22 #include "wx/dcclient.h"
24 #include "wx/dcmemory.h"
26 #include "wx/settings.h"
27 #include "wx/dataobj.h"
30 #include "wx/html/htmlwin.h"
31 #include "wx/html/htmlproc.h"
32 #include "wx/clipbrd.h"
34 #include "wx/arrimpl.cpp"
35 #include "wx/listimpl.cpp"
38 IMPLEMENT_DYNAMIC_CLASS(wxHtmlLinkEvent
, wxCommandEvent
)
39 IMPLEMENT_DYNAMIC_CLASS(wxHtmlCellEvent
, wxCommandEvent
)
41 DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTML_CELL_CLICKED
)
42 DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTML_CELL_HOVER
)
43 DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTML_LINK_CLICKED
)
47 // ----------------------------------------------------------------------------
48 // wxHtmlWinAutoScrollTimer: the timer used to generate a stream of scroll
49 // events when a captured mouse is held outside the window
50 // ----------------------------------------------------------------------------
52 class wxHtmlWinAutoScrollTimer
: public wxTimer
55 wxHtmlWinAutoScrollTimer(wxScrolledWindow
*win
,
56 wxEventType eventTypeToSend
,
60 m_eventType
= eventTypeToSend
;
65 virtual void Notify();
68 wxScrolledWindow
*m_win
;
69 wxEventType m_eventType
;
73 DECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer
)
76 void wxHtmlWinAutoScrollTimer::Notify()
78 // only do all this as long as the window is capturing the mouse
79 if ( wxWindow::GetCapture() != m_win
)
83 else // we still capture the mouse, continue generating events
85 // first scroll the window if we are allowed to do it
86 wxScrollWinEvent
event1(m_eventType
, m_pos
, m_orient
);
87 event1
.SetEventObject(m_win
);
88 if ( m_win
->GetEventHandler()->ProcessEvent(event1
) )
90 // and then send a pseudo mouse-move event to refresh the selection
91 wxMouseEvent
event2(wxEVT_MOTION
);
92 wxGetMousePosition(&event2
.m_x
, &event2
.m_y
);
94 // the mouse event coordinates should be client, not screen as
95 // returned by wxGetMousePosition
96 wxWindow
*parentTop
= m_win
;
97 while ( parentTop
->GetParent() )
98 parentTop
= parentTop
->GetParent();
99 wxPoint ptOrig
= parentTop
->GetPosition();
100 event2
.m_x
-= ptOrig
.x
;
101 event2
.m_y
-= ptOrig
.y
;
103 event2
.SetEventObject(m_win
);
105 // FIXME: we don't fill in the other members - ok?
106 m_win
->GetEventHandler()->ProcessEvent(event2
);
108 else // can't scroll further, stop
115 #endif // wxUSE_CLIPBOARD
119 //-----------------------------------------------------------------------------
121 //-----------------------------------------------------------------------------
123 // item of history list
124 class WXDLLIMPEXP_HTML wxHtmlHistoryItem
127 wxHtmlHistoryItem(const wxString
& p
, const wxString
& a
) {m_Page
= p
, m_Anchor
= a
, m_Pos
= 0;}
128 int GetPos() const {return m_Pos
;}
129 void SetPos(int p
) {m_Pos
= p
;}
130 const wxString
& GetPage() const {return m_Page
;}
131 const wxString
& GetAnchor() const {return m_Anchor
;}
140 //-----------------------------------------------------------------------------
141 // our private arrays:
142 //-----------------------------------------------------------------------------
144 WX_DECLARE_OBJARRAY(wxHtmlHistoryItem
, wxHtmlHistoryArray
);
145 WX_DEFINE_OBJARRAY(wxHtmlHistoryArray
)
147 WX_DECLARE_LIST(wxHtmlProcessor
, wxHtmlProcessorList
);
148 WX_DEFINE_LIST(wxHtmlProcessorList
)
150 //-----------------------------------------------------------------------------
151 // wxHtmlWindowMouseHelper
152 //-----------------------------------------------------------------------------
154 wxHtmlWindowMouseHelper::wxHtmlWindowMouseHelper(wxHtmlWindowInterface
*iface
)
155 : m_tmpMouseMoved(false),
162 void wxHtmlWindowMouseHelper::HandleMouseMoved()
164 m_tmpMouseMoved
= true;
167 bool wxHtmlWindowMouseHelper::HandleMouseClick(wxHtmlCell
*rootCell
,
169 const wxMouseEvent
& event
)
174 wxHtmlCell
*cell
= rootCell
->FindCellByPos(pos
.x
, pos
.y
);
175 // this check is needed because FindCellByPos returns terminal cell and
176 // containers may have empty borders -- in this case NULL will be
181 // adjust the coordinates to be relative to this cell:
182 wxPoint relpos
= pos
- cell
->GetAbsPos(rootCell
);
184 return OnCellClicked(cell
, relpos
.x
, relpos
.y
, event
);
187 void wxHtmlWindowMouseHelper::HandleIdle(wxHtmlCell
*rootCell
,
190 wxHtmlCell
*cell
= rootCell
? rootCell
->FindCellByPos(pos
.x
, pos
.y
) : NULL
;
192 if (cell
!= m_tmpLastCell
)
194 wxHtmlLinkInfo
*lnk
= NULL
;
197 // adjust the coordinates to be relative to this cell:
198 wxPoint relpos
= pos
- cell
->GetAbsPos(rootCell
);
199 lnk
= cell
->GetLink(relpos
.x
, relpos
.y
);
204 cur
= cell
->GetMouseCursor(m_interface
);
206 cur
= m_interface
->GetHTMLCursor(
207 wxHtmlWindowInterface::HTMLCursor_Default
);
209 m_interface
->GetHTMLWindow()->SetCursor(cur
);
211 if (lnk
!= m_tmpLastLink
)
214 m_interface
->SetHTMLStatusText(lnk
->GetHref());
216 m_interface
->SetHTMLStatusText(wxEmptyString
);
221 m_tmpLastCell
= cell
;
223 else // mouse moved but stayed in the same cell
227 OnCellMouseHover(cell
, pos
.x
, pos
.y
);
231 m_tmpMouseMoved
= false;
234 bool wxHtmlWindowMouseHelper::OnCellClicked(wxHtmlCell
*cell
,
235 wxCoord x
, wxCoord y
,
236 const wxMouseEvent
& event
)
238 wxHtmlCellEvent
ev(wxEVT_COMMAND_HTML_CELL_CLICKED
,
239 m_interface
->GetHTMLWindow()->GetId(),
240 cell
, wxPoint(x
,y
), event
);
242 if (!m_interface
->GetHTMLWindow()->GetEventHandler()->ProcessEvent(ev
))
244 // if the event wasn't handled, do the default processing here:
246 wxASSERT_MSG( cell
, _T("can't be called with NULL cell") );
248 cell
->ProcessMouseClick(m_interface
, ev
.GetPoint(), ev
.GetMouseEvent());
251 // true if a link was clicked, false otherwise
252 return ev
.GetLinkClicked();
255 void wxHtmlWindowMouseHelper::OnCellMouseHover(wxHtmlCell
* cell
,
259 wxHtmlCellEvent
ev(wxEVT_COMMAND_HTML_CELL_HOVER
,
260 m_interface
->GetHTMLWindow()->GetId(),
261 cell
, wxPoint(x
,y
), wxMouseEvent());
262 m_interface
->GetHTMLWindow()->GetEventHandler()->ProcessEvent(ev
);
268 //-----------------------------------------------------------------------------
270 //-----------------------------------------------------------------------------
272 wxList
wxHtmlWindow::m_Filters
;
273 wxHtmlFilter
*wxHtmlWindow::m_DefaultFilter
= NULL
;
274 wxHtmlProcessorList
*wxHtmlWindow::m_GlobalProcessors
= NULL
;
275 wxCursor
*wxHtmlWindow::ms_cursorLink
= NULL
;
276 wxCursor
*wxHtmlWindow::ms_cursorText
= NULL
;
278 void wxHtmlWindow::CleanUpStatics()
280 wxDELETE(m_DefaultFilter
);
281 WX_CLEAR_LIST(wxList
, m_Filters
);
282 if (m_GlobalProcessors
)
283 WX_CLEAR_LIST(wxHtmlProcessorList
, *m_GlobalProcessors
);
284 wxDELETE(m_GlobalProcessors
);
285 wxDELETE(ms_cursorLink
);
286 wxDELETE(ms_cursorText
);
289 void wxHtmlWindow::Init()
291 m_tmpCanDrawLocks
= 0;
292 m_FS
= new wxFileSystem();
294 m_RelatedStatusBar
= -1;
295 #endif // wxUSE_STATUSBAR
296 m_RelatedFrame
= NULL
;
297 m_TitleFormat
= wxT("%s");
298 m_OpenedPage
= m_OpenedAnchor
= m_OpenedPageTitle
= wxEmptyString
;
300 m_Parser
= new wxHtmlWinParser(this);
301 m_Parser
->SetFS(m_FS
);
304 m_History
= new wxHtmlHistoryArray
;
308 m_makingSelection
= false;
310 m_timerAutoScroll
= NULL
;
311 m_lastDoubleClick
= 0;
312 #endif // wxUSE_CLIPBOARD
314 m_eraseBgInOnPaint
= false;
315 m_tmpSelFromCell
= NULL
;
318 bool wxHtmlWindow::Create(wxWindow
*parent
, wxWindowID id
,
319 const wxPoint
& pos
, const wxSize
& size
,
320 long style
, const wxString
& name
)
322 if (!wxScrolledWindow::Create(parent
, id
, pos
, size
,
323 style
| wxVSCROLL
| wxHSCROLL
,
327 SetPage(wxT("<html><body></body></html>"));
332 wxHtmlWindow::~wxHtmlWindow()
336 #endif // wxUSE_CLIPBOARD
345 WX_CLEAR_LIST(wxHtmlProcessorList
, *m_Processors
);
357 void wxHtmlWindow::SetRelatedFrame(wxFrame
* frame
, const wxString
& format
)
359 m_RelatedFrame
= frame
;
360 m_TitleFormat
= format
;
366 void wxHtmlWindow::SetRelatedStatusBar(int bar
)
368 m_RelatedStatusBar
= bar
;
370 #endif // wxUSE_STATUSBAR
374 void wxHtmlWindow::SetFonts(const wxString
& normal_face
, const wxString
& fixed_face
, const int *sizes
)
376 m_Parser
->SetFonts(normal_face
, fixed_face
, sizes
);
378 // re-layout the page after changing fonts:
379 DoSetPage(*(m_Parser
->GetSource()));
382 void wxHtmlWindow::SetStandardFonts(int size
,
383 const wxString
& normal_face
,
384 const wxString
& fixed_face
)
386 m_Parser
->SetStandardFonts(size
, normal_face
, fixed_face
);
388 // re-layout the page after changing fonts:
389 DoSetPage(*(m_Parser
->GetSource()));
392 bool wxHtmlWindow::SetPage(const wxString
& source
)
394 m_OpenedPage
= m_OpenedAnchor
= m_OpenedPageTitle
= wxEmptyString
;
395 return DoSetPage(source
);
398 bool wxHtmlWindow::DoSetPage(const wxString
& source
)
400 wxString
newsrc(source
);
402 wxDELETE(m_selection
);
404 // we will soon delete all the cells, so clear pointers to them:
405 m_tmpSelFromCell
= NULL
;
407 // pass HTML through registered processors:
408 if (m_Processors
|| m_GlobalProcessors
)
410 wxHtmlProcessorList::compatibility_iterator nodeL
, nodeG
;
414 nodeL
= m_Processors
->GetFirst();
415 if ( m_GlobalProcessors
)
416 nodeG
= m_GlobalProcessors
->GetFirst();
418 // VS: there are two lists, global and local, both of them sorted by
419 // priority. Since we have to go through _both_ lists with
420 // decreasing priority, we "merge-sort" the lists on-line by
421 // processing that one of the two heads that has higher priority
422 // in every iteration
423 while (nodeL
|| nodeG
)
425 prL
= (nodeL
) ? nodeL
->GetData()->GetPriority() : -1;
426 prG
= (nodeG
) ? nodeG
->GetData()->GetPriority() : -1;
429 if (nodeL
->GetData()->IsEnabled())
430 newsrc
= nodeL
->GetData()->Process(newsrc
);
431 nodeL
= nodeL
->GetNext();
435 if (nodeG
->GetData()->IsEnabled())
436 newsrc
= nodeG
->GetData()->Process(newsrc
);
437 nodeG
= nodeG
->GetNext();
442 // ...and run the parser on it:
443 wxClientDC
*dc
= new wxClientDC(this);
444 dc
->SetMapMode(wxMM_TEXT
);
445 SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF));
446 SetBackgroundImage(wxNullBitmap
);
454 m_Cell
= (wxHtmlContainerCell
*) m_Parser
->Parse(newsrc
);
456 m_Cell
->SetIndent(m_Borders
, wxHTML_INDENT_ALL
, wxHTML_UNITS_PIXELS
);
457 m_Cell
->SetAlignHor(wxHTML_ALIGN_CENTER
);
459 if (m_tmpCanDrawLocks
== 0)
464 bool wxHtmlWindow::AppendToPage(const wxString
& source
)
466 return DoSetPage(*(GetParser()->GetSource()) + source
);
469 bool wxHtmlWindow::LoadPage(const wxString
& location
)
471 wxBusyCursor busyCursor
;
475 bool needs_refresh
= false;
478 if (m_HistoryOn
&& (m_HistoryPos
!= -1))
480 // store scroll position into history item:
482 GetViewStart(&x
, &y
);
483 (*m_History
)[m_HistoryPos
].SetPos(y
);
486 if (location
[0] == wxT('#'))
489 wxString anch
= location
.Mid(1) /*1 to end*/;
491 rt_val
= ScrollToAnchor(anch
);
494 else if (location
.Find(wxT('#')) != wxNOT_FOUND
&& location
.BeforeFirst(wxT('#')) == m_OpenedPage
)
496 wxString anch
= location
.AfterFirst(wxT('#'));
498 rt_val
= ScrollToAnchor(anch
);
501 else if (location
.Find(wxT('#')) != wxNOT_FOUND
&&
502 (m_FS
->GetPath() + location
.BeforeFirst(wxT('#'))) == m_OpenedPage
)
504 wxString anch
= location
.AfterFirst(wxT('#'));
506 rt_val
= ScrollToAnchor(anch
);
512 needs_refresh
= true;
515 if (m_RelatedStatusBar
!= -1)
517 m_RelatedFrame
->SetStatusText(_("Connecting..."), m_RelatedStatusBar
);
520 #endif // wxUSE_STATUSBAR
522 f
= m_Parser
->OpenURL(wxHTML_URL_PAGE
, location
);
524 // try to interpret 'location' as filename instead of URL:
527 wxFileName
fn(location
);
528 wxString location2
= wxFileSystem::FileNameToURL(fn
);
529 f
= m_Parser
->OpenURL(wxHTML_URL_PAGE
, location2
);
534 wxLogError(_("Unable to open requested HTML document: %s"), location
.c_str());
541 wxList::compatibility_iterator node
;
542 wxString src
= wxEmptyString
;
545 if (m_RelatedStatusBar
!= -1)
547 wxString msg
= _("Loading : ") + location
;
548 m_RelatedFrame
->SetStatusText(msg
, m_RelatedStatusBar
);
551 #endif // wxUSE_STATUSBAR
553 node
= m_Filters
.GetFirst();
556 wxHtmlFilter
*h
= (wxHtmlFilter
*) node
->GetData();
559 src
= h
->ReadFile(*f
);
562 node
= node
->GetNext();
564 if (src
== wxEmptyString
)
566 if (m_DefaultFilter
== NULL
) m_DefaultFilter
= GetDefaultFilter();
567 src
= m_DefaultFilter
->ReadFile(*f
);
570 m_FS
->ChangePathTo(f
->GetLocation());
571 rt_val
= SetPage(src
);
572 m_OpenedPage
= f
->GetLocation();
573 if (f
->GetAnchor() != wxEmptyString
)
575 ScrollToAnchor(f
->GetAnchor());
581 if (m_RelatedStatusBar
!= -1)
582 m_RelatedFrame
->SetStatusText(_("Done"), m_RelatedStatusBar
);
583 #endif // wxUSE_STATUSBAR
587 if (m_HistoryOn
) // add this page to history there:
589 int c
= m_History
->GetCount() - (m_HistoryPos
+ 1);
591 if (m_HistoryPos
< 0 ||
592 (*m_History
)[m_HistoryPos
].GetPage() != m_OpenedPage
||
593 (*m_History
)[m_HistoryPos
].GetAnchor() != m_OpenedAnchor
)
596 for (int i
= 0; i
< c
; i
++)
597 m_History
->RemoveAt(m_HistoryPos
);
598 m_History
->Add(new wxHtmlHistoryItem(m_OpenedPage
, m_OpenedAnchor
));
602 if (m_OpenedPageTitle
== wxEmptyString
)
603 OnSetTitle(wxFileNameFromPath(m_OpenedPage
));
617 bool wxHtmlWindow::LoadFile(const wxFileName
& filename
)
619 wxString url
= wxFileSystem::FileNameToURL(filename
);
620 return LoadPage(url
);
624 bool wxHtmlWindow::ScrollToAnchor(const wxString
& anchor
)
626 const wxHtmlCell
*c
= m_Cell
->Find(wxHTML_COND_ISANCHOR
, &anchor
);
629 wxLogWarning(_("HTML anchor %s does not exist."), anchor
.c_str());
636 for (y
= 0; c
!= NULL
; c
= c
->GetParent()) y
+= c
->GetPosY();
637 Scroll(-1, y
/ wxHTML_SCROLL_STEP
);
638 m_OpenedAnchor
= anchor
;
644 void wxHtmlWindow::OnSetTitle(const wxString
& title
)
649 tit
.Printf(m_TitleFormat
, title
.c_str());
650 m_RelatedFrame
->SetTitle(tit
);
652 m_OpenedPageTitle
= title
;
659 void wxHtmlWindow::CreateLayout()
661 int ClientWidth
, ClientHeight
;
665 if ( HasFlag(wxHW_SCROLLBAR_NEVER
) )
667 SetScrollbars(1, 1, 0, 0); // always off
668 GetClientSize(&ClientWidth
, &ClientHeight
);
669 m_Cell
->Layout(ClientWidth
);
671 else // !wxHW_SCROLLBAR_NEVER
673 GetClientSize(&ClientWidth
, &ClientHeight
);
674 m_Cell
->Layout(ClientWidth
);
675 if (ClientHeight
< m_Cell
->GetHeight() + GetCharHeight())
678 wxHTML_SCROLL_STEP
, wxHTML_SCROLL_STEP
,
679 m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
,
680 (m_Cell
->GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
681 /*cheat: top-level frag is always container*/);
683 else /* we fit into window, no need for scrollbars */
685 SetScrollbars(wxHTML_SCROLL_STEP
, 1, m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
, 0); // disable...
686 GetClientSize(&ClientWidth
, &ClientHeight
);
687 m_Cell
->Layout(ClientWidth
); // ...and relayout
694 void wxHtmlWindow::ReadCustomization(wxConfigBase
*cfg
, wxString path
)
699 wxString p_fff
, p_ffn
;
701 if (path
!= wxEmptyString
)
703 oldpath
= cfg
->GetPath();
707 m_Borders
= cfg
->Read(wxT("wxHtmlWindow/Borders"), m_Borders
);
708 p_fff
= cfg
->Read(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser
->m_FontFaceFixed
);
709 p_ffn
= cfg
->Read(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser
->m_FontFaceNormal
);
710 for (int i
= 0; i
< 7; i
++)
712 tmp
.Printf(wxT("wxHtmlWindow/FontsSize%i"), i
);
713 p_fontsizes
[i
] = cfg
->Read(tmp
, m_Parser
->m_FontsSizes
[i
]);
715 SetFonts(p_ffn
, p_fff
, p_fontsizes
);
717 if (path
!= wxEmptyString
)
718 cfg
->SetPath(oldpath
);
723 void wxHtmlWindow::WriteCustomization(wxConfigBase
*cfg
, wxString path
)
728 if (path
!= wxEmptyString
)
730 oldpath
= cfg
->GetPath();
734 cfg
->Write(wxT("wxHtmlWindow/Borders"), (long) m_Borders
);
735 cfg
->Write(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser
->m_FontFaceFixed
);
736 cfg
->Write(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser
->m_FontFaceNormal
);
737 for (int i
= 0; i
< 7; i
++)
739 tmp
.Printf(wxT("wxHtmlWindow/FontsSize%i"), i
);
740 cfg
->Write(tmp
, (long) m_Parser
->m_FontsSizes
[i
]);
743 if (path
!= wxEmptyString
)
744 cfg
->SetPath(oldpath
);
749 bool wxHtmlWindow::HistoryBack()
753 if (m_HistoryPos
< 1) return false;
755 // store scroll position into history item:
757 GetViewStart(&x
, &y
);
758 (*m_History
)[m_HistoryPos
].SetPos(y
);
760 // go to previous position:
763 l
= (*m_History
)[m_HistoryPos
].GetPage();
764 a
= (*m_History
)[m_HistoryPos
].GetAnchor();
767 if (a
== wxEmptyString
) LoadPage(l
);
768 else LoadPage(l
+ wxT("#") + a
);
771 Scroll(0, (*m_History
)[m_HistoryPos
].GetPos());
776 bool wxHtmlWindow::HistoryCanBack()
778 if (m_HistoryPos
< 1) return false;
783 bool wxHtmlWindow::HistoryForward()
787 if (m_HistoryPos
== -1) return false;
788 if (m_HistoryPos
>= (int)m_History
->GetCount() - 1)return false;
790 m_OpenedPage
= wxEmptyString
; // this will disable adding new entry into history in LoadPage()
793 l
= (*m_History
)[m_HistoryPos
].GetPage();
794 a
= (*m_History
)[m_HistoryPos
].GetAnchor();
797 if (a
== wxEmptyString
) LoadPage(l
);
798 else LoadPage(l
+ wxT("#") + a
);
801 Scroll(0, (*m_History
)[m_HistoryPos
].GetPos());
806 bool wxHtmlWindow::HistoryCanForward()
808 if (m_HistoryPos
== -1) return false;
809 if (m_HistoryPos
>= (int)m_History
->GetCount() - 1)return false;
814 void wxHtmlWindow::HistoryClear()
820 void wxHtmlWindow::AddProcessor(wxHtmlProcessor
*processor
)
824 m_Processors
= new wxHtmlProcessorList
;
826 wxHtmlProcessorList::compatibility_iterator node
;
828 for (node
= m_Processors
->GetFirst(); node
; node
= node
->GetNext())
830 if (processor
->GetPriority() > node
->GetData()->GetPriority())
832 m_Processors
->Insert(node
, processor
);
836 m_Processors
->Append(processor
);
839 /*static */ void wxHtmlWindow::AddGlobalProcessor(wxHtmlProcessor
*processor
)
841 if (!m_GlobalProcessors
)
843 m_GlobalProcessors
= new wxHtmlProcessorList
;
845 wxHtmlProcessorList::compatibility_iterator node
;
847 for (node
= m_GlobalProcessors
->GetFirst(); node
; node
= node
->GetNext())
849 if (processor
->GetPriority() > node
->GetData()->GetPriority())
851 m_GlobalProcessors
->Insert(node
, processor
);
855 m_GlobalProcessors
->Append(processor
);
860 void wxHtmlWindow::AddFilter(wxHtmlFilter
*filter
)
862 m_Filters
.Append(filter
);
866 bool wxHtmlWindow::IsSelectionEnabled() const
869 return !HasFlag(wxHW_NO_SELECTION
);
877 wxString
wxHtmlWindow::DoSelectionToText(wxHtmlSelection
*sel
)
880 return wxEmptyString
;
884 const wxHtmlCell
*end
= sel
->GetToCell();
886 wxHtmlTerminalCellsInterator
i(sel
->GetFromCell(), end
);
889 text
<< i
->ConvertToText(sel
);
892 const wxHtmlCell
*prev
= *i
;
895 if ( prev
->GetParent() != i
->GetParent() )
897 text
<< i
->ConvertToText(*i
== end
? sel
: NULL
);
904 wxString
wxHtmlWindow::ToText()
909 sel
.Set(m_Cell
->GetFirstTerminal(), m_Cell
->GetLastTerminal());
910 return DoSelectionToText(&sel
);
913 return wxEmptyString
;
916 #endif // wxUSE_CLIPBOARD
918 bool wxHtmlWindow::CopySelection(ClipboardType t
)
923 #if defined(__UNIX__) && !defined(__WXMAC__)
924 wxTheClipboard
->UsePrimarySelection(t
== Primary
);
926 // Primary selection exists only under X11, so don't do anything under
927 // the other platforms when we try to access it
929 // TODO: this should be abstracted at wxClipboard level!
932 #endif // __UNIX__/!__UNIX__
934 if ( wxTheClipboard
->Open() )
936 const wxString
txt(SelectionToText());
937 wxTheClipboard
->SetData(new wxTextDataObject(txt
));
938 wxTheClipboard
->Close();
939 wxLogTrace(_T("wxhtmlselection"),
940 _("Copied to clipboard:\"%s\""), txt
.c_str());
947 #endif // wxUSE_CLIPBOARD
953 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo
& link
)
955 wxHtmlLinkEvent
event(GetId(), link
);
956 event
.SetEventObject(this);
957 if (!GetEventHandler()->ProcessEvent(event
))
959 // the default behaviour is to load the URL in this window
960 const wxMouseEvent
*e
= event
.GetLinkInfo().GetEvent();
961 if (e
== NULL
|| e
->LeftUp())
962 LoadPage(event
.GetLinkInfo().GetHref());
966 void wxHtmlWindow::OnEraseBackground(wxEraseEvent
& event
)
970 // don't even skip the event, if we don't have a bg bitmap we're going
971 // to overwrite background in OnPaint() below anyhow, so letting the
972 // default handling take place would only result in flicker, just set a
973 // flag to erase the background below
974 m_eraseBgInOnPaint
= true;
978 wxDC
& dc
= *event
.GetDC();
980 // if the image is not fully opaque, we have to erase the background before
981 // drawing it, however avoid doing it for opaque images as this would just
982 // result in extra flicker without any other effect as background is
983 // completely covered anyhow
984 if ( m_bmpBg
.GetMask() )
986 dc
.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID
));
990 const wxSize
sizeWin(GetClientSize());
991 const wxSize
sizeBmp(m_bmpBg
.GetWidth(), m_bmpBg
.GetHeight());
992 for ( wxCoord x
= 0; x
< sizeWin
.x
; x
+= sizeBmp
.x
)
994 for ( wxCoord y
= 0; y
< sizeWin
.y
; y
+= sizeBmp
.y
)
996 dc
.DrawBitmap(m_bmpBg
, x
, y
, true /* use mask */);
1001 void wxHtmlWindow::OnPaint(wxPaintEvent
& WXUNUSED(event
))
1005 if (m_tmpCanDrawLocks
> 0 || m_Cell
== NULL
)
1009 GetViewStart(&x
, &y
);
1010 wxRect rect
= GetUpdateRegion().GetBox();
1011 wxSize sz
= GetSize();
1014 if ( !m_backBuffer
)
1015 m_backBuffer
= new wxBitmap(sz
.x
, sz
.y
);
1016 dcm
.SelectObject(*m_backBuffer
);
1018 if ( m_eraseBgInOnPaint
)
1020 dcm
.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID
));
1023 m_eraseBgInOnPaint
= false;
1025 else // someone has already erased the background, keep it
1027 // preserve the existing background, otherwise we'd erase anything the
1028 // user code had drawn in its EVT_ERASE_BACKGROUND handler when we do
1029 // the Blit back below
1030 dcm
.Blit(0, rect
.GetTop(),
1031 sz
.x
, rect
.GetBottom() - rect
.GetTop() + 1,
1037 dcm
.SetMapMode(wxMM_TEXT
);
1038 dcm
.SetBackgroundMode(wxTRANSPARENT
);
1040 wxHtmlRenderingInfo rinfo
;
1041 wxDefaultHtmlRenderingStyle rstyle
;
1042 rinfo
.SetSelection(m_selection
);
1043 rinfo
.SetStyle(&rstyle
);
1044 m_Cell
->Draw(dcm
, 0, 0,
1045 y
* wxHTML_SCROLL_STEP
+ rect
.GetTop(),
1046 y
* wxHTML_SCROLL_STEP
+ rect
.GetBottom(),
1049 //#define DEBUG_HTML_SELECTION
1050 #ifdef DEBUG_HTML_SELECTION
1053 wxGetMousePosition(&xc
, &yc
);
1054 ScreenToClient(&xc
, &yc
);
1055 CalcUnscrolledPosition(xc
, yc
, &x
, &y
);
1056 wxHtmlCell
*at
= m_Cell
->FindCellByPos(x
, y
);
1057 wxHtmlCell
*before
=
1058 m_Cell
->FindCellByPos(x
, y
, wxHTML_FIND_NEAREST_BEFORE
);
1060 m_Cell
->FindCellByPos(x
, y
, wxHTML_FIND_NEAREST_AFTER
);
1062 dcm
.SetBrush(*wxTRANSPARENT_BRUSH
);
1063 dcm
.SetPen(*wxBLACK_PEN
);
1065 dcm
.DrawRectangle(at
->GetAbsPos(),
1066 wxSize(at
->GetWidth(),at
->GetHeight()));
1067 dcm
.SetPen(*wxGREEN_PEN
);
1069 dcm
.DrawRectangle(before
->GetAbsPos().x
+1, before
->GetAbsPos().y
+1,
1070 before
->GetWidth()-2,before
->GetHeight()-2);
1071 dcm
.SetPen(*wxRED_PEN
);
1073 dcm
.DrawRectangle(after
->GetAbsPos().x
+2, after
->GetAbsPos().y
+2,
1074 after
->GetWidth()-4,after
->GetHeight()-4);
1078 dcm
.SetDeviceOrigin(0,0);
1079 dc
.Blit(0, rect
.GetTop(),
1080 sz
.x
, rect
.GetBottom() - rect
.GetTop() + 1,
1088 void wxHtmlWindow::OnSize(wxSizeEvent
& event
)
1090 wxDELETE(m_backBuffer
);
1092 wxScrolledWindow::OnSize(event
);
1095 // Recompute selection if necessary:
1098 m_selection
->Set(m_selection
->GetFromCell(),
1099 m_selection
->GetToCell());
1100 m_selection
->ClearPrivPos();
1107 void wxHtmlWindow::OnMouseMove(wxMouseEvent
& WXUNUSED(event
))
1109 wxHtmlWindowMouseHelper::HandleMouseMoved();
1112 void wxHtmlWindow::OnMouseDown(wxMouseEvent
& event
)
1115 if ( event
.LeftDown() && IsSelectionEnabled() )
1117 const long TRIPLECLICK_LEN
= 200; // 0.2 sec after doubleclick
1118 if ( wxGetLocalTimeMillis() - m_lastDoubleClick
<= TRIPLECLICK_LEN
)
1120 SelectLine(CalcUnscrolledPosition(event
.GetPosition()));
1122 (void) CopySelection();
1126 m_makingSelection
= true;
1130 wxDELETE(m_selection
);
1133 m_tmpSelFromPos
= CalcUnscrolledPosition(event
.GetPosition());
1134 m_tmpSelFromCell
= NULL
;
1141 #endif // wxUSE_CLIPBOARD
1144 void wxHtmlWindow::OnMouseUp(wxMouseEvent
& event
)
1147 if ( m_makingSelection
)
1150 m_makingSelection
= false;
1152 // did the user move the mouse far enough from starting point?
1153 if ( CopySelection(Primary
) )
1155 // we don't want mouse up event that ended selecting to be
1156 // handled as mouse click and e.g. follow hyperlink:
1160 #endif // wxUSE_CLIPBOARD
1164 wxPoint pos
= CalcUnscrolledPosition(event
.GetPosition());
1165 wxHtmlWindowMouseHelper::HandleMouseClick(m_Cell
, pos
, event
);
1169 void wxHtmlWindow::OnMouseCaptureLost(wxMouseCaptureLostEvent
& WXUNUSED(event
))
1171 if ( !m_makingSelection
)
1174 // discard the selecting operation
1175 m_makingSelection
= false;
1176 wxDELETE(m_selection
);
1177 m_tmpSelFromCell
= NULL
;
1180 #endif // wxUSE_CLIPBOARD
1183 void wxHtmlWindow::OnInternalIdle()
1185 wxWindow::OnInternalIdle();
1187 if (m_Cell
!= NULL
&& DidMouseMove())
1189 #ifdef DEBUG_HTML_SELECTION
1193 wxGetMousePosition(&xc
, &yc
);
1194 ScreenToClient(&xc
, &yc
);
1195 CalcUnscrolledPosition(xc
, yc
, &x
, &y
);
1197 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(x
, y
);
1199 // handle selection update:
1200 if ( m_makingSelection
)
1202 if ( !m_tmpSelFromCell
)
1203 m_tmpSelFromCell
= m_Cell
->FindCellByPos(
1204 m_tmpSelFromPos
.x
,m_tmpSelFromPos
.y
);
1206 // NB: a trick - we adjust selFromPos to be upper left or bottom
1207 // right corner of the first cell of the selection depending
1208 // on whether the mouse is moving to the right or to the left.
1209 // This gives us more "natural" behaviour when selecting
1210 // a line (specifically, first cell of the next line is not
1211 // included if you drag selection from left to right over
1214 if ( !m_tmpSelFromCell
)
1216 dirFromPos
= m_tmpSelFromPos
;
1220 dirFromPos
= m_tmpSelFromCell
->GetAbsPos();
1221 if ( x
< m_tmpSelFromPos
.x
)
1223 dirFromPos
.x
+= m_tmpSelFromCell
->GetWidth();
1224 dirFromPos
.y
+= m_tmpSelFromCell
->GetHeight();
1227 bool goingDown
= dirFromPos
.y
< y
||
1228 (dirFromPos
.y
== y
&& dirFromPos
.x
< x
);
1230 // determine selection span:
1231 if ( /*still*/ !m_tmpSelFromCell
)
1235 m_tmpSelFromCell
= m_Cell
->FindCellByPos(
1236 m_tmpSelFromPos
.x
,m_tmpSelFromPos
.y
,
1237 wxHTML_FIND_NEAREST_AFTER
);
1238 if (!m_tmpSelFromCell
)
1239 m_tmpSelFromCell
= m_Cell
->GetFirstTerminal();
1243 m_tmpSelFromCell
= m_Cell
->FindCellByPos(
1244 m_tmpSelFromPos
.x
,m_tmpSelFromPos
.y
,
1245 wxHTML_FIND_NEAREST_BEFORE
);
1246 if (!m_tmpSelFromCell
)
1247 m_tmpSelFromCell
= m_Cell
->GetLastTerminal();
1251 wxHtmlCell
*selcell
= cell
;
1256 selcell
= m_Cell
->FindCellByPos(x
, y
,
1257 wxHTML_FIND_NEAREST_BEFORE
);
1259 selcell
= m_Cell
->GetLastTerminal();
1263 selcell
= m_Cell
->FindCellByPos(x
, y
,
1264 wxHTML_FIND_NEAREST_AFTER
);
1266 selcell
= m_Cell
->GetFirstTerminal();
1270 // NB: it may *rarely* happen that the code above didn't find one
1271 // of the cells, e.g. if wxHtmlWindow doesn't contain any
1273 if ( selcell
&& m_tmpSelFromCell
)
1277 // start selecting only if mouse movement was big enough
1278 // (otherwise it was meant as mouse click, not selection):
1279 const int PRECISION
= 2;
1280 wxPoint diff
= m_tmpSelFromPos
- wxPoint(x
,y
);
1281 if (abs(diff
.x
) > PRECISION
|| abs(diff
.y
) > PRECISION
)
1283 m_selection
= new wxHtmlSelection();
1288 if ( m_tmpSelFromCell
->IsBefore(selcell
) )
1290 m_selection
->Set(m_tmpSelFromPos
, m_tmpSelFromCell
,
1291 wxPoint(x
,y
), selcell
);
1295 m_selection
->Set(wxPoint(x
,y
), selcell
,
1296 m_tmpSelFromPos
, m_tmpSelFromCell
);
1298 m_selection
->ClearPrivPos();
1304 // handle cursor and status bar text changes:
1306 // NB: because we're passing in 'cell' and not 'm_Cell' (so that the
1307 // leaf cell lookup isn't done twice), we need to adjust the
1308 // position for the new root:
1309 wxPoint
posInCell(x
, y
);
1311 posInCell
-= cell
->GetAbsPos();
1312 wxHtmlWindowMouseHelper::HandleIdle(cell
, posInCell
);
1317 void wxHtmlWindow::StopAutoScrolling()
1319 if ( m_timerAutoScroll
)
1321 wxDELETE(m_timerAutoScroll
);
1325 void wxHtmlWindow::OnMouseEnter(wxMouseEvent
& event
)
1327 StopAutoScrolling();
1331 void wxHtmlWindow::OnMouseLeave(wxMouseEvent
& event
)
1333 // don't prevent the usual processing of the event from taking place
1336 // when a captured mouse leave a scrolled window we start generate
1337 // scrolling events to allow, for example, extending selection beyond the
1338 // visible area in some controls
1339 if ( wxWindow::GetCapture() == this )
1341 // where is the mouse leaving?
1343 wxPoint pt
= event
.GetPosition();
1346 orient
= wxHORIZONTAL
;
1349 else if ( pt
.y
< 0 )
1351 orient
= wxVERTICAL
;
1354 else // we're lower or to the right of the window
1356 wxSize size
= GetClientSize();
1357 if ( pt
.x
> size
.x
)
1359 orient
= wxHORIZONTAL
;
1360 pos
= GetVirtualSize().x
/ wxHTML_SCROLL_STEP
;
1362 else if ( pt
.y
> size
.y
)
1364 orient
= wxVERTICAL
;
1365 pos
= GetVirtualSize().y
/ wxHTML_SCROLL_STEP
;
1367 else // this should be impossible
1369 // but seems to happen sometimes under wxMSW - maybe it's a bug
1370 // there but for now just ignore it
1372 //wxFAIL_MSG( _T("can't understand where has mouse gone") );
1378 // only start the auto scroll timer if the window can be scrolled in
1380 if ( !HasScrollbar(orient
) )
1383 delete m_timerAutoScroll
;
1384 m_timerAutoScroll
= new wxHtmlWinAutoScrollTimer
1387 pos
== 0 ? wxEVT_SCROLLWIN_LINEUP
1388 : wxEVT_SCROLLWIN_LINEDOWN
,
1392 m_timerAutoScroll
->Start(50); // FIXME: make configurable
1396 void wxHtmlWindow::OnKeyUp(wxKeyEvent
& event
)
1398 if ( IsSelectionEnabled() &&
1399 (event
.GetKeyCode() == 'C' && event
.CmdDown()) )
1401 wxClipboardTextEvent
evt(wxEVT_COMMAND_TEXT_COPY
, GetId());
1403 evt
.SetEventObject(this);
1405 GetEventHandler()->ProcessEvent(evt
);
1409 void wxHtmlWindow::OnCopy(wxCommandEvent
& WXUNUSED(event
))
1411 (void) CopySelection();
1414 void wxHtmlWindow::OnClipboardEvent(wxClipboardTextEvent
& WXUNUSED(event
))
1416 (void) CopySelection();
1419 void wxHtmlWindow::OnDoubleClick(wxMouseEvent
& event
)
1421 // select word under cursor:
1422 if ( IsSelectionEnabled() )
1424 SelectWord(CalcUnscrolledPosition(event
.GetPosition()));
1426 (void) CopySelection(Primary
);
1428 m_lastDoubleClick
= wxGetLocalTimeMillis();
1434 void wxHtmlWindow::SelectWord(const wxPoint
& pos
)
1438 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(pos
.x
, pos
.y
);
1442 m_selection
= new wxHtmlSelection();
1443 m_selection
->Set(cell
, cell
);
1444 RefreshRect(wxRect(CalcScrolledPosition(cell
->GetAbsPos()),
1445 wxSize(cell
->GetWidth(), cell
->GetHeight())));
1450 void wxHtmlWindow::SelectLine(const wxPoint
& pos
)
1454 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(pos
.x
, pos
.y
);
1457 // We use following heuristic to find a "line": let the line be all
1458 // cells in same container as the cell under mouse cursor that are
1459 // neither completely above nor completely bellow the clicked cell
1460 // (i.e. are likely to be words positioned on same line of text).
1462 int y1
= cell
->GetAbsPos().y
;
1463 int y2
= y1
+ cell
->GetHeight();
1465 const wxHtmlCell
*c
;
1466 const wxHtmlCell
*before
= NULL
;
1467 const wxHtmlCell
*after
= NULL
;
1469 // find last cell of line:
1470 for ( c
= cell
->GetNext(); c
; c
= c
->GetNext())
1472 y
= c
->GetAbsPos().y
;
1473 if ( y
+ c
->GetHeight() > y1
&& y
< y2
)
1481 // find first cell of line:
1482 for ( c
= cell
->GetParent()->GetFirstChild();
1483 c
&& c
!= cell
; c
= c
->GetNext())
1485 y
= c
->GetAbsPos().y
;
1486 if ( y
+ c
->GetHeight() > y1
&& y
< y2
)
1498 m_selection
= new wxHtmlSelection();
1499 m_selection
->Set(before
, after
);
1506 void wxHtmlWindow::SelectAll()
1511 m_selection
= new wxHtmlSelection();
1512 m_selection
->Set(m_Cell
->GetFirstTerminal(), m_Cell
->GetLastTerminal());
1517 #endif // wxUSE_CLIPBOARD
1521 IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor
,wxObject
)
1523 #if wxUSE_EXTENDED_RTTI
1524 IMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow
, wxScrolledWindow
,"wx/html/htmlwin.h")
1526 wxBEGIN_PROPERTIES_TABLE(wxHtmlWindow
)
1529 style , wxHW_SCROLLBAR_AUTO
1530 borders , (dimension)
1534 wxEND_PROPERTIES_TABLE()
1536 wxBEGIN_HANDLERS_TABLE(wxHtmlWindow
)
1537 wxEND_HANDLERS_TABLE()
1539 wxCONSTRUCTOR_5( wxHtmlWindow
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
1541 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow
,wxScrolledWindow
)
1544 BEGIN_EVENT_TABLE(wxHtmlWindow
, wxScrolledWindow
)
1545 EVT_SIZE(wxHtmlWindow::OnSize
)
1546 EVT_LEFT_DOWN(wxHtmlWindow::OnMouseDown
)
1547 EVT_LEFT_UP(wxHtmlWindow::OnMouseUp
)
1548 EVT_RIGHT_UP(wxHtmlWindow::OnMouseUp
)
1549 EVT_MOTION(wxHtmlWindow::OnMouseMove
)
1550 EVT_ERASE_BACKGROUND(wxHtmlWindow::OnEraseBackground
)
1551 EVT_PAINT(wxHtmlWindow::OnPaint
)
1553 EVT_LEFT_DCLICK(wxHtmlWindow::OnDoubleClick
)
1554 EVT_ENTER_WINDOW(wxHtmlWindow::OnMouseEnter
)
1555 EVT_LEAVE_WINDOW(wxHtmlWindow::OnMouseLeave
)
1556 EVT_MOUSE_CAPTURE_LOST(wxHtmlWindow::OnMouseCaptureLost
)
1557 EVT_KEY_UP(wxHtmlWindow::OnKeyUp
)
1558 EVT_MENU(wxID_COPY
, wxHtmlWindow::OnCopy
)
1559 EVT_TEXT_COPY(wxID_ANY
, wxHtmlWindow::OnClipboardEvent
)
1560 #endif // wxUSE_CLIPBOARD
1563 //-----------------------------------------------------------------------------
1564 // wxHtmlWindowInterface implementation in wxHtmlWindow
1565 //-----------------------------------------------------------------------------
1567 void wxHtmlWindow::SetHTMLWindowTitle(const wxString
& title
)
1572 void wxHtmlWindow::OnHTMLLinkClicked(const wxHtmlLinkInfo
& link
)
1574 OnLinkClicked(link
);
1577 wxHtmlOpeningStatus
wxHtmlWindow::OnHTMLOpeningURL(wxHtmlURLType type
,
1578 const wxString
& url
,
1579 wxString
*redirect
) const
1581 return OnOpeningURL(type
, url
, redirect
);
1584 wxPoint
wxHtmlWindow::HTMLCoordsToWindow(wxHtmlCell
*WXUNUSED(cell
),
1585 const wxPoint
& pos
) const
1587 return CalcScrolledPosition(pos
);
1590 wxWindow
* wxHtmlWindow::GetHTMLWindow()
1595 wxColour
wxHtmlWindow::GetHTMLBackgroundColour() const
1597 return GetBackgroundColour();
1600 void wxHtmlWindow::SetHTMLBackgroundColour(const wxColour
& clr
)
1602 SetBackgroundColour(clr
);
1605 void wxHtmlWindow::SetHTMLBackgroundImage(const wxBitmap
& bmpBg
)
1607 SetBackgroundImage(bmpBg
);
1610 void wxHtmlWindow::SetHTMLStatusText(const wxString
& text
)
1613 if (m_RelatedStatusBar
!= -1)
1614 m_RelatedFrame
->SetStatusText(text
, m_RelatedStatusBar
);
1617 #endif // wxUSE_STATUSBAR
1621 wxCursor
wxHtmlWindow::GetDefaultHTMLCursor(HTMLCursor type
)
1625 case HTMLCursor_Link
:
1626 if ( !ms_cursorLink
)
1627 ms_cursorLink
= new wxCursor(wxCURSOR_HAND
);
1628 return *ms_cursorLink
;
1630 case HTMLCursor_Text
:
1631 if ( !ms_cursorText
)
1632 ms_cursorText
= new wxCursor(wxCURSOR_IBEAM
);
1633 return *ms_cursorText
;
1635 case HTMLCursor_Default
:
1637 return *wxSTANDARD_CURSOR
;
1641 wxCursor
wxHtmlWindow::GetHTMLCursor(HTMLCursor type
) const
1643 return GetDefaultHTMLCursor(type
);
1647 //-----------------------------------------------------------------------------
1649 //-----------------------------------------------------------------------------
1651 // A module to allow initialization/cleanup
1652 // without calling these functions from app.cpp or from
1653 // the user's application.
1655 class wxHtmlWinModule
: public wxModule
1657 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule
)
1659 wxHtmlWinModule() : wxModule() {}
1660 bool OnInit() { return true; }
1661 void OnExit() { wxHtmlWindow::CleanUpStatics(); }
1664 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule
, wxModule
)
1667 // This hack forces the linker to always link in m_* files
1668 // (wxHTML doesn't work without handlers from these files)
1669 #include "wx/html/forcelnk.h"
1670 FORCE_WXHTML_MODULES()
1672 #endif // wxUSE_HTML