X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/abe64011cd00b0e9d7fd20b2c66cbd48636c4f75..51ec29ea5d1d1093bafbae27a8483211a90d9659:/src/html/htmlwin.cpp diff --git a/src/html/htmlwin.cpp b/src/html/htmlwin.cpp index 7654b4b862..2ed020e48e 100644 --- a/src/html/htmlwin.cpp +++ b/src/html/htmlwin.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: htmlwin.cpp +// Name: src/html/htmlwin.cpp // Purpose: wxHtmlWindow class for parsing & displaying HTML (implementation) // Author: Vaclav Slavik // RCS-ID: $Id$ @@ -9,32 +9,44 @@ #include "wx/wxprec.h" -#include "wx/defs.h" -#if wxUSE_HTML && wxUSE_STREAMS - #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#ifndef WXPRECOMP +#if wxUSE_HTML && wxUSE_STREAMS + +#ifndef WX_PRECOMP + #include "wx/list.h" #include "wx/log.h" #include "wx/intl.h" #include "wx/dcclient.h" #include "wx/frame.h" + #include "wx/dcmemory.h" + #include "wx/timer.h" + #include "wx/settings.h" + #include "wx/dataobj.h" + #include "wx/statusbr.h" #endif #include "wx/html/htmlwin.h" #include "wx/html/htmlproc.h" -#include "wx/list.h" #include "wx/clipbrd.h" -#include "wx/dataobj.h" -#include "wx/timer.h" -#include "wx/dcmemory.h" -#include "wx/settings.h" +#include "wx/recguard.h" #include "wx/arrimpl.cpp" #include "wx/listimpl.cpp" +// uncomment this line to visually show the extent of the selection +//#define DEBUG_HTML_SELECTION + +// HTML events: +IMPLEMENT_DYNAMIC_CLASS(wxHtmlLinkEvent, wxCommandEvent) +IMPLEMENT_DYNAMIC_CLASS(wxHtmlCellEvent, wxCommandEvent) + +wxDEFINE_EVENT( wxEVT_COMMAND_HTML_CELL_CLICKED, wxHtmlCellEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_HTML_CELL_HOVER, wxHtmlCellEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_HTML_LINK_CLICKED, wxHtmlLinkEvent ); + #if wxUSE_CLIPBOARD // ---------------------------------------------------------------------------- @@ -63,7 +75,7 @@ private: int m_pos, m_orient; - DECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer) + wxDECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer); }; void wxHtmlWinAutoScrollTimer::Notify() @@ -140,20 +152,152 @@ WX_DEFINE_OBJARRAY(wxHtmlHistoryArray) WX_DECLARE_LIST(wxHtmlProcessor, wxHtmlProcessorList); WX_DEFINE_LIST(wxHtmlProcessorList) +//----------------------------------------------------------------------------- +// wxHtmlWindowMouseHelper +//----------------------------------------------------------------------------- + +wxHtmlWindowMouseHelper::wxHtmlWindowMouseHelper(wxHtmlWindowInterface *iface) + : m_tmpMouseMoved(false), + m_tmpLastLink(NULL), + m_tmpLastCell(NULL), + m_interface(iface) +{ +} + +void wxHtmlWindowMouseHelper::HandleMouseMoved() +{ + m_tmpMouseMoved = true; +} + +bool wxHtmlWindowMouseHelper::HandleMouseClick(wxHtmlCell *rootCell, + const wxPoint& pos, + const wxMouseEvent& event) +{ + if (!rootCell) + return false; + + wxHtmlCell *cell = rootCell->FindCellByPos(pos.x, pos.y); + // this check is needed because FindCellByPos returns terminal cell and + // containers may have empty borders -- in this case NULL will be + // returned + if (!cell) + return false; + + // adjust the coordinates to be relative to this cell: + wxPoint relpos = pos - cell->GetAbsPos(rootCell); + + return OnCellClicked(cell, relpos.x, relpos.y, event); +} + +void wxHtmlWindowMouseHelper::HandleIdle(wxHtmlCell *rootCell, + const wxPoint& pos) +{ + wxHtmlCell *cell = rootCell ? rootCell->FindCellByPos(pos.x, pos.y) : NULL; + + if (cell != m_tmpLastCell) + { + wxHtmlLinkInfo *lnk = NULL; + if (cell) + { + // adjust the coordinates to be relative to this cell: + wxPoint relpos = pos - cell->GetAbsPos(rootCell); + lnk = cell->GetLink(relpos.x, relpos.y); + } + + wxCursor cur; + if (cell) + cur = cell->GetMouseCursor(m_interface); + else + cur = m_interface->GetHTMLCursor( + wxHtmlWindowInterface::HTMLCursor_Default); + + m_interface->GetHTMLWindow()->SetCursor(cur); + + if (lnk != m_tmpLastLink) + { + if (lnk) + m_interface->SetHTMLStatusText(lnk->GetHref()); + else + m_interface->SetHTMLStatusText(wxEmptyString); + + m_tmpLastLink = lnk; + } + + m_tmpLastCell = cell; + } + else // mouse moved but stayed in the same cell + { + if ( cell ) + { + OnCellMouseHover(cell, pos.x, pos.y); + } + } + + m_tmpMouseMoved = false; +} + +bool wxHtmlWindowMouseHelper::OnCellClicked(wxHtmlCell *cell, + wxCoord x, wxCoord y, + const wxMouseEvent& event) +{ + wxHtmlCellEvent ev(wxEVT_COMMAND_HTML_CELL_CLICKED, + m_interface->GetHTMLWindow()->GetId(), + cell, wxPoint(x,y), event); + + if (!m_interface->GetHTMLWindow()->GetEventHandler()->ProcessEvent(ev)) + { + // if the event wasn't handled, do the default processing here: + + wxASSERT_MSG( cell, wxT("can't be called with NULL cell") ); + + cell->ProcessMouseClick(m_interface, ev.GetPoint(), ev.GetMouseEvent()); + } + + // true if a link was clicked, false otherwise + return ev.GetLinkClicked(); +} + +void wxHtmlWindowMouseHelper::OnCellMouseHover(wxHtmlCell * cell, + wxCoord x, + wxCoord y) +{ + wxHtmlCellEvent ev(wxEVT_COMMAND_HTML_CELL_HOVER, + m_interface->GetHTMLWindow()->GetId(), + cell, wxPoint(x,y), wxMouseEvent()); + m_interface->GetHTMLWindow()->GetEventHandler()->ProcessEvent(ev); +} + + + + //----------------------------------------------------------------------------- // wxHtmlWindow //----------------------------------------------------------------------------- +wxList wxHtmlWindow::m_Filters; +wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL; +wxHtmlProcessorList *wxHtmlWindow::m_GlobalProcessors = NULL; +wxCursor *wxHtmlWindow::ms_cursorLink = NULL; +wxCursor *wxHtmlWindow::ms_cursorText = NULL; + +void wxHtmlWindow::CleanUpStatics() +{ + wxDELETE(m_DefaultFilter); + WX_CLEAR_LIST(wxList, m_Filters); + if (m_GlobalProcessors) + WX_CLEAR_LIST(wxHtmlProcessorList, *m_GlobalProcessors); + wxDELETE(m_GlobalProcessors); + wxDELETE(ms_cursorLink); + wxDELETE(ms_cursorText); +} void wxHtmlWindow::Init() { - m_tmpMouseMoved = false; - m_tmpLastLink = NULL; - m_tmpLastCell = NULL; m_tmpCanDrawLocks = 0; m_FS = new wxFileSystem(); #if wxUSE_STATUSBAR - m_RelatedStatusBar = -1; + m_RelatedStatusBar = NULL; + m_RelatedStatusBarIndex = -1; #endif // wxUSE_STATUSBAR m_RelatedFrame = NULL; m_TitleFormat = wxT("%s"); @@ -165,7 +309,6 @@ void wxHtmlWindow::Init() m_HistoryOn = true; m_History = new wxHtmlHistoryArray; m_Processors = NULL; - m_Style = 0; SetBorders(10); m_selection = NULL; m_makingSelection = false; @@ -173,8 +316,6 @@ void wxHtmlWindow::Init() m_timerAutoScroll = NULL; m_lastDoubleClick = 0; #endif // wxUSE_CLIPBOARD - m_backBuffer = NULL; - m_eraseBgInOnPaint = false; m_tmpSelFromCell = NULL; } @@ -187,8 +328,20 @@ bool wxHtmlWindow::Create(wxWindow *parent, wxWindowID id, name)) return false; - m_Style = style; + // We can't erase our background in EVT_ERASE_BACKGROUND handler and use + // double buffering in EVT_PAINT handler as this requires blitting back + // something already drawn on the window to the backing store bitmap when + // handling EVT_PAINT but blitting in this direction is simply not + // supported by OS X. + // + // So instead we use a hack with artificial EVT_ERASE_BACKGROUND generation + // from OnPaint() and this means that we never need the "real" erase event + // at all so disable it to avoid executing any user-defined handlers twice + // (and to avoid processing unnecessary event if no handlers are defined). + SetBackgroundStyle(wxBG_STYLE_PAINT); SetPage(wxT("")); + + SetInitialSize(size); return true; } @@ -213,7 +366,6 @@ wxHtmlWindow::~wxHtmlWindow() delete m_FS; delete m_History; delete m_Processors; - delete m_backBuffer; } @@ -227,40 +379,46 @@ void wxHtmlWindow::SetRelatedFrame(wxFrame* frame, const wxString& format) #if wxUSE_STATUSBAR -void wxHtmlWindow::SetRelatedStatusBar(int bar) +void wxHtmlWindow::SetRelatedStatusBar(int index) { - m_RelatedStatusBar = bar; + m_RelatedStatusBarIndex = index; } + +void wxHtmlWindow::SetRelatedStatusBar(wxStatusBar* statusbar, int index) +{ + m_RelatedStatusBar = statusbar; + m_RelatedStatusBarIndex = index; +} + #endif // wxUSE_STATUSBAR void wxHtmlWindow::SetFonts(const wxString& normal_face, const wxString& fixed_face, const int *sizes) { - wxString op = m_OpenedPage; - m_Parser->SetFonts(normal_face, fixed_face, sizes); - // fonts changed => contents invalid, so reload the page: - SetPage(wxT("")); - if (!op.empty()) - LoadPage(op); + + // re-layout the page after changing fonts: + DoSetPage(*(m_Parser->GetSource())); } void wxHtmlWindow::SetStandardFonts(int size, const wxString& normal_face, const wxString& fixed_face) { - wxString op = m_OpenedPage; - m_Parser->SetStandardFonts(size, normal_face, fixed_face); - // fonts changed => contents invalid, so reload the page: - SetPage(wxT("")); - if (!op.empty()) - LoadPage(op); -} + // re-layout the page after changing fonts: + DoSetPage(*(m_Parser->GetSource())); +} bool wxHtmlWindow::SetPage(const wxString& source) +{ + m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString; + return DoSetPage(source); +} + +bool wxHtmlWindow::DoSetPage(const wxString& source) { wxString newsrc(source); @@ -275,8 +433,10 @@ bool wxHtmlWindow::SetPage(const wxString& source) wxHtmlProcessorList::compatibility_iterator nodeL, nodeG; int prL, prG; - nodeL = (m_Processors) ? m_Processors->GetFirst() : wxHtmlProcessorList::compatibility_iterator(); - nodeG = (m_GlobalProcessors) ? m_GlobalProcessors->GetFirst() : wxHtmlProcessorList::compatibility_iterator(); + if ( m_Processors ) + nodeL = m_Processors->GetFirst(); + if ( m_GlobalProcessors ) + nodeG = m_GlobalProcessors->GetFirst(); // VS: there are two lists, global and local, both of them sorted by // priority. Since we have to go through _both_ lists with @@ -307,13 +467,15 @@ bool wxHtmlWindow::SetPage(const wxString& source) dc->SetMapMode(wxMM_TEXT); SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF)); SetBackgroundImage(wxNullBitmap); - m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString; + m_Parser->SetDC(dc); - if (m_Cell) - { - delete m_Cell; - m_Cell = NULL; - } + + // notice that it's important to set m_Cell to NULL here before calling + // Parse() below, even if it will be overwritten by its return value as + // without this we may crash if it's used from inside Parse(), so use + // wxDELETE() and not just delete here + wxDELETE(m_Cell); + m_Cell = (wxHtmlContainerCell*) m_Parser->Parse(newsrc); delete dc; m_Cell->SetIndent(m_Borders, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS); @@ -326,14 +488,15 @@ bool wxHtmlWindow::SetPage(const wxString& source) bool wxHtmlWindow::AppendToPage(const wxString& source) { - return SetPage(*(GetParser()->GetSource()) + source); + return DoSetPage(*(GetParser()->GetSource()) + source); } bool wxHtmlWindow::LoadPage(const wxString& location) { + wxCHECK_MSG( !location.empty(), false, "location must be non-empty" ); + wxBusyCursor busyCursor; - wxFSFile *f; bool rt_val; bool needs_refresh = false; @@ -346,43 +509,40 @@ bool wxHtmlWindow::LoadPage(const wxString& location) (*m_History)[m_HistoryPos].SetPos(y); } - if (location[0] == wxT('#')) - { - // local anchor: - wxString anch = location.Mid(1) /*1 to end*/; - m_tmpCanDrawLocks--; - rt_val = ScrollToAnchor(anch); - m_tmpCanDrawLocks++; - } - else if (location.Find(wxT('#')) != wxNOT_FOUND && location.BeforeFirst(wxT('#')) == m_OpenedPage) + // first check if we're moving to an anchor in the same page + size_t posLocalAnchor = location.Find('#'); + if ( posLocalAnchor != wxString::npos && posLocalAnchor != 0 ) { - wxString anch = location.AfterFirst(wxT('#')); - m_tmpCanDrawLocks--; - rt_val = ScrollToAnchor(anch); - m_tmpCanDrawLocks++; + // check if the part before the anchor is the same as the (either + // relative or absolute) URI of the current page + const wxString beforeAnchor = location.substr(0, posLocalAnchor); + if ( beforeAnchor != m_OpenedPage && + m_FS->GetPath() + beforeAnchor != m_OpenedPage ) + { + // indicate that we're not moving to a local anchor + posLocalAnchor = wxString::npos; + } } - else if (location.Find(wxT('#')) != wxNOT_FOUND && - (m_FS->GetPath() + location.BeforeFirst(wxT('#'))) == m_OpenedPage) + + if ( posLocalAnchor != wxString::npos ) { - wxString anch = location.AfterFirst(wxT('#')); m_tmpCanDrawLocks--; - rt_val = ScrollToAnchor(anch); + rt_val = ScrollToAnchor(location.substr(posLocalAnchor + 1)); m_tmpCanDrawLocks++; } - - else + else // moving to another page { needs_refresh = true; #if wxUSE_STATUSBAR // load&display it: - if (m_RelatedStatusBar != -1) + if (m_RelatedStatusBarIndex != -1) { - m_RelatedFrame->SetStatusText(_("Connecting..."), m_RelatedStatusBar); + SetHTMLStatusText(_("Connecting...")); Refresh(false); } #endif // wxUSE_STATUSBAR - f = m_Parser->OpenURL(wxHTML_URL_PAGE, location); + wxFSFile *f = m_Parser->OpenURL(wxHTML_URL_PAGE, location); // try to interpret 'location' as filename instead of URL: if (f == NULL) @@ -396,6 +556,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location) { wxLogError(_("Unable to open requested HTML document: %s"), location.c_str()); m_tmpCanDrawLocks--; + SetHTMLStatusText(wxEmptyString); return false; } @@ -405,10 +566,10 @@ bool wxHtmlWindow::LoadPage(const wxString& location) wxString src = wxEmptyString; #if wxUSE_STATUSBAR - if (m_RelatedStatusBar != -1) + if (m_RelatedStatusBarIndex != -1) { wxString msg = _("Loading : ") + location; - m_RelatedFrame->SetStatusText(msg, m_RelatedStatusBar); + SetHTMLStatusText(msg); Refresh(false); } #endif // wxUSE_STATUSBAR @@ -441,8 +602,10 @@ bool wxHtmlWindow::LoadPage(const wxString& location) delete f; #if wxUSE_STATUSBAR - if (m_RelatedStatusBar != -1) - m_RelatedFrame->SetStatusText(_("Done"), m_RelatedStatusBar); + if (m_RelatedStatusBarIndex != -1) + { + SetHTMLStatusText(_("Done")); + } #endif // wxUSE_STATUSBAR } } @@ -494,6 +657,16 @@ bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor) } else { + // Go to next visible cell in current container, if it exists. This + // yields a bit better (even though still imperfect) results in that + // there's better chance of using a suitable cell for upper Y + // coordinate value. See bug #11406 for additional discussion. + const wxHtmlCell *c_save = c; + while ( c && c->IsFormattingCell() ) + c = c->GetNext(); + if ( !c ) + c = c_save; + int y; for (y = 0; c != NULL; c = c->GetParent()) y += c->GetPosY(); @@ -516,44 +689,116 @@ void wxHtmlWindow::OnSetTitle(const wxString& title) } - +// return scroll steps such that a) scrollbars aren't shown needlessly +// and b) entire content is viewable (i.e. round up) +static int ScrollSteps(int size, int available) +{ + if ( size <= available ) + return 0; + else + return (size + wxHTML_SCROLL_STEP - 1) / wxHTML_SCROLL_STEP; +} void wxHtmlWindow::CreateLayout() { - int ClientWidth, ClientHeight; + // SetScrollbars() results in size change events -- and thus a nested + // CreateLayout() call -- on some platforms. Ignore nested calls, toplevel + // CreateLayout() will do the right thing eventually. + static wxRecursionGuardFlag s_flagReentrancy; + wxRecursionGuard guard(s_flagReentrancy); + if ( guard.IsInside() ) + return; + + if (!m_Cell) + return; + + int clientWidth, clientHeight; + GetClientSize(&clientWidth, &clientHeight); - if (!m_Cell) return; + const int vscrollbar = wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); + const int hscrollbar = wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y); - if (m_Style & wxHW_SCROLLBAR_NEVER) + if ( HasScrollbar(wxHORIZONTAL) ) + clientHeight += hscrollbar; + + if ( HasScrollbar(wxVERTICAL) ) + clientWidth += vscrollbar; + + if ( HasFlag(wxHW_SCROLLBAR_NEVER) ) { - SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell->GetWidth() / wxHTML_SCROLL_STEP, 0); // always off - GetClientSize(&ClientWidth, &ClientHeight); - m_Cell->Layout(ClientWidth); + SetScrollbars(1, 1, 0, 0); // always off + m_Cell->Layout(clientWidth); } + else // !wxHW_SCROLLBAR_NEVER + { + // Lay the content out with the assumption that it's too large to fit + // in the window (this is likely to be the case): + m_Cell->Layout(clientWidth - vscrollbar); + + // If the layout is wider than the window, horizontal scrollbar will + // certainly be shown. Account for it here for subsequent computations. + if ( m_Cell->GetWidth() > clientWidth ) + clientHeight -= hscrollbar; - else { - GetClientSize(&ClientWidth, &ClientHeight); - m_Cell->Layout(ClientWidth); - if (ClientHeight < m_Cell->GetHeight() + GetCharHeight()) + if ( m_Cell->GetHeight() <= clientHeight ) { - SetScrollbars( - wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, - m_Cell->GetWidth() / wxHTML_SCROLL_STEP, - (m_Cell->GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP - /*cheat: top-level frag is always container*/); + // we fit into the window, hide vertical scrollbar: + SetScrollbars + ( + wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, + ScrollSteps(m_Cell->GetWidth(), clientWidth - vscrollbar), + 0 + ); + // ...and redo the layout to use the extra space + m_Cell->Layout(clientWidth); } - else /* we fit into window, no need for scrollbars */ + else { - SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell->GetWidth() / wxHTML_SCROLL_STEP, 0); // disable... - GetClientSize(&ClientWidth, &ClientHeight); - m_Cell->Layout(ClientWidth); // ...and relayout + // If the content doesn't fit into the window by only a small + // margin, chances are that it may fit fully with scrollbar turned + // off. It's something worth trying but on the other hand, we don't + // want to waste too much time redoing the layout (twice!) for + // long -- and thus expensive to layout -- pages. The cut-off value + // is an arbitrary heuristics. + static const int SMALL_OVERLAP = 60; + if ( m_Cell->GetHeight() <= clientHeight + SMALL_OVERLAP ) + { + m_Cell->Layout(clientWidth); + + if ( m_Cell->GetHeight() <= clientHeight ) + { + // Great, we fit in. Hide the scrollbar. + SetScrollbars + ( + wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, + ScrollSteps(m_Cell->GetWidth(), clientWidth), + 0 + ); + return; + } + else + { + // That didn't work out, go back to previous layout. Note + // that redoing the layout once again here isn't as bad as + // it looks -- thanks to the small cut-off value, it's a + // reasonably small page. + m_Cell->Layout(clientWidth - vscrollbar); + } + } + // else: the page is very long, it will certainly need scrollbar + + SetScrollbars + ( + wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP, + ScrollSteps(m_Cell->GetWidth(), clientWidth - vscrollbar), + ScrollSteps(m_Cell->GetHeight(), clientHeight) + ); } } } - - +#if wxUSE_CONFIG void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path) { wxString oldpath; @@ -606,8 +851,7 @@ void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path) if (path != wxEmptyString) cfg->SetPath(oldpath); } - - +#endif // wxUSE_CONFIG bool wxHtmlWindow::HistoryBack() { @@ -720,21 +964,6 @@ void wxHtmlWindow::AddProcessor(wxHtmlProcessor *processor) -wxList wxHtmlWindow::m_Filters; -wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL; -wxHtmlProcessorList *wxHtmlWindow::m_GlobalProcessors = NULL; - -void wxHtmlWindow::CleanUpStatics() -{ - wxDELETE(m_DefaultFilter); - WX_CLEAR_LIST(wxList, m_Filters); - if (m_GlobalProcessors) - WX_CLEAR_LIST(wxHtmlProcessorList, *m_GlobalProcessors); - wxDELETE(m_GlobalProcessors); -} - - - void wxHtmlWindow::AddFilter(wxHtmlFilter *filter) { m_Filters.Append(filter); @@ -744,7 +973,7 @@ void wxHtmlWindow::AddFilter(wxHtmlFilter *filter) bool wxHtmlWindow::IsSelectionEnabled() const { #if wxUSE_CLIPBOARD - return !(m_Style & wxHW_NO_SELECTION); + return !HasFlag(wxHW_NO_SELECTION); #else return false; #endif @@ -758,21 +987,27 @@ wxString wxHtmlWindow::DoSelectionToText(wxHtmlSelection *sel) return wxEmptyString; wxClientDC dc(this); - - const wxHtmlCell *end = sel->GetToCell(); wxString text; - wxHtmlTerminalCellsInterator i(sel->GetFromCell(), end); - if ( i ) - { - text << i->ConvertToText(sel); - ++i; - } - const wxHtmlCell *prev = *i; + + wxHtmlTerminalCellsInterator i(sel->GetFromCell(), sel->GetToCell()); + const wxHtmlCell *prev = NULL; + while ( i ) { - if ( prev->GetParent() != i->GetParent() ) - text << _T('\n'); - text << i->ConvertToText(*i == end ? sel : NULL); + // When converting HTML content to plain text, the entire paragraph + // (container in wxHTML) goes on single line. A new paragraph (that + // should go on its own line) has its own container. Therefore, the + // simplest way of detecting where to insert newlines in plain text + // is to check if the parent container changed -- if it did, we moved + // to a new paragraph. + if ( prev && prev->GetParent() != i->GetParent() ) + text << '\n'; + + // NB: we don't need to pass the selection to ConvertToText() in the + // middle of the selected text; it's only useful when only part of + // a cell is selected + text << i->ConvertToText(sel); + prev = *i; ++i; } @@ -814,7 +1049,7 @@ bool wxHtmlWindow::CopySelection(ClipboardType t) const wxString txt(SelectionToText()); wxTheClipboard->SetData(new wxTextDataObject(txt)); wxTheClipboard->Close(); - wxLogTrace(_T("wxhtmlselection"), + wxLogTrace(wxT("wxhtmlselection"), _("Copied to clipboard:\"%s\""), txt.c_str()); return true; @@ -830,110 +1065,101 @@ bool wxHtmlWindow::CopySelection(ClipboardType t) void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) { - const wxMouseEvent *e = link.GetEvent(); - if (e == NULL || e->LeftUp()) - LoadPage(link.GetHref()); -} - -void wxHtmlWindow::OnCellClicked(wxHtmlCell *cell, - wxCoord x, wxCoord y, - const wxMouseEvent& event) -{ - wxCHECK_RET( cell, _T("can't be called with NULL cell") ); - - cell->OnMouseClick(this, x, y, event); -} - -void wxHtmlWindow::OnCellMouseHover(wxHtmlCell * WXUNUSED(cell), - wxCoord WXUNUSED(x), wxCoord WXUNUSED(y)) -{ - // do nothing here -} - -void wxHtmlWindow::OnEraseBackground(wxEraseEvent& event) -{ - if ( !m_bmpBg.Ok() ) + wxHtmlLinkEvent event(GetId(), link); + event.SetEventObject(this); + if (!GetEventHandler()->ProcessEvent(event)) { - // don't even skip the event, if we don't have a bg bitmap we're going - // to overwrite background in OnPaint() below anyhow, so letting the - // default handling take place would only result in flicker, just set a - // flag to erase the background below - m_eraseBgInOnPaint = true; - return; + // the default behaviour is to load the URL in this window + const wxMouseEvent *e = event.GetLinkInfo().GetEvent(); + if (e == NULL || e->LeftUp()) + LoadPage(event.GetLinkInfo().GetHref()); } +} - wxDC& dc = *event.GetDC(); - - // if the image is not fully opaque, we have to erase the background before - // drawing it, however avoid doing it for opaque images as this would just - // result in extra flicker without any other effect as background is - // completely covered anyhow - if ( m_bmpBg.GetMask() ) +void wxHtmlWindow::DoEraseBackground(wxDC& dc) +{ + // if we don't have any background bitmap we just fill it with background + // colour and we also must do it if the background bitmap is not fully + // opaque as otherwise junk could be left there + if ( !m_bmpBg.IsOk() || m_bmpBg.GetMask() ) { - dc.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID)); + dc.SetBackground(GetBackgroundColour()); dc.Clear(); } - const wxSize sizeWin(GetClientSize()); - const wxSize sizeBmp(m_bmpBg.GetWidth(), m_bmpBg.GetHeight()); - for ( wxCoord x = 0; x < sizeWin.x; x += sizeBmp.x ) + if ( m_bmpBg.IsOk() ) { - for ( wxCoord y = 0; y < sizeWin.y; y += sizeBmp.y ) + // draw the background bitmap tiling it over the entire window area + const wxSize sz = GetClientSize(); + const wxSize sizeBmp(m_bmpBg.GetWidth(), m_bmpBg.GetHeight()); + for ( wxCoord x = 0; x < sz.x; x += sizeBmp.x ) { - dc.DrawBitmap(m_bmpBg, x, y, true /* use mask */); + for ( wxCoord y = 0; y < sz.y; y += sizeBmp.y ) + { + dc.DrawBitmap(m_bmpBg, x, y, true /* use mask */); + } } } } void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) { - wxPaintDC dc(this); + wxPaintDC dcPaint(this); if (m_tmpCanDrawLocks > 0 || m_Cell == NULL) return; int x, y; GetViewStart(&x, &y); - wxRect rect = GetUpdateRegion().GetBox(); - wxSize sz = GetSize(); - + const wxRect rect = GetUpdateRegion().GetBox(); + const wxSize sz = GetClientSize(); + + // set up the DC we're drawing on: if the window is already double buffered + // we do it directly on wxPaintDC, otherwise we allocate a backing store + // buffer and compose the drawing there and then blit it to screen all at + // once + wxDC *dc; wxMemoryDC dcm; - if ( !m_backBuffer ) - m_backBuffer = new wxBitmap(sz.x, sz.y); - dcm.SelectObject(*m_backBuffer); - - if ( m_eraseBgInOnPaint ) + if ( IsDoubleBuffered() ) { - dcm.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID)); - dcm.Clear(); - - m_eraseBgInOnPaint = false; + dc = &dcPaint; + } + else // window is not double buffered by the system, do it ourselves + { + if ( !m_backBuffer.IsOk() ) + m_backBuffer.Create(sz.x, sz.y); + dcm.SelectObject(m_backBuffer); + dc = &dcm; } - else // someone has already erased the background, keep it + + PrepareDC(*dc); + + // erase the background: for compatibility, we must generate the event to + // allow the user-defined handlers to do it + wxEraseEvent eraseEvent(GetId(), dc); + eraseEvent.SetEventObject(this); + if ( !ProcessWindowEvent(eraseEvent) ) { - // preserve the existing background, otherwise we'd erase anything the - // user code had drawn in its EVT_ERASE_BACKGROUND handler when we do - // the Blit back below - dcm.Blit(0, rect.GetTop(), - sz.x, rect.GetBottom() - rect.GetTop() + 1, - &dc, - 0, rect.GetTop()); + // erase background ourselves + DoEraseBackground(*dc); } + //else: background erased by the user-defined handler - PrepareDC(dcm); - dcm.SetMapMode(wxMM_TEXT); - dcm.SetBackgroundMode(wxTRANSPARENT); + + // draw the HTML window contents + dc->SetMapMode(wxMM_TEXT); + dc->SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT); + dc->SetLayoutDirection(GetLayoutDirection()); wxHtmlRenderingInfo rinfo; wxDefaultHtmlRenderingStyle rstyle; rinfo.SetSelection(m_selection); rinfo.SetStyle(&rstyle); - m_Cell->Draw(dcm, 0, 0, + m_Cell->Draw(*dc, 0, 0, y * wxHTML_SCROLL_STEP + rect.GetTop(), y * wxHTML_SCROLL_STEP + rect.GetBottom(), rinfo); -//#define DEBUG_HTML_SELECTION #ifdef DEBUG_HTML_SELECTION { int xc, yc, x, y; @@ -946,27 +1172,30 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) wxHtmlCell *after = m_Cell->FindCellByPos(x, y, wxHTML_FIND_NEAREST_AFTER); - dcm.SetBrush(*wxTRANSPARENT_BRUSH); - dcm.SetPen(*wxBLACK_PEN); + dc->SetBrush(*wxTRANSPARENT_BRUSH); + dc->SetPen(*wxBLACK_PEN); if (at) - dcm.DrawRectangle(at->GetAbsPos(), + dc->DrawRectangle(at->GetAbsPos(), wxSize(at->GetWidth(),at->GetHeight())); - dcm.SetPen(*wxGREEN_PEN); + dc->SetPen(*wxGREEN_PEN); if (before) - dcm.DrawRectangle(before->GetAbsPos().x+1, before->GetAbsPos().y+1, + dc->DrawRectangle(before->GetAbsPos().x+1, before->GetAbsPos().y+1, before->GetWidth()-2,before->GetHeight()-2); - dcm.SetPen(*wxRED_PEN); + dc->SetPen(*wxRED_PEN); if (after) - dcm.DrawRectangle(after->GetAbsPos().x+2, after->GetAbsPos().y+2, + dc->DrawRectangle(after->GetAbsPos().x+2, after->GetAbsPos().y+2, after->GetWidth()-4,after->GetHeight()-4); } -#endif +#endif // DEBUG_HTML_SELECTION - dcm.SetDeviceOrigin(0,0); - dc.Blit(0, rect.GetTop(), - sz.x, rect.GetBottom() - rect.GetTop() + 1, - &dcm, - 0, rect.GetTop()); + if ( dc != &dcPaint ) + { + dc->SetDeviceOrigin(0,0); + dcPaint.Blit(0, rect.GetTop(), + sz.x, rect.GetBottom() - rect.GetTop() + 1, + dc, + 0, rect.GetTop()); + } } @@ -974,9 +1203,10 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) void wxHtmlWindow::OnSize(wxSizeEvent& event) { - wxDELETE(m_backBuffer); + event.Skip(); + + m_backBuffer = wxNullBitmap; - wxScrolledWindow::OnSize(event); CreateLayout(); // Recompute selection if necessary: @@ -984,7 +1214,7 @@ void wxHtmlWindow::OnSize(wxSizeEvent& event) { m_selection->Set(m_selection->GetFromCell(), m_selection->GetToCell()); - m_selection->ClearPrivPos(); + m_selection->ClearFromToCharacterPos(); } Refresh(); @@ -993,7 +1223,7 @@ void wxHtmlWindow::OnSize(wxSizeEvent& event) void wxHtmlWindow::OnMouseMove(wxMouseEvent& WXUNUSED(event)) { - m_tmpMouseMoved = true; + wxHtmlWindowMouseHelper::HandleMouseMoved(); } void wxHtmlWindow::OnMouseDown(wxMouseEvent& event) @@ -1023,9 +1253,10 @@ void wxHtmlWindow::OnMouseDown(wxMouseEvent& event) CaptureMouse(); } } -#else - wxUnusedVar(event); #endif // wxUSE_CLIPBOARD + + // in any case, let the default handler set focus to this window + event.Skip(); } void wxHtmlWindow::OnMouseUp(wxMouseEvent& event) @@ -1036,9 +1267,13 @@ void wxHtmlWindow::OnMouseUp(wxMouseEvent& event) ReleaseMouse(); m_makingSelection = false; - // did the user move the mouse far enough from starting point? - if ( CopySelection(Primary) ) + // if m_selection=NULL, the user didn't move the mouse far enough from + // starting point and the mouse up event is part of a click, the user + // is not selecting text: + if ( m_selection ) { + CopySelection(Primary); + // we don't want mouse up event that ended selecting to be // handled as mouse click and e.g. follow hyperlink: return; @@ -1046,27 +1281,30 @@ void wxHtmlWindow::OnMouseUp(wxMouseEvent& event) } #endif // wxUSE_CLIPBOARD - SetFocus(); - if ( m_Cell ) - { - wxPoint pos = CalcUnscrolledPosition(event.GetPosition()); - wxHtmlCell *cell = m_Cell->FindCellByPos(pos.x, pos.y); - - // check is needed because FindCellByPos returns terminal cell and - // containers may have empty borders -- in this case NULL will be - // returned - if ( cell ) - OnCellClicked(cell, pos.x, pos.y, event); - } + wxPoint pos = CalcUnscrolledPosition(event.GetPosition()); + wxHtmlWindowMouseHelper::HandleMouseClick(m_Cell, pos, event); } +#if wxUSE_CLIPBOARD +void wxHtmlWindow::OnMouseCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event)) +{ + if ( !m_makingSelection ) + return; + + // discard the selecting operation + m_makingSelection = false; + wxDELETE(m_selection); + m_tmpSelFromCell = NULL; + Refresh(); +} +#endif // wxUSE_CLIPBOARD void wxHtmlWindow::OnInternalIdle() { wxWindow::OnInternalIdle(); - if (m_tmpMouseMoved && (m_Cell != NULL)) + if (m_Cell != NULL && DidMouseMove()) { #ifdef DEBUG_HTML_SELECTION Refresh(); @@ -1170,57 +1408,28 @@ void wxHtmlWindow::OnInternalIdle() if ( m_tmpSelFromCell->IsBefore(selcell) ) { m_selection->Set(m_tmpSelFromPos, m_tmpSelFromCell, - wxPoint(x,y), selcell); } + wxPoint(x,y), selcell); + } else { m_selection->Set(wxPoint(x,y), selcell, m_tmpSelFromPos, m_tmpSelFromCell); } - m_selection->ClearPrivPos(); + m_selection->ClearFromToCharacterPos(); Refresh(); } } } // handle cursor and status bar text changes: - if ( cell != m_tmpLastCell ) - { - wxHtmlLinkInfo *lnk = cell ? cell->GetLink(x, y) : NULL; - wxCursor cur; - if (cell) - cur = cell->GetCursor(); - else - cur = *wxSTANDARD_CURSOR; - SetCursor(cur); - if (lnk != m_tmpLastLink) - { -#if wxUSE_STATUSBAR - if (lnk == NULL) - { - if (m_RelatedStatusBar != -1) - m_RelatedFrame->SetStatusText(wxEmptyString, - m_RelatedStatusBar); - } - else - { - if (m_RelatedStatusBar != -1) - m_RelatedFrame->SetStatusText(lnk->GetHref(), - m_RelatedStatusBar); - } -#endif // wxUSE_STATUSBAR - m_tmpLastLink = lnk; - } - - m_tmpLastCell = cell; - } - else // mouse moved but stayed in the same cell - { - if ( cell ) - OnCellMouseHover(cell, x, y); - } - - m_tmpMouseMoved = false; + // NB: because we're passing in 'cell' and not 'm_Cell' (so that the + // leaf cell lookup isn't done twice), we need to adjust the + // position for the new root: + wxPoint posInCell(x, y); + if (cell) + posInCell -= cell->GetAbsPos(); + wxHtmlWindowMouseHelper::HandleIdle(cell, posInCell); } } @@ -1280,7 +1489,7 @@ void wxHtmlWindow::OnMouseLeave(wxMouseEvent& event) // but seems to happen sometimes under wxMSW - maybe it's a bug // there but for now just ignore it - //wxFAIL_MSG( _T("can't understand where has mouse gone") ); + //wxFAIL_MSG( wxT("can't understand where has mouse gone") ); return; } @@ -1306,9 +1515,14 @@ void wxHtmlWindow::OnMouseLeave(wxMouseEvent& event) void wxHtmlWindow::OnKeyUp(wxKeyEvent& event) { - if ( IsSelectionEnabled() && event.GetKeyCode() == 'C' && event.CmdDown() ) + if ( IsSelectionEnabled() && + (event.GetKeyCode() == 'C' && event.CmdDown()) ) { - (void) CopySelection(); + wxClipboardTextEvent evt(wxEVT_COMMAND_TEXT_COPY, GetId()); + + evt.SetEventObject(this); + + GetEventHandler()->ProcessEvent(evt); } } @@ -1317,6 +1531,11 @@ void wxHtmlWindow::OnCopy(wxCommandEvent& WXUNUSED(event)) (void) CopySelection(); } +void wxHtmlWindow::OnClipboardEvent(wxClipboardTextEvent& WXUNUSED(event)) +{ + (void) CopySelection(); +} + void wxHtmlWindow::OnDoubleClick(wxMouseEvent& event) { // select word under cursor: @@ -1357,7 +1576,7 @@ void wxHtmlWindow::SelectLine(const wxPoint& pos) { // We use following heuristic to find a "line": let the line be all // cells in same container as the cell under mouse cursor that are - // neither completely above nor completely bellow the clicked cell + // neither completely above nor completely below the clicked cell // (i.e. are likely to be words positioned on same line of text). int y1 = cell->GetAbsPos().y; @@ -1421,9 +1640,6 @@ void wxHtmlWindow::SelectAll() IMPLEMENT_ABSTRACT_CLASS(wxHtmlProcessor,wxObject) -#if wxUSE_EXTENDED_RTTI -IMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow, wxScrolledWindow,"wx/html/htmlwin.h") - wxBEGIN_PROPERTIES_TABLE(wxHtmlWindow) /* TODO PROPERTIES @@ -1438,9 +1654,8 @@ wxBEGIN_HANDLERS_TABLE(wxHtmlWindow) wxEND_HANDLERS_TABLE() wxCONSTRUCTOR_5( wxHtmlWindow , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle ) -#else -IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow) -#endif + +wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow, wxScrolledWindow,"wx/html/htmlwin.h") BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow) EVT_SIZE(wxHtmlWindow::OnSize) @@ -1448,20 +1663,114 @@ BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow) EVT_LEFT_UP(wxHtmlWindow::OnMouseUp) EVT_RIGHT_UP(wxHtmlWindow::OnMouseUp) EVT_MOTION(wxHtmlWindow::OnMouseMove) - EVT_ERASE_BACKGROUND(wxHtmlWindow::OnEraseBackground) EVT_PAINT(wxHtmlWindow::OnPaint) #if wxUSE_CLIPBOARD EVT_LEFT_DCLICK(wxHtmlWindow::OnDoubleClick) EVT_ENTER_WINDOW(wxHtmlWindow::OnMouseEnter) EVT_LEAVE_WINDOW(wxHtmlWindow::OnMouseLeave) + EVT_MOUSE_CAPTURE_LOST(wxHtmlWindow::OnMouseCaptureLost) EVT_KEY_UP(wxHtmlWindow::OnKeyUp) EVT_MENU(wxID_COPY, wxHtmlWindow::OnCopy) + EVT_TEXT_COPY(wxID_ANY, wxHtmlWindow::OnClipboardEvent) #endif // wxUSE_CLIPBOARD END_EVENT_TABLE() +//----------------------------------------------------------------------------- +// wxHtmlWindowInterface implementation in wxHtmlWindow +//----------------------------------------------------------------------------- + +void wxHtmlWindow::SetHTMLWindowTitle(const wxString& title) +{ + OnSetTitle(title); +} +void wxHtmlWindow::OnHTMLLinkClicked(const wxHtmlLinkInfo& link) +{ + OnLinkClicked(link); +} +wxHtmlOpeningStatus wxHtmlWindow::OnHTMLOpeningURL(wxHtmlURLType type, + const wxString& url, + wxString *redirect) const +{ + return OnOpeningURL(type, url, redirect); +} +wxPoint wxHtmlWindow::HTMLCoordsToWindow(wxHtmlCell *WXUNUSED(cell), + const wxPoint& pos) const +{ + return CalcScrolledPosition(pos); +} + +wxWindow* wxHtmlWindow::GetHTMLWindow() +{ + return this; +} + +wxColour wxHtmlWindow::GetHTMLBackgroundColour() const +{ + return GetBackgroundColour(); +} + +void wxHtmlWindow::SetHTMLBackgroundColour(const wxColour& clr) +{ + SetBackgroundColour(clr); +} + +void wxHtmlWindow::SetHTMLBackgroundImage(const wxBitmap& bmpBg) +{ + SetBackgroundImage(bmpBg); +} + +void wxHtmlWindow::SetHTMLStatusText(const wxString& text) +{ +#if wxUSE_STATUSBAR + if (m_RelatedStatusBarIndex != -1) + { + if (m_RelatedStatusBar) + { + m_RelatedStatusBar->SetStatusText(text, m_RelatedStatusBarIndex); + } + else if (m_RelatedFrame) + { + m_RelatedFrame->SetStatusText(text, m_RelatedStatusBarIndex); + } + } +#else + wxUnusedVar(text); +#endif // wxUSE_STATUSBAR +} + +/*static*/ +wxCursor wxHtmlWindow::GetDefaultHTMLCursor(HTMLCursor type) +{ + switch (type) + { + case HTMLCursor_Link: + if ( !ms_cursorLink ) + ms_cursorLink = new wxCursor(wxCURSOR_HAND); + return *ms_cursorLink; + + case HTMLCursor_Text: + if ( !ms_cursorText ) + ms_cursorText = new wxCursor(wxCURSOR_IBEAM); + return *ms_cursorText; + + case HTMLCursor_Default: + default: + return *wxSTANDARD_CURSOR; + } +} + +wxCursor wxHtmlWindow::GetHTMLCursor(HTMLCursor type) const +{ + return GetDefaultHTMLCursor(type); +} + + +//----------------------------------------------------------------------------- +// wxHtmlWinModule +//----------------------------------------------------------------------------- // A module to allow initialization/cleanup // without calling these functions from app.cpp or from @@ -1485,4 +1794,3 @@ IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule, wxModule) FORCE_WXHTML_MODULES() #endif // wxUSE_HTML -