]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/htmlwin.cpp
remove MSVC warnings about DLL-exported class inheriting from non DLL-exported one...
[wxWidgets.git] / src / html / htmlwin.cpp
index 741e10fb62eab92a2736eee9d658166269192c45..56c6f5d7b7f5becfd1a6557b6567461ec4771489 100644 (file)
@@ -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,40 @@
 
 #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/arrimpl.cpp"
 #include "wx/listimpl.cpp"
 
+// 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 +71,7 @@ private:
     int m_pos,
         m_orient;
 
-    DECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer)
+    wxDECLARE_NO_COPY_CLASS(wxHtmlWinAutoScrollTimer);
 };
 
 void wxHtmlWinAutoScrollTimer::Notify()
@@ -194,9 +202,11 @@ void wxHtmlWindowMouseHelper::HandleIdle(wxHtmlCell *rootCell,
 
         wxCursor cur;
         if (cell)
-            cur = cell->GetCursor();
+            cur = cell->GetMouseCursor(m_interface);
         else
-            cur = *wxSTANDARD_CURSOR;
+            cur = m_interface->GetHTMLCursor(
+                        wxHtmlWindowInterface::HTMLCursor_Default);
+
         m_interface->GetHTMLWindow()->SetCursor(cur);
 
         if (lnk != m_tmpLastLink)
@@ -226,29 +236,64 @@ bool wxHtmlWindowMouseHelper::OnCellClicked(wxHtmlCell *cell,
                                             wxCoord x, wxCoord y,
                                             const wxMouseEvent& event)
 {
-    wxCHECK_MSG( cell, false, _T("can't be called with NULL cell") );
+    wxHtmlCellEvent ev(wxEVT_COMMAND_HTML_CELL_CLICKED,
+                       m_interface->GetHTMLWindow()->GetId(),
+                       cell, wxPoint(x,y), event);
 
-    return cell->ProcessMouseClick(m_interface, 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, _T("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 * WXUNUSED(cell),
-                                               wxCoord WXUNUSED(x),
-                                               wxCoord WXUNUSED(y))
+void wxHtmlWindowMouseHelper::OnCellMouseHover(wxHtmlCell * cell,
+                                               wxCoord x,
+                                               wxCoord y)
 {
-    // do nothing here
+    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_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");
@@ -260,7 +305,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;
@@ -282,7 +326,6 @@ bool wxHtmlWindow::Create(wxWindow *parent, wxWindowID id,
                                   name))
         return false;
 
-    m_Style = style;
     SetPage(wxT("<html><body></body></html>"));
     return true;
 }
@@ -322,10 +365,17 @@ void wxHtmlWindow::SetRelatedFrame(wxFrame* frame, const wxString& format)
 
 
 #if wxUSE_STATUSBAR
-void wxHtmlWindow::SetRelatedStatusBar(int bar)
+void wxHtmlWindow::SetRelatedStatusBar(int index)
+{
+    m_RelatedStatusBarIndex = index;
+}
+
+void wxHtmlWindow::SetRelatedStatusBar(wxStatusBar* statusbar, int index)
 {
-    m_RelatedStatusBar = bar;
+    m_RelatedStatusBar =  statusbar;
+    m_RelatedStatusBarIndex = index;
 }
+
 #endif // wxUSE_STATUSBAR
 
 
@@ -427,9 +477,10 @@ bool wxHtmlWindow::AppendToPage(const wxString& 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;
 
@@ -442,43 +493,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)
@@ -492,6 +540,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
         {
             wxLogError(_("Unable to open requested HTML document: %s"), location.c_str());
             m_tmpCanDrawLocks--;
+            SetHTMLStatusText(wxEmptyString);
             return false;
         }
 
@@ -501,10 +550,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
@@ -537,8 +586,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
         }
     }
@@ -621,14 +672,14 @@ void wxHtmlWindow::CreateLayout()
 
     if (!m_Cell) return;
 
-    if (m_Style & wxHW_SCROLLBAR_NEVER)
+    if ( HasFlag(wxHW_SCROLLBAR_NEVER) )
     {
-        SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell->GetWidth() / wxHTML_SCROLL_STEP, 0); // always off
+        SetScrollbars(1, 1, 0, 0); // always off
         GetClientSize(&ClientWidth, &ClientHeight);
         m_Cell->Layout(ClientWidth);
     }
-
-    else {
+    else // !wxHW_SCROLLBAR_NEVER
+    {
         GetClientSize(&ClientWidth, &ClientHeight);
         m_Cell->Layout(ClientWidth);
         if (ClientHeight < m_Cell->GetHeight() + GetCharHeight())
@@ -816,21 +867,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);
@@ -840,7 +876,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
@@ -854,21 +890,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;
     }
@@ -926,9 +968,15 @@ bool wxHtmlWindow::CopySelection(ClipboardType t)
 
 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link)
 {
-    const wxMouseEvent *e = link.GetEvent();
-    if (e == NULL || e->LeftUp())
-        LoadPage(link.GetHref());
+    wxHtmlLinkEvent event(GetId(), link);
+    event.SetEventObject(this);
+    if (!GetEventHandler()->ProcessEvent(event))
+    {
+        // 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());
+    }
 }
 
 void wxHtmlWindow::OnEraseBackground(wxEraseEvent& event)
@@ -951,7 +999,7 @@ void wxHtmlWindow::OnEraseBackground(wxEraseEvent& event)
     // completely covered anyhow
     if ( m_bmpBg.GetMask() )
     {
-        dc.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
+        dc.SetBackground(wxBrush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID));
         dc.Clear();
     }
 
@@ -985,7 +1033,7 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
 
     if ( m_eraseBgInOnPaint )
     {
-        dcm.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
+        dcm.SetBackground(wxBrush(GetBackgroundColour(), wxBRUSHSTYLE_SOLID));
         dcm.Clear();
 
         m_eraseBgInOnPaint = false;
@@ -1003,7 +1051,7 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
 
     PrepareDC(dcm);
     dcm.SetMapMode(wxMM_TEXT);
-    dcm.SetBackgroundMode(wxTRANSPARENT);
+    dcm.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT);
 
     wxHtmlRenderingInfo rinfo;
     wxDefaultHtmlRenderingStyle rstyle;
@@ -1104,9 +1152,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)
@@ -1117,9 +1166,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;
@@ -1127,12 +1180,23 @@ void wxHtmlWindow::OnMouseUp(wxMouseEvent& event)
     }
 #endif // wxUSE_CLIPBOARD
 
-    SetFocus();
-
     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()
@@ -1243,7 +1307,8 @@ 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,
@@ -1349,9 +1414,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);
     }
 }
 
@@ -1360,6 +1430,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:
@@ -1497,8 +1572,10 @@ BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow)
     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()
 
@@ -1552,11 +1629,48 @@ void wxHtmlWindow::SetHTMLBackgroundImage(const wxBitmap& bmpBg)
 void wxHtmlWindow::SetHTMLStatusText(const wxString& text)
 {
 #if wxUSE_STATUSBAR
-    if (m_RelatedStatusBar != -1)
-        m_RelatedFrame->SetStatusText(text, m_RelatedStatusBar);
+    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
@@ -1584,4 +1698,3 @@ IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule, wxModule)
 FORCE_WXHTML_MODULES()
 
 #endif // wxUSE_HTML
-