]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/htmlwin.cpp
fixes to static box borders calculations and significant code cleanup (finalizes...
[wxWidgets.git] / src / html / htmlwin.cpp
index e9eed8def797c1fcb24859f29fff4e3946bc4a33..69ced30b42bab417c10b88f284010135403875e2 100644 (file)
@@ -4,7 +4,7 @@
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik
-// Licence:     wxWidgets Licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 #include "wx/dataobj.h"
 #include "wx/timer.h"
 #include "wx/dcmemory.h"
+#include "wx/settings.h"
 
 #include "wx/arrimpl.cpp"
 #include "wx/listimpl.cpp"
 
 
-
 #if wxUSE_CLIPBOARD
 // ----------------------------------------------------------------------------
 // wxHtmlWinAutoScrollTimer: the timer used to generate a stream of scroll
@@ -153,12 +153,14 @@ WX_DEFINE_LIST(wxHtmlProcessorList);
 
 void wxHtmlWindow::Init()
 {
-    m_tmpMouseMoved = FALSE;
+    m_tmpMouseMoved = false;
     m_tmpLastLink = NULL;
     m_tmpLastCell = NULL;
     m_tmpCanDrawLocks = 0;
     m_FS = new wxFileSystem();
+#if wxUSE_STATUSBAR
     m_RelatedStatusBar = -1;
+#endif // wxUSE_STATUSBAR
     m_RelatedFrame = NULL;
     m_TitleFormat = wxT("%s");
     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
@@ -166,7 +168,7 @@ void wxHtmlWindow::Init()
     m_Parser = new wxHtmlWinParser(this);
     m_Parser->SetFS(m_FS);
     m_HistoryPos = -1;
-    m_HistoryOn = TRUE;
+    m_HistoryOn = true;
     m_History = new wxHtmlHistoryArray;
     m_Processors = NULL;
     m_Style = 0;
@@ -178,6 +180,8 @@ void wxHtmlWindow::Init()
     m_lastDoubleClick = 0;
 #endif // wxUSE_CLIPBOARD
     m_backBuffer = NULL;
+    m_eraseBgInOnPaint = false;
+    m_tmpSelFromCell = NULL;
 }
 
 bool wxHtmlWindow::Create(wxWindow *parent, wxWindowID id,
@@ -187,11 +191,11 @@ bool wxHtmlWindow::Create(wxWindow *parent, wxWindowID id,
     if (!wxScrolledWindow::Create(parent, id, pos, size,
                                   style | wxVSCROLL | wxHSCROLL,
                                   name))
-        return FALSE;
+        return false;
 
     m_Style = style;
     SetPage(wxT("<html><body></body></html>"));
-    return TRUE;
+    return true;
 }
 
 
@@ -228,10 +232,12 @@ void wxHtmlWindow::SetRelatedFrame(wxFrame* frame, const wxString& format)
 
 
 
+#if wxUSE_STATUSBAR
 void wxHtmlWindow::SetRelatedStatusBar(int bar)
 {
     m_RelatedStatusBar = bar;
 }
+#endif // wxUSE_STATUSBAR
 
 
 
@@ -242,9 +248,22 @@ void wxHtmlWindow::SetFonts(wxString normal_face, wxString fixed_face, const int
     m_Parser->SetFonts(normal_face, fixed_face, sizes);
     // fonts changed => contents invalid, so reload the page:
     SetPage(wxT("<html><body></body></html>"));
-    if (!op.IsEmpty()) LoadPage(op);
+    if (!op.empty())
+        LoadPage(op);
 }
 
+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("<html><body></body></html>"));
+    if (!op.empty())
+        LoadPage(op);
+}
 
 
 bool wxHtmlWindow::SetPage(const wxString& source)
@@ -253,6 +272,9 @@ bool wxHtmlWindow::SetPage(const wxString& source)
 
     wxDELETE(m_selection);
 
+    // we will soon delete all the cells, so clear pointers to them:
+    m_tmpSelFromCell = NULL;
+
     // pass HTML through registered processors:
     if (m_Processors || m_GlobalProcessors)
     {
@@ -290,6 +312,7 @@ bool wxHtmlWindow::SetPage(const wxString& source)
     wxClientDC *dc = new wxClientDC(this);
     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)
@@ -304,7 +327,7 @@ bool wxHtmlWindow::SetPage(const wxString& source)
     CreateLayout();
     if (m_tmpCanDrawLocks == 0)
         Refresh();
-    return TRUE;
+    return true;
 }
 
 bool wxHtmlWindow::AppendToPage(const wxString& source)
@@ -318,7 +341,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
 
     wxFSFile *f;
     bool rt_val;
-    bool needs_refresh = FALSE;
+    bool needs_refresh = false;
 
     m_tmpCanDrawLocks++;
     if (m_HistoryOn && (m_HistoryPos != -1))
@@ -355,13 +378,15 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
 
     else
     {
-        needs_refresh = TRUE;
+        needs_refresh = true;
+#if wxUSE_STATUSBAR
         // load&display it:
         if (m_RelatedStatusBar != -1)
         {
             m_RelatedFrame->SetStatusText(_("Connecting..."), m_RelatedStatusBar);
-            Refresh(FALSE);
+            Refresh(false);
         }
+#endif // wxUSE_STATUSBAR
 
         f = m_Parser->OpenURL(wxHTML_URL_PAGE, location);
 
@@ -377,7 +402,7 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
         {
             wxLogError(_("Unable to open requested HTML document: %s"), location.c_str());
             m_tmpCanDrawLocks--;
-            return FALSE;
+            return false;
         }
 
         else
@@ -385,12 +410,14 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
             wxList::compatibility_iterator node;
             wxString src = wxEmptyString;
 
+#if wxUSE_STATUSBAR
             if (m_RelatedStatusBar != -1)
             {
                 wxString msg = _("Loading : ") + location;
                 m_RelatedFrame->SetStatusText(msg, m_RelatedStatusBar);
-                Refresh(FALSE);
+                Refresh(false);
             }
+#endif // wxUSE_STATUSBAR
 
             node = m_Filters.GetFirst();
             while (node)
@@ -419,7 +446,10 @@ bool wxHtmlWindow::LoadPage(const wxString& location)
 
             delete f;
 
-            if (m_RelatedStatusBar != -1) m_RelatedFrame->SetStatusText(_("Done"), m_RelatedStatusBar);
+#if wxUSE_STATUSBAR
+            if (m_RelatedStatusBar != -1)
+                m_RelatedFrame->SetStatusText(_("Done"), m_RelatedStatusBar);
+#endif // wxUSE_STATUSBAR
         }
     }
 
@@ -466,7 +496,7 @@ bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
     if (!c)
     {
         wxLogWarning(_("HTML anchor %s does not exist."), anchor.c_str());
-        return FALSE;
+        return false;
     }
     else
     {
@@ -475,7 +505,7 @@ bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
         for (y = 0; c != NULL; c = c->GetParent()) y += c->GetPosY();
         Scroll(-1, y / wxHTML_SCROLL_STEP);
         m_OpenedAnchor = anchor;
-        return TRUE;
+        return true;
     }
 }
 
@@ -589,7 +619,7 @@ bool wxHtmlWindow::HistoryBack()
 {
     wxString a, l;
 
-    if (m_HistoryPos < 1) return FALSE;
+    if (m_HistoryPos < 1) return false;
 
     // store scroll position into history item:
     int x, y;
@@ -601,21 +631,21 @@ bool wxHtmlWindow::HistoryBack()
 
     l = (*m_History)[m_HistoryPos].GetPage();
     a = (*m_History)[m_HistoryPos].GetAnchor();
-    m_HistoryOn = FALSE;
+    m_HistoryOn = false;
     m_tmpCanDrawLocks++;
     if (a == wxEmptyString) LoadPage(l);
     else LoadPage(l + wxT("#") + a);
-    m_HistoryOn = TRUE;
+    m_HistoryOn = true;
     m_tmpCanDrawLocks--;
     Scroll(0, (*m_History)[m_HistoryPos].GetPos());
     Refresh();
-    return TRUE;
+    return true;
 }
 
 bool wxHtmlWindow::HistoryCanBack()
 {
-    if (m_HistoryPos < 1) return FALSE;
-    return TRUE ;
+    if (m_HistoryPos < 1) return false;
+    return true ;
 }
 
 
@@ -623,30 +653,30 @@ bool wxHtmlWindow::HistoryForward()
 {
     wxString a, l;
 
-    if (m_HistoryPos == -1) return FALSE;
-    if (m_HistoryPos >= (int)m_History->GetCount() - 1)return FALSE;
+    if (m_HistoryPos == -1) return false;
+    if (m_HistoryPos >= (int)m_History->GetCount() - 1)return false;
 
     m_OpenedPage = wxEmptyString; // this will disable adding new entry into history in LoadPage()
 
     m_HistoryPos++;
     l = (*m_History)[m_HistoryPos].GetPage();
     a = (*m_History)[m_HistoryPos].GetAnchor();
-    m_HistoryOn = FALSE;
+    m_HistoryOn = false;
     m_tmpCanDrawLocks++;
     if (a == wxEmptyString) LoadPage(l);
     else LoadPage(l + wxT("#") + a);
-    m_HistoryOn = TRUE;
+    m_HistoryOn = true;
     m_tmpCanDrawLocks--;
     Scroll(0, (*m_History)[m_HistoryPos].GetPos());
     Refresh();
-    return TRUE;
+    return true;
 }
 
 bool wxHtmlWindow::HistoryCanForward()
 {
-    if (m_HistoryPos == -1) return FALSE;
-    if (m_HistoryPos >= (int)m_History->GetCount() - 1)return FALSE;
-    return TRUE ;
+    if (m_HistoryPos == -1) return false;
+    if (m_HistoryPos >= (int)m_History->GetCount() - 1)return false;
+    return true ;
 }
 
 
@@ -728,19 +758,19 @@ bool wxHtmlWindow::IsSelectionEnabled() const
 
 
 #if wxUSE_CLIPBOARD
-wxString wxHtmlWindow::SelectionToText()
+wxString wxHtmlWindow::DoSelectionToText(wxHtmlSelection *sel)
 {
-    if ( !m_selection )
+    if ( !sel )
         return wxEmptyString;
 
     wxClientDC dc(this);
 
-    const wxHtmlCell *end = m_selection->GetToCell();
+    const wxHtmlCell *end = sel->GetToCell();
     wxString text;
-    wxHtmlTerminalCellsInterator i(m_selection->GetFromCell(), end);
+    wxHtmlTerminalCellsInterator i(sel->GetFromCell(), end);
     if ( i )
     {
-        text << i->ConvertToText(m_selection);
+        text << i->ConvertToText(sel);
         ++i;
     }
     const wxHtmlCell *prev = *i;
@@ -748,13 +778,25 @@ wxString wxHtmlWindow::SelectionToText()
     {
         if ( prev->GetParent() != i->GetParent() )
             text << _T('\n');
-        text << i->ConvertToText(*i == end ? m_selection : NULL);
+        text << i->ConvertToText(*i == end ? sel : NULL);
         prev = *i;
         ++i;
     }
     return text;
 }
 
+wxString wxHtmlWindow::ToText()
+{
+    if (m_Cell)
+    {
+        wxHtmlSelection sel;
+        sel.Set(m_Cell->GetFirstTerminal(), m_Cell->GetLastTerminal());
+        return DoSelectionToText(&sel);
+    }
+    else
+        return wxEmptyString;
+}
+
 #endif // wxUSE_CLIPBOARD
 
 bool wxHtmlWindow::CopySelection(ClipboardType t)
@@ -812,15 +854,47 @@ void wxHtmlWindow::OnCellMouseHover(wxHtmlCell * WXUNUSED(cell),
     // do nothing here
 }
 
-void wxHtmlWindow::OnEraseBackground(wxEraseEvent& WXUNUSED(event))
+void wxHtmlWindow::OnEraseBackground(wxEraseEvent& event)
 {
+    if ( !m_bmpBg.Ok() )
+    {
+        // 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;
+    }
+
+    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() )
+    {
+        dc.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
+        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 )
+    {
+        for ( wxCoord y = 0; y < sizeWin.y; y += sizeBmp.y )
+        {
+            dc.DrawBitmap(m_bmpBg, x, y, true /* use mask */);
+        }
+    }
 }
 
 void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
 {
     wxPaintDC dc(this);
 
-    if (m_tmpCanDrawLocks > 0 || m_Cell == NULL) return;
+    if (m_tmpCanDrawLocks > 0 || m_Cell == NULL)
+        return;
 
     int x, y;
     GetViewStart(&x, &y);
@@ -831,8 +905,25 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
     if ( !m_backBuffer )
         m_backBuffer = new wxBitmap(sz.x, sz.y);
     dcm.SelectObject(*m_backBuffer);
-    dcm.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
-    dcm.Clear();
+
+    if ( m_eraseBgInOnPaint )
+    {
+        dcm.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
+        dcm.Clear();
+
+        m_eraseBgInOnPaint = false;
+    }
+    else // someone has already erased the background, keep it
+    {
+        // 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());
+    }
+
     PrepareDC(dcm);
     dcm.SetMapMode(wxMM_TEXT);
     dcm.SetBackgroundMode(wxTRANSPARENT);
@@ -845,8 +936,8 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
                  y * wxHTML_SCROLL_STEP + rect.GetTop(),
                  y * wxHTML_SCROLL_STEP + rect.GetBottom(),
                  rinfo);
-             
-//#define DEBUG_HTML_SELECTION 
+
+//#define DEBUG_HTML_SELECTION
 #ifdef DEBUG_HTML_SELECTION
     {
     int xc, yc, x, y;
@@ -854,11 +945,11 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
     ScreenToClient(&xc, &yc);
     CalcUnscrolledPosition(xc, yc, &x, &y);
     wxHtmlCell *at = m_Cell->FindCellByPos(x, y);
-    wxHtmlCell *before = 
+    wxHtmlCell *before =
         m_Cell->FindCellByPos(x, y, wxHTML_FIND_NEAREST_BEFORE);
-    wxHtmlCell *after = 
+    wxHtmlCell *after =
         m_Cell->FindCellByPos(x, y, wxHTML_FIND_NEAREST_AFTER);
-    
+
     dcm.SetBrush(*wxTRANSPARENT_BRUSH);
     dcm.SetPen(*wxBLACK_PEN);
     if (at)
@@ -874,7 +965,7 @@ void wxHtmlWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
                           after->GetWidth()-4,after->GetHeight()-4);
     }
 #endif
+
     dcm.SetDeviceOrigin(0,0);
     dc.Blit(0, rect.GetTop(),
             sz.x, rect.GetBottom() - rect.GetTop() + 1,
@@ -976,7 +1067,7 @@ void wxHtmlWindow::OnMouseUp(wxMouseEvent& event)
 void wxHtmlWindow::OnInternalIdle()
 {
     wxWindow::OnInternalIdle();
-    
+
     if (m_tmpMouseMoved && (m_Cell != NULL))
     {
 #ifdef DEBUG_HTML_SELECTION
@@ -995,7 +1086,7 @@ void wxHtmlWindow::OnInternalIdle()
             if ( !m_tmpSelFromCell )
                 m_tmpSelFromCell = m_Cell->FindCellByPos(
                                          m_tmpSelFromPos.x,m_tmpSelFromPos.y);
-            
+
             // NB: a trick - we adjust selFromPos to be upper left or bottom
             //     right corner of the first cell of the selection depending
             //     on whether the mouse is moving to the right or to the left.
@@ -1017,7 +1108,7 @@ void wxHtmlWindow::OnInternalIdle()
                     dirFromPos.y += m_tmpSelFromCell->GetHeight();
                 }
             }
-            bool goingDown = dirFromPos.y < y || 
+            bool goingDown = dirFromPos.y < y ||
                              (dirFromPos.y == y && dirFromPos.x < x);
 
             // determine selection span:
@@ -1106,6 +1197,7 @@ void wxHtmlWindow::OnInternalIdle()
 
             if (lnk != m_tmpLastLink)
             {
+#if wxUSE_STATUSBAR
                 if (lnk == NULL)
                 {
                     if (m_RelatedStatusBar != -1)
@@ -1118,6 +1210,7 @@ void wxHtmlWindow::OnInternalIdle()
                         m_RelatedFrame->SetStatusText(lnk->GetHref(),
                                                       m_RelatedStatusBar);
                 }
+#endif // wxUSE_STATUSBAR
                 m_tmpLastLink = lnk;
             }
 
@@ -1129,7 +1222,7 @@ void wxHtmlWindow::OnInternalIdle()
                 OnCellMouseHover(cell, x, y);
         }
 
-        m_tmpMouseMoved = FALSE;
+        m_tmpMouseMoved = false;
     }
 }
 
@@ -1336,18 +1429,18 @@ IMPLEMENT_DYNAMIC_CLASS_XTI(wxHtmlWindow, wxScrolledWindow,"wx/html/htmlwin.h")
 
 wxBEGIN_PROPERTIES_TABLE(wxHtmlWindow)
 /*
-       TODO PROPERTIES
-               style , wxHW_SCROLLBAR_AUTO
-               borders , (dimension)
-               url , string
-               htmlcode , string
+    TODO PROPERTIES
+        style , wxHW_SCROLLBAR_AUTO
+        borders , (dimension)
+        url , string
+        htmlcode , string
 */
 wxEND_PROPERTIES_TABLE()
 
 wxBEGIN_HANDLERS_TABLE(wxHtmlWindow)
 wxEND_HANDLERS_TABLE()
 
-wxCONSTRUCTOR_5( wxHtmlWindow , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle ) 
+wxCONSTRUCTOR_5( wxHtmlWindow , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
 #else
 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)
 #endif
@@ -1382,7 +1475,7 @@ class wxHtmlWinModule: public wxModule
 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule)
 public:
     wxHtmlWinModule() : wxModule() {}
-    bool OnInit() { return TRUE; }
+    bool OnInit() { return true; }
     void OnExit() { wxHtmlWindow::CleanUpStatics(); }
 };