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());
536 SetHTMLStatusText(wxEmptyString
);
542 wxList::compatibility_iterator node
;
543 wxString src
= wxEmptyString
;
546 if (m_RelatedStatusBar
!= -1)
548 wxString msg
= _("Loading : ") + location
;
549 m_RelatedFrame
->SetStatusText(msg
, m_RelatedStatusBar
);
552 #endif // wxUSE_STATUSBAR
554 node
= m_Filters
.GetFirst();
557 wxHtmlFilter
*h
= (wxHtmlFilter
*) node
->GetData();
560 src
= h
->ReadFile(*f
);
563 node
= node
->GetNext();
565 if (src
== wxEmptyString
)
567 if (m_DefaultFilter
== NULL
) m_DefaultFilter
= GetDefaultFilter();
568 src
= m_DefaultFilter
->ReadFile(*f
);
571 m_FS
->ChangePathTo(f
->GetLocation());
572 rt_val
= SetPage(src
);
573 m_OpenedPage
= f
->GetLocation();
574 if (f
->GetAnchor() != wxEmptyString
)
576 ScrollToAnchor(f
->GetAnchor());
582 if (m_RelatedStatusBar
!= -1)
583 m_RelatedFrame
->SetStatusText(_("Done"), m_RelatedStatusBar
);
584 #endif // wxUSE_STATUSBAR
588 if (m_HistoryOn
) // add this page to history there:
590 int c
= m_History
->GetCount() - (m_HistoryPos
+ 1);
592 if (m_HistoryPos
< 0 ||
593 (*m_History
)[m_HistoryPos
].GetPage() != m_OpenedPage
||
594 (*m_History
)[m_HistoryPos
].GetAnchor() != m_OpenedAnchor
)
597 for (int i
= 0; i
< c
; i
++)
598 m_History
->RemoveAt(m_HistoryPos
);
599 m_History
->Add(new wxHtmlHistoryItem(m_OpenedPage
, m_OpenedAnchor
));
603 if (m_OpenedPageTitle
== wxEmptyString
)
604 OnSetTitle(wxFileNameFromPath(m_OpenedPage
));
618 bool wxHtmlWindow::LoadFile(const wxFileName
& filename
)
620 wxString url
= wxFileSystem::FileNameToURL(filename
);
621 return LoadPage(url
);
625 bool wxHtmlWindow::ScrollToAnchor(const wxString
& anchor
)
627 const wxHtmlCell
*c
= m_Cell
->Find(wxHTML_COND_ISANCHOR
, &anchor
);
630 wxLogWarning(_("HTML anchor %s does not exist."), anchor
.c_str());
637 for (y
= 0; c
!= NULL
; c
= c
->GetParent()) y
+= c
->GetPosY();
638 Scroll(-1, y
/ wxHTML_SCROLL_STEP
);
639 m_OpenedAnchor
= anchor
;
645 void wxHtmlWindow::OnSetTitle(const wxString
& title
)
650 tit
.Printf(m_TitleFormat
, title
.c_str());
651 m_RelatedFrame
->SetTitle(tit
);
653 m_OpenedPageTitle
= title
;
660 void wxHtmlWindow::CreateLayout()
662 int ClientWidth
, ClientHeight
;
666 if ( HasFlag(wxHW_SCROLLBAR_NEVER
) )
668 SetScrollbars(1, 1, 0, 0); // always off
669 GetClientSize(&ClientWidth
, &ClientHeight
);
670 m_Cell
->Layout(ClientWidth
);
672 else // !wxHW_SCROLLBAR_NEVER
674 GetClientSize(&ClientWidth
, &ClientHeight
);
675 m_Cell
->Layout(ClientWidth
);
676 if (ClientHeight
< m_Cell
->GetHeight() + GetCharHeight())
679 wxHTML_SCROLL_STEP
, wxHTML_SCROLL_STEP
,
680 m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
,
681 (m_Cell
->GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
682 /*cheat: top-level frag is always container*/);
684 else /* we fit into window, no need for scrollbars */
686 SetScrollbars(wxHTML_SCROLL_STEP
, 1, m_Cell
->GetWidth() / wxHTML_SCROLL_STEP
, 0); // disable...
687 GetClientSize(&ClientWidth
, &ClientHeight
);
688 m_Cell
->Layout(ClientWidth
); // ...and relayout
695 void wxHtmlWindow::ReadCustomization(wxConfigBase
*cfg
, wxString path
)
700 wxString p_fff
, p_ffn
;
702 if (path
!= wxEmptyString
)
704 oldpath
= cfg
->GetPath();
708 m_Borders
= cfg
->Read(wxT("wxHtmlWindow/Borders"), m_Borders
);
709 p_fff
= cfg
->Read(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser
->m_FontFaceFixed
);
710 p_ffn
= cfg
->Read(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser
->m_FontFaceNormal
);
711 for (int i
= 0; i
< 7; i
++)
713 tmp
.Printf(wxT("wxHtmlWindow/FontsSize%i"), i
);
714 p_fontsizes
[i
] = cfg
->Read(tmp
, m_Parser
->m_FontsSizes
[i
]);
716 SetFonts(p_ffn
, p_fff
, p_fontsizes
);
718 if (path
!= wxEmptyString
)
719 cfg
->SetPath(oldpath
);
724 void wxHtmlWindow::WriteCustomization(wxConfigBase
*cfg
, wxString path
)
729 if (path
!= wxEmptyString
)
731 oldpath
= cfg
->GetPath();
735 cfg
->Write(wxT("wxHtmlWindow/Borders"), (long) m_Borders
);
736 cfg
->Write(wxT("wxHtmlWindow/FontFaceFixed"), m_Parser
->m_FontFaceFixed
);
737 cfg
->Write(wxT("wxHtmlWindow/FontFaceNormal"), m_Parser
->m_FontFaceNormal
);
738 for (int i
= 0; i
< 7; i
++)
740 tmp
.Printf(wxT("wxHtmlWindow/FontsSize%i"), i
);
741 cfg
->Write(tmp
, (long) m_Parser
->m_FontsSizes
[i
]);
744 if (path
!= wxEmptyString
)
745 cfg
->SetPath(oldpath
);
750 bool wxHtmlWindow::HistoryBack()
754 if (m_HistoryPos
< 1) return false;
756 // store scroll position into history item:
758 GetViewStart(&x
, &y
);
759 (*m_History
)[m_HistoryPos
].SetPos(y
);
761 // go to previous position:
764 l
= (*m_History
)[m_HistoryPos
].GetPage();
765 a
= (*m_History
)[m_HistoryPos
].GetAnchor();
768 if (a
== wxEmptyString
) LoadPage(l
);
769 else LoadPage(l
+ wxT("#") + a
);
772 Scroll(0, (*m_History
)[m_HistoryPos
].GetPos());
777 bool wxHtmlWindow::HistoryCanBack()
779 if (m_HistoryPos
< 1) return false;
784 bool wxHtmlWindow::HistoryForward()
788 if (m_HistoryPos
== -1) return false;
789 if (m_HistoryPos
>= (int)m_History
->GetCount() - 1)return false;
791 m_OpenedPage
= wxEmptyString
; // this will disable adding new entry into history in LoadPage()
794 l
= (*m_History
)[m_HistoryPos
].GetPage();
795 a
= (*m_History
)[m_HistoryPos
].GetAnchor();
798 if (a
== wxEmptyString
) LoadPage(l
);
799 else LoadPage(l
+ wxT("#") + a
);
802 Scroll(0, (*m_History
)[m_HistoryPos
].GetPos());
807 bool wxHtmlWindow::HistoryCanForward()
809 if (m_HistoryPos
== -1) return false;
810 if (m_HistoryPos
>= (int)m_History
->GetCount() - 1)return false;
815 void wxHtmlWindow::HistoryClear()
821 void wxHtmlWindow::AddProcessor(wxHtmlProcessor
*processor
)
825 m_Processors
= new wxHtmlProcessorList
;
827 wxHtmlProcessorList::compatibility_iterator node
;
829 for (node
= m_Processors
->GetFirst(); node
; node
= node
->GetNext())
831 if (processor
->GetPriority() > node
->GetData()->GetPriority())
833 m_Processors
->Insert(node
, processor
);
837 m_Processors
->Append(processor
);
840 /*static */ void wxHtmlWindow::AddGlobalProcessor(wxHtmlProcessor
*processor
)
842 if (!m_GlobalProcessors
)
844 m_GlobalProcessors
= new wxHtmlProcessorList
;
846 wxHtmlProcessorList::compatibility_iterator node
;
848 for (node
= m_GlobalProcessors
->GetFirst(); node
; node
= node
->GetNext())
850 if (processor
->GetPriority() > node
->GetData()->GetPriority())
852 m_GlobalProcessors
->Insert(node
, processor
);
856 m_GlobalProcessors
->Append(processor
);
861 void wxHtmlWindow::AddFilter(wxHtmlFilter
*filter
)
863 m_Filters
.Append(filter
);
867 bool wxHtmlWindow::IsSelectionEnabled() const
870 return !HasFlag(wxHW_NO_SELECTION
);
878 wxString
wxHtmlWindow::DoSelectionToText(wxHtmlSelection
*sel
)
881 return wxEmptyString
;
885 const wxHtmlCell
*end
= sel
->GetToCell();
887 wxHtmlTerminalCellsInterator
i(sel
->GetFromCell(), end
);
890 text
<< i
->ConvertToText(sel
);
893 const wxHtmlCell
*prev
= *i
;
896 if ( prev
->GetParent() != i
->GetParent() )
898 text
<< i
->ConvertToText(*i
== end
? sel
: NULL
);
905 wxString
wxHtmlWindow::ToText()
910 sel
.Set(m_Cell
->GetFirstTerminal(), m_Cell
->GetLastTerminal());
911 return DoSelectionToText(&sel
);
914 return wxEmptyString
;
917 #endif // wxUSE_CLIPBOARD
919 bool wxHtmlWindow::CopySelection(ClipboardType t
)
924 #if defined(__UNIX__) && !defined(__WXMAC__)
925 wxTheClipboard
->UsePrimarySelection(t
== Primary
);
927 // Primary selection exists only under X11, so don't do anything under
928 // the other platforms when we try to access it
930 // TODO: this should be abstracted at wxClipboard level!
933 #endif // __UNIX__/!__UNIX__
935 if ( wxTheClipboard
->Open() )
937 const wxString
txt(SelectionToText());
938 wxTheClipboard
->SetData(new wxTextDataObject(txt
));
939 wxTheClipboard
->Close();
940 wxLogTrace(_T("wxhtmlselection"),
941 _("Copied to clipboard:\"%s\""), txt
.c_str());
948 #endif // wxUSE_CLIPBOARD
954 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo
& link
)
956 wxHtmlLinkEvent
event(GetId(), link
);
957 event
.SetEventObject(this);
958 if (!GetEventHandler()->ProcessEvent(event
))
960 // the default behaviour is to load the URL in this window
961 const wxMouseEvent
*e
= event
.GetLinkInfo().GetEvent();
962 if (e
== NULL
|| e
->LeftUp())
963 LoadPage(event
.GetLinkInfo().GetHref());
967 void wxHtmlWindow::OnEraseBackground(wxEraseEvent
& event
)
971 // don't even skip the event, if we don't have a bg bitmap we're going
972 // to overwrite background in OnPaint() below anyhow, so letting the
973 // default handling take place would only result in flicker, just set a
974 // flag to erase the background below
975 m_eraseBgInOnPaint
= true;
979 wxDC
& dc
= *event
.GetDC();
981 // if the image is not fully opaque, we have to erase the background before
982 // drawing it, however avoid doing it for opaque images as this would just
983 // result in extra flicker without any other effect as background is
984 // completely covered anyhow
985 if ( m_bmpBg
.GetMask() )
987 dc
.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID
));
991 const wxSize
sizeWin(GetClientSize());
992 const wxSize
sizeBmp(m_bmpBg
.GetWidth(), m_bmpBg
.GetHeight());
993 for ( wxCoord x
= 0; x
< sizeWin
.x
; x
+= sizeBmp
.x
)
995 for ( wxCoord y
= 0; y
< sizeWin
.y
; y
+= sizeBmp
.y
)
997 dc
.DrawBitmap(m_bmpBg
, x
, y
, true /* use mask */);
1002 void wxHtmlWindow::OnPaint(wxPaintEvent
& WXUNUSED(event
))
1006 if (m_tmpCanDrawLocks
> 0 || m_Cell
== NULL
)
1010 GetViewStart(&x
, &y
);
1011 wxRect rect
= GetUpdateRegion().GetBox();
1012 wxSize sz
= GetSize();
1015 if ( !m_backBuffer
)
1016 m_backBuffer
= new wxBitmap(sz
.x
, sz
.y
);
1017 dcm
.SelectObject(*m_backBuffer
);
1019 if ( m_eraseBgInOnPaint
)
1021 dcm
.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID
));
1024 m_eraseBgInOnPaint
= false;
1026 else // someone has already erased the background, keep it
1028 // preserve the existing background, otherwise we'd erase anything the
1029 // user code had drawn in its EVT_ERASE_BACKGROUND handler when we do
1030 // the Blit back below
1031 dcm
.Blit(0, rect
.GetTop(),
1032 sz
.x
, rect
.GetBottom() - rect
.GetTop() + 1,
1038 dcm
.SetMapMode(wxMM_TEXT
);
1039 dcm
.SetBackgroundMode(wxTRANSPARENT
);
1041 wxHtmlRenderingInfo rinfo
;
1042 wxDefaultHtmlRenderingStyle rstyle
;
1043 rinfo
.SetSelection(m_selection
);
1044 rinfo
.SetStyle(&rstyle
);
1045 m_Cell
->Draw(dcm
, 0, 0,
1046 y
* wxHTML_SCROLL_STEP
+ rect
.GetTop(),
1047 y
* wxHTML_SCROLL_STEP
+ rect
.GetBottom(),
1050 //#define DEBUG_HTML_SELECTION
1051 #ifdef DEBUG_HTML_SELECTION
1054 wxGetMousePosition(&xc
, &yc
);
1055 ScreenToClient(&xc
, &yc
);
1056 CalcUnscrolledPosition(xc
, yc
, &x
, &y
);
1057 wxHtmlCell
*at
= m_Cell
->FindCellByPos(x
, y
);
1058 wxHtmlCell
*before
=
1059 m_Cell
->FindCellByPos(x
, y
, wxHTML_FIND_NEAREST_BEFORE
);
1061 m_Cell
->FindCellByPos(x
, y
, wxHTML_FIND_NEAREST_AFTER
);
1063 dcm
.SetBrush(*wxTRANSPARENT_BRUSH
);
1064 dcm
.SetPen(*wxBLACK_PEN
);
1066 dcm
.DrawRectangle(at
->GetAbsPos(),
1067 wxSize(at
->GetWidth(),at
->GetHeight()));
1068 dcm
.SetPen(*wxGREEN_PEN
);
1070 dcm
.DrawRectangle(before
->GetAbsPos().x
+1, before
->GetAbsPos().y
+1,
1071 before
->GetWidth()-2,before
->GetHeight()-2);
1072 dcm
.SetPen(*wxRED_PEN
);
1074 dcm
.DrawRectangle(after
->GetAbsPos().x
+2, after
->GetAbsPos().y
+2,
1075 after
->GetWidth()-4,after
->GetHeight()-4);
1079 dcm
.SetDeviceOrigin(0,0);
1080 dc
.Blit(0, rect
.GetTop(),
1081 sz
.x
, rect
.GetBottom() - rect
.GetTop() + 1,
1089 void wxHtmlWindow::OnSize(wxSizeEvent
& event
)
1091 wxDELETE(m_backBuffer
);
1093 wxScrolledWindow::OnSize(event
);
1096 // Recompute selection if necessary:
1099 m_selection
->Set(m_selection
->GetFromCell(),
1100 m_selection
->GetToCell());
1101 m_selection
->ClearPrivPos();
1108 void wxHtmlWindow::OnMouseMove(wxMouseEvent
& WXUNUSED(event
))
1110 wxHtmlWindowMouseHelper::HandleMouseMoved();
1113 void wxHtmlWindow::OnMouseDown(wxMouseEvent
& event
)
1116 if ( event
.LeftDown() && IsSelectionEnabled() )
1118 const long TRIPLECLICK_LEN
= 200; // 0.2 sec after doubleclick
1119 if ( wxGetLocalTimeMillis() - m_lastDoubleClick
<= TRIPLECLICK_LEN
)
1121 SelectLine(CalcUnscrolledPosition(event
.GetPosition()));
1123 (void) CopySelection();
1127 m_makingSelection
= true;
1131 wxDELETE(m_selection
);
1134 m_tmpSelFromPos
= CalcUnscrolledPosition(event
.GetPosition());
1135 m_tmpSelFromCell
= NULL
;
1140 #endif // wxUSE_CLIPBOARD
1142 // in any case, let the default handler set focus to this window
1146 void wxHtmlWindow::OnMouseUp(wxMouseEvent
& event
)
1149 if ( m_makingSelection
)
1152 m_makingSelection
= false;
1154 // if m_selection=NULL, the user didn't move the mouse far enough from
1155 // starting point and the mouse up event is part of a click, the user
1156 // is not selecting text:
1159 CopySelection(Primary
);
1161 // we don't want mouse up event that ended selecting to be
1162 // handled as mouse click and e.g. follow hyperlink:
1166 #endif // wxUSE_CLIPBOARD
1168 wxPoint pos
= CalcUnscrolledPosition(event
.GetPosition());
1169 wxHtmlWindowMouseHelper::HandleMouseClick(m_Cell
, pos
, event
);
1173 void wxHtmlWindow::OnMouseCaptureLost(wxMouseCaptureLostEvent
& WXUNUSED(event
))
1175 if ( !m_makingSelection
)
1178 // discard the selecting operation
1179 m_makingSelection
= false;
1180 wxDELETE(m_selection
);
1181 m_tmpSelFromCell
= NULL
;
1184 #endif // wxUSE_CLIPBOARD
1187 void wxHtmlWindow::OnInternalIdle()
1189 wxWindow::OnInternalIdle();
1191 if (m_Cell
!= NULL
&& DidMouseMove())
1193 #ifdef DEBUG_HTML_SELECTION
1197 wxGetMousePosition(&xc
, &yc
);
1198 ScreenToClient(&xc
, &yc
);
1199 CalcUnscrolledPosition(xc
, yc
, &x
, &y
);
1201 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(x
, y
);
1203 // handle selection update:
1204 if ( m_makingSelection
)
1206 if ( !m_tmpSelFromCell
)
1207 m_tmpSelFromCell
= m_Cell
->FindCellByPos(
1208 m_tmpSelFromPos
.x
,m_tmpSelFromPos
.y
);
1210 // NB: a trick - we adjust selFromPos to be upper left or bottom
1211 // right corner of the first cell of the selection depending
1212 // on whether the mouse is moving to the right or to the left.
1213 // This gives us more "natural" behaviour when selecting
1214 // a line (specifically, first cell of the next line is not
1215 // included if you drag selection from left to right over
1218 if ( !m_tmpSelFromCell
)
1220 dirFromPos
= m_tmpSelFromPos
;
1224 dirFromPos
= m_tmpSelFromCell
->GetAbsPos();
1225 if ( x
< m_tmpSelFromPos
.x
)
1227 dirFromPos
.x
+= m_tmpSelFromCell
->GetWidth();
1228 dirFromPos
.y
+= m_tmpSelFromCell
->GetHeight();
1231 bool goingDown
= dirFromPos
.y
< y
||
1232 (dirFromPos
.y
== y
&& dirFromPos
.x
< x
);
1234 // determine selection span:
1235 if ( /*still*/ !m_tmpSelFromCell
)
1239 m_tmpSelFromCell
= m_Cell
->FindCellByPos(
1240 m_tmpSelFromPos
.x
,m_tmpSelFromPos
.y
,
1241 wxHTML_FIND_NEAREST_AFTER
);
1242 if (!m_tmpSelFromCell
)
1243 m_tmpSelFromCell
= m_Cell
->GetFirstTerminal();
1247 m_tmpSelFromCell
= m_Cell
->FindCellByPos(
1248 m_tmpSelFromPos
.x
,m_tmpSelFromPos
.y
,
1249 wxHTML_FIND_NEAREST_BEFORE
);
1250 if (!m_tmpSelFromCell
)
1251 m_tmpSelFromCell
= m_Cell
->GetLastTerminal();
1255 wxHtmlCell
*selcell
= cell
;
1260 selcell
= m_Cell
->FindCellByPos(x
, y
,
1261 wxHTML_FIND_NEAREST_BEFORE
);
1263 selcell
= m_Cell
->GetLastTerminal();
1267 selcell
= m_Cell
->FindCellByPos(x
, y
,
1268 wxHTML_FIND_NEAREST_AFTER
);
1270 selcell
= m_Cell
->GetFirstTerminal();
1274 // NB: it may *rarely* happen that the code above didn't find one
1275 // of the cells, e.g. if wxHtmlWindow doesn't contain any
1277 if ( selcell
&& m_tmpSelFromCell
)
1281 // start selecting only if mouse movement was big enough
1282 // (otherwise it was meant as mouse click, not selection):
1283 const int PRECISION
= 2;
1284 wxPoint diff
= m_tmpSelFromPos
- wxPoint(x
,y
);
1285 if (abs(diff
.x
) > PRECISION
|| abs(diff
.y
) > PRECISION
)
1287 m_selection
= new wxHtmlSelection();
1292 if ( m_tmpSelFromCell
->IsBefore(selcell
) )
1294 m_selection
->Set(m_tmpSelFromPos
, m_tmpSelFromCell
,
1295 wxPoint(x
,y
), selcell
);
1299 m_selection
->Set(wxPoint(x
,y
), selcell
,
1300 m_tmpSelFromPos
, m_tmpSelFromCell
);
1302 m_selection
->ClearPrivPos();
1308 // handle cursor and status bar text changes:
1310 // NB: because we're passing in 'cell' and not 'm_Cell' (so that the
1311 // leaf cell lookup isn't done twice), we need to adjust the
1312 // position for the new root:
1313 wxPoint
posInCell(x
, y
);
1315 posInCell
-= cell
->GetAbsPos();
1316 wxHtmlWindowMouseHelper::HandleIdle(cell
, posInCell
);
1321 void wxHtmlWindow::StopAutoScrolling()
1323 if ( m_timerAutoScroll
)
1325 wxDELETE(m_timerAutoScroll
);
1329 void wxHtmlWindow::OnMouseEnter(wxMouseEvent
& event
)
1331 StopAutoScrolling();
1335 void wxHtmlWindow::OnMouseLeave(wxMouseEvent
& event
)
1337 // don't prevent the usual processing of the event from taking place
1340 // when a captured mouse leave a scrolled window we start generate
1341 // scrolling events to allow, for example, extending selection beyond the
1342 // visible area in some controls
1343 if ( wxWindow::GetCapture() == this )
1345 // where is the mouse leaving?
1347 wxPoint pt
= event
.GetPosition();
1350 orient
= wxHORIZONTAL
;
1353 else if ( pt
.y
< 0 )
1355 orient
= wxVERTICAL
;
1358 else // we're lower or to the right of the window
1360 wxSize size
= GetClientSize();
1361 if ( pt
.x
> size
.x
)
1363 orient
= wxHORIZONTAL
;
1364 pos
= GetVirtualSize().x
/ wxHTML_SCROLL_STEP
;
1366 else if ( pt
.y
> size
.y
)
1368 orient
= wxVERTICAL
;
1369 pos
= GetVirtualSize().y
/ wxHTML_SCROLL_STEP
;
1371 else // this should be impossible
1373 // but seems to happen sometimes under wxMSW - maybe it's a bug
1374 // there but for now just ignore it
1376 //wxFAIL_MSG( _T("can't understand where has mouse gone") );
1382 // only start the auto scroll timer if the window can be scrolled in
1384 if ( !HasScrollbar(orient
) )
1387 delete m_timerAutoScroll
;
1388 m_timerAutoScroll
= new wxHtmlWinAutoScrollTimer
1391 pos
== 0 ? wxEVT_SCROLLWIN_LINEUP
1392 : wxEVT_SCROLLWIN_LINEDOWN
,
1396 m_timerAutoScroll
->Start(50); // FIXME: make configurable
1400 void wxHtmlWindow::OnKeyUp(wxKeyEvent
& event
)
1402 if ( IsSelectionEnabled() &&
1403 (event
.GetKeyCode() == 'C' && event
.CmdDown()) )
1405 wxClipboardTextEvent
evt(wxEVT_COMMAND_TEXT_COPY
, GetId());
1407 evt
.SetEventObject(this);
1409 GetEventHandler()->ProcessEvent(evt
);
1413 void wxHtmlWindow::OnCopy(wxCommandEvent
& WXUNUSED(event
))
1415 (void) CopySelection();
1418 void wxHtmlWindow::OnClipboardEvent(wxClipboardTextEvent
& WXUNUSED(event
))
1420 (void) CopySelection();
1423 void wxHtmlWindow::OnDoubleClick(wxMouseEvent
& event
)
1425 // select word under cursor:
1426 if ( IsSelectionEnabled() )
1428 SelectWord(CalcUnscrolledPosition(event
.GetPosition()));
1430 (void) CopySelection(Primary
);
1432 m_lastDoubleClick
= wxGetLocalTimeMillis();
1438 void wxHtmlWindow::SelectWord(const wxPoint
& pos
)
1442 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(pos
.x
, pos
.y
);
1446 m_selection
= new wxHtmlSelection();
1447 m_selection
->Set(cell
, cell
);
1448 RefreshRect(wxRect(CalcScrolledPosition(cell
->GetAbsPos()),
1449 wxSize(cell
->GetWidth(), cell
->GetHeight())));
1454 void wxHtmlWindow::SelectLine(const wxPoint
& pos
)
1458 wxHtmlCell
*cell
= m_Cell
->FindCellByPos(pos
.x
, pos
.y
);
1461 // We use following heuristic to find a "line": let the line be all
1462 // cells in same container as the cell under mouse cursor that are
1463 // neither completely above nor completely bellow the clicked cell
1464 // (i.e. are likely to be words positioned on same line of text).
1466 int y1
= cell
->GetAbsPos().y
;
1467 int y2
= y1
+ cell
->GetHeight();
1469 const wxHtmlCell
*c
;
1470 const wxHtmlCell
*before
= NULL
;
1471 const wxHtmlCell
*after
= NULL
;
1473 // find last cell of line:
1474 for ( c
= cell
->GetNext(); c
; c
= c
->GetNext())
1476 y
= c
->GetAbsPos().y
;
1477 if ( y
+ c
->GetHeight() > y1
&& y
< y2
)
1485 // find first cell of line:
1486 for ( c
= cell
->GetParent()->GetFirstChild();
1487 c
&& c
!= cell
; c
= c
->GetNext())
1489 y
= c
->GetAbsPos().y
;
1490 if ( y
+ c
->GetHeight() > y1
&& y
< y2
)
1502 m_selection
= new wxHtmlSelection();
1503 m_selection
->Set(before
, after
);
1510 void wxHtmlWindow::SelectAll()
1515 m_selection
= new wxHtmlSelection();
1516 m_selection
->Set(m_Cell
->GetFirstTerminal(), m_Cell
->GetLastTerminal());
1521 #endif // wxUSE_CLIPBOARD
1525 IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor
,wxObject
)
1527 #if wxUSE_EXTENDED_RTTI
1528 IMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow
, wxScrolledWindow
,"wx/html/htmlwin.h")
1530 wxBEGIN_PROPERTIES_TABLE(wxHtmlWindow
)
1533 style , wxHW_SCROLLBAR_AUTO
1534 borders , (dimension)
1538 wxEND_PROPERTIES_TABLE()
1540 wxBEGIN_HANDLERS_TABLE(wxHtmlWindow
)
1541 wxEND_HANDLERS_TABLE()
1543 wxCONSTRUCTOR_5( wxHtmlWindow
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
1545 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow
,wxScrolledWindow
)
1548 BEGIN_EVENT_TABLE(wxHtmlWindow
, wxScrolledWindow
)
1549 EVT_SIZE(wxHtmlWindow::OnSize
)
1550 EVT_LEFT_DOWN(wxHtmlWindow::OnMouseDown
)
1551 EVT_LEFT_UP(wxHtmlWindow::OnMouseUp
)
1552 EVT_RIGHT_UP(wxHtmlWindow::OnMouseUp
)
1553 EVT_MOTION(wxHtmlWindow::OnMouseMove
)
1554 EVT_ERASE_BACKGROUND(wxHtmlWindow::OnEraseBackground
)
1555 EVT_PAINT(wxHtmlWindow::OnPaint
)
1557 EVT_LEFT_DCLICK(wxHtmlWindow::OnDoubleClick
)
1558 EVT_ENTER_WINDOW(wxHtmlWindow::OnMouseEnter
)
1559 EVT_LEAVE_WINDOW(wxHtmlWindow::OnMouseLeave
)
1560 EVT_MOUSE_CAPTURE_LOST(wxHtmlWindow::OnMouseCaptureLost
)
1561 EVT_KEY_UP(wxHtmlWindow::OnKeyUp
)
1562 EVT_MENU(wxID_COPY
, wxHtmlWindow::OnCopy
)
1563 EVT_TEXT_COPY(wxID_ANY
, wxHtmlWindow::OnClipboardEvent
)
1564 #endif // wxUSE_CLIPBOARD
1567 //-----------------------------------------------------------------------------
1568 // wxHtmlWindowInterface implementation in wxHtmlWindow
1569 //-----------------------------------------------------------------------------
1571 void wxHtmlWindow::SetHTMLWindowTitle(const wxString
& title
)
1576 void wxHtmlWindow::OnHTMLLinkClicked(const wxHtmlLinkInfo
& link
)
1578 OnLinkClicked(link
);
1581 wxHtmlOpeningStatus
wxHtmlWindow::OnHTMLOpeningURL(wxHtmlURLType type
,
1582 const wxString
& url
,
1583 wxString
*redirect
) const
1585 return OnOpeningURL(type
, url
, redirect
);
1588 wxPoint
wxHtmlWindow::HTMLCoordsToWindow(wxHtmlCell
*WXUNUSED(cell
),
1589 const wxPoint
& pos
) const
1591 return CalcScrolledPosition(pos
);
1594 wxWindow
* wxHtmlWindow::GetHTMLWindow()
1599 wxColour
wxHtmlWindow::GetHTMLBackgroundColour() const
1601 return GetBackgroundColour();
1604 void wxHtmlWindow::SetHTMLBackgroundColour(const wxColour
& clr
)
1606 SetBackgroundColour(clr
);
1609 void wxHtmlWindow::SetHTMLBackgroundImage(const wxBitmap
& bmpBg
)
1611 SetBackgroundImage(bmpBg
);
1614 void wxHtmlWindow::SetHTMLStatusText(const wxString
& text
)
1617 if (m_RelatedStatusBar
!= -1)
1618 m_RelatedFrame
->SetStatusText(text
, m_RelatedStatusBar
);
1621 #endif // wxUSE_STATUSBAR
1625 wxCursor
wxHtmlWindow::GetDefaultHTMLCursor(HTMLCursor type
)
1629 case HTMLCursor_Link
:
1630 if ( !ms_cursorLink
)
1631 ms_cursorLink
= new wxCursor(wxCURSOR_HAND
);
1632 return *ms_cursorLink
;
1634 case HTMLCursor_Text
:
1635 if ( !ms_cursorText
)
1636 ms_cursorText
= new wxCursor(wxCURSOR_IBEAM
);
1637 return *ms_cursorText
;
1639 case HTMLCursor_Default
:
1641 return *wxSTANDARD_CURSOR
;
1645 wxCursor
wxHtmlWindow::GetHTMLCursor(HTMLCursor type
) const
1647 return GetDefaultHTMLCursor(type
);
1651 //-----------------------------------------------------------------------------
1653 //-----------------------------------------------------------------------------
1655 // A module to allow initialization/cleanup
1656 // without calling these functions from app.cpp or from
1657 // the user's application.
1659 class wxHtmlWinModule
: public wxModule
1661 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule
)
1663 wxHtmlWinModule() : wxModule() {}
1664 bool OnInit() { return true; }
1665 void OnExit() { wxHtmlWindow::CleanUpStatics(); }
1668 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule
, wxModule
)
1671 // This hack forces the linker to always link in m_* files
1672 // (wxHTML doesn't work without handlers from these files)
1673 #include "wx/html/forcelnk.h"
1674 FORCE_WXHTML_MODULES()
1676 #endif // wxUSE_HTML