]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/htmllbox.cpp
basic blitting implementation
[wxWidgets.git] / src / generic / htmllbox.cpp
index c38650ba37e3188a203c27e9f9ebbe38e91e6ee5..b104f3c2f5feb34446b20f9aefa701dbe7954519 100644 (file)
 #endif
 
 #ifndef WX_PRECOMP
+    #include "wx/dcclient.h"
 #endif //WX_PRECOMP
 
+#if wxUSE_HTML
+
 #include "wx/htmllbox.h"
 
 #include "wx/html/htmlcell.h"
 #include "wx/html/winpars.h"
 
+// this hack forces the linker to always link in m_* files
+#include "wx/html/forcelnk.h"
+FORCE_WXHTML_MODULES()
+
+// ----------------------------------------------------------------------------
+// constants
 // ----------------------------------------------------------------------------
+
+// small border always added to the cells:
+static const wxCoord CELL_BORDER = 2;
+
+// ============================================================================
 // private classes
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxHtmlListBoxCache
 // ----------------------------------------------------------------------------
 
 // this class is used by wxHtmlListBox to cache the parsed representation of
 // the items to avoid doing it anew each time an item must be drawn
-//
-// TODO: extend the class to cache more than item
 class wxHtmlListBoxCache
 {
+private:
+    // invalidate a single item, used by Clear() and InvalidateRange()
+    void InvalidateItem(size_t n)
+    {
+        m_items[n] = (size_t)-1;
+        delete m_cells[n];
+        m_cells[n] = NULL;
+    }
+
 public:
-    wxHtmlListBoxCache() { m_cell = NULL; }
-    ~wxHtmlListBoxCache() { delete m_cell; }
+    wxHtmlListBoxCache()
+    {
+        for ( size_t n = 0; n < SIZE; n++ )
+        {
+            m_items[n] = (size_t)-1;
+            m_cells[n] = NULL;
+        }
+
+        m_next = 0;
+    }
+
+    ~wxHtmlListBoxCache()
+    {
+        for ( size_t n = 0; n < SIZE; n++ )
+        {
+            delete m_cells[n];
+        }
+    }
+
+    // completely invalidate the cache
+    void Clear()
+    {
+        for ( size_t n = 0; n < SIZE; n++ )
+        {
+            InvalidateItem(n);
+        }
+    }
+
+    // return the cached cell for this index or NULL if none
+    wxHtmlCell *Get(size_t item) const
+    {
+        for ( size_t n = 0; n < SIZE; n++ )
+        {
+            if ( m_items[n] == item )
+                return m_cells[n];
+        }
+
+        return NULL;
+    }
 
     // returns true if we already have this item cached
-    bool Has(size_t n) const { return m_cell && n == m_item; }
+    bool Has(size_t item) const { return Get(item) != NULL; }
 
     // ensure that the item is cached
-    void Store(size_t n, wxHtmlCell *cell)
+    void Store(size_t item, wxHtmlCell *cell)
     {
-        m_item = n;
+        delete m_cells[m_next];
+        m_cells[m_next] = cell;
+        m_items[m_next] = item;
 
-        delete m_cell;
-        m_cell = cell;
+        // advance to the next item wrapping around if there are no more
+        if ( ++m_next == SIZE )
+            m_next = 0;
     }
 
-    // return the cached cell for this index or NULL if none
-    wxHtmlCell *Get(size_t n) const
+    // forget the cached value of the item(s) between the given ones (inclusive)
+    void InvalidateRange(size_t from, size_t to)
     {
-        // we could be reading uninitialized m_item here but the code is still
-        // correct
-        return n == m_item ? m_cell : NULL;
+        for ( size_t n = 0; n < SIZE; n++ )
+        {
+            if ( m_items[n] >= from && m_items[n] <= to )
+            {
+                InvalidateItem(n);
+            }
+        }
     }
 
 private:
+    // the max number of the items we cache
+    enum { SIZE = 50 };
+
+    // the index of the LRU (oldest) cell
+    size_t m_next;
+
     // the parsed representation of the cached item or NULL
-    wxHtmlCell *m_cell;
+    wxHtmlCell *m_cells[SIZE];
 
-    // the index of the currently cached item (only valid if m_cell != NULL)
-    size_t m_item;
+    // the index of the currently cached item (only valid if m_cells != NULL)
+    size_t m_items[SIZE];
 };
 
+// ----------------------------------------------------------------------------
+// wxHtmlListBoxStyle
+// ----------------------------------------------------------------------------
+
+// just forward wxDefaultHtmlRenderingStyle callbacks to the main class so that
+// they could be overridden by the user code
+class wxHtmlListBoxStyle : public wxDefaultHtmlRenderingStyle
+{
+public:
+    wxHtmlListBoxStyle(const wxHtmlListBox& hlbox) : m_hlbox(hlbox) { }
+
+    virtual wxColour GetSelectedTextColour(const wxColour& colFg)
+    {
+        return m_hlbox.GetSelectedTextColour(colFg);
+    }
+
+    virtual wxColour GetSelectedTextBgColour(const wxColour& colBg)
+    {
+        return m_hlbox.GetSelectedTextBgColour(colBg);
+    }
+
+private:
+    const wxHtmlListBox& m_hlbox;
+
+    DECLARE_NO_COPY_CLASS(wxHtmlListBoxStyle)
+};
+
+// ----------------------------------------------------------------------------
+// event tables
+// ----------------------------------------------------------------------------
+
+BEGIN_EVENT_TABLE(wxHtmlListBox, wxVListBox)
+    EVT_SIZE(wxHtmlListBox::OnSize)
+    EVT_MOTION(wxHtmlListBox::OnMouseMove)
+    EVT_LEFT_DOWN(wxHtmlListBox::OnLeftDown)
+END_EVENT_TABLE()
+
 // ============================================================================
 // implementation
 // ============================================================================
 
+IMPLEMENT_ABSTRACT_CLASS(wxHtmlListBox, wxVListBox)
+
+
 // ----------------------------------------------------------------------------
 // wxHtmlListBox creation
 // ----------------------------------------------------------------------------
 
+wxHtmlListBox::wxHtmlListBox()
+    : wxHtmlWindowMouseHelper(this)
+{
+    Init();
+}
+
+// normal constructor which calls Create() internally
+wxHtmlListBox::wxHtmlListBox(wxWindow *parent,
+                             wxWindowID id,
+                             const wxPoint& pos,
+                             const wxSize& size,
+                             long style,
+                             const wxString& name)
+    : wxHtmlWindowMouseHelper(this)
+{
+    Init();
+
+    (void)Create(parent, id, pos, size, style, name);
+}
+
 void wxHtmlListBox::Init()
 {
     m_htmlParser = NULL;
+    m_htmlRendStyle = new wxHtmlListBoxStyle(*this);
     m_cache = new wxHtmlListBoxCache;
 }
 
@@ -92,21 +228,39 @@ bool wxHtmlListBox::Create(wxWindow *parent,
                            wxWindowID id,
                            const wxPoint& pos,
                            const wxSize& size,
-                           size_t countItems,
                            long style,
                            const wxString& name)
 {
-    return wxVListBox::Create(parent, id, pos, size, countItems, style, name);
+    return wxVListBox::Create(parent, id, pos, size, style, name);
 }
 
 wxHtmlListBox::~wxHtmlListBox()
 {
     delete m_cache;
+
     if ( m_htmlParser )
     {
         delete m_htmlParser->GetDC();
         delete m_htmlParser;
     }
+
+    delete m_htmlRendStyle;
+}
+
+// ----------------------------------------------------------------------------
+// wxHtmlListBox appearance
+// ----------------------------------------------------------------------------
+
+wxColour wxHtmlListBox::GetSelectedTextColour(const wxColour& colFg) const
+{
+    return m_htmlRendStyle->
+                wxDefaultHtmlRenderingStyle::GetSelectedTextColour(colFg);
+}
+
+wxColour
+wxHtmlListBox::GetSelectedTextBgColour(const wxColour& WXUNUSED(colBg)) const
+{
+    return GetSelectionBackground();
 }
 
 // ----------------------------------------------------------------------------
@@ -121,6 +275,10 @@ wxString wxHtmlListBox::OnGetItemMarkup(size_t n) const
     return OnGetItem(n);
 }
 
+// ----------------------------------------------------------------------------
+// wxHtmlListBox cache handling
+// ----------------------------------------------------------------------------
+
 void wxHtmlListBox::CacheItem(size_t n) const
 {
     if ( !m_cache->Has(n) )
@@ -129,20 +287,65 @@ void wxHtmlListBox::CacheItem(size_t n) const
         {
             wxHtmlListBox *self = wxConstCast(this, wxHtmlListBox);
 
-            self->m_htmlParser = new wxHtmlWinParser;
+            self->m_htmlParser = new wxHtmlWinParser(self);
             m_htmlParser->SetDC(new wxClientDC(self));
+            m_htmlParser->SetFS(&self->m_filesystem);
+
+            // use system's default GUI font by default:
+            m_htmlParser->SetStandardFonts();
         }
 
         wxHtmlContainerCell *cell = (wxHtmlContainerCell *)m_htmlParser->
                 Parse(OnGetItemMarkup(n));
         wxCHECK_RET( cell, _T("wxHtmlParser::Parse() returned NULL?") );
 
-        cell->Layout(GetClientSize().x);
+        // set the cell's ID to item's index so that CellCoordsToPhysical()
+        // can quickly find the item:
+        cell->SetId(wxString::Format(_T("%lu"), (unsigned long)n));
+
+        cell->Layout(GetClientSize().x - 2*GetMargins().x);
 
         m_cache->Store(n, cell);
     }
 }
 
+void wxHtmlListBox::OnSize(wxSizeEvent& event)
+{
+    // we need to relayout all the cached cells
+    m_cache->Clear();
+
+    event.Skip();
+}
+
+void wxHtmlListBox::RefreshLine(size_t line)
+{
+    m_cache->InvalidateRange(line, line);
+
+    wxVListBox::RefreshLine(line);
+}
+
+void wxHtmlListBox::RefreshLines(size_t from, size_t to)
+{
+    m_cache->InvalidateRange(from, to);
+
+    wxVListBox::RefreshLines(from, to);
+}
+
+void wxHtmlListBox::RefreshAll()
+{
+    m_cache->Clear();
+
+    wxVListBox::RefreshAll();
+}
+
+void wxHtmlListBox::SetItemCount(size_t count)
+{
+    // the items are going to change, forget the old ones
+    m_cache->Clear();
+
+    wxVListBox::SetItemCount(count);
+}
+
 // ----------------------------------------------------------------------------
 // wxHtmlListBox implementation of wxVListBox pure virtuals
 // ----------------------------------------------------------------------------
@@ -154,23 +357,25 @@ void wxHtmlListBox::OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const
     wxHtmlCell *cell = m_cache->Get(n);
     wxCHECK_RET( cell, _T("this cell should be cached!") );
 
+    wxHtmlRenderingInfo htmlRendInfo;
+
     // draw the selected cell in selected state
     if ( IsSelected(n) )
     {
         wxHtmlSelection htmlSel;
-        htmlSel.Set(wxPoint(0, 0), cell, wxPoint(INT_MAX, INT_MAX), cell);
-        wxHtmlRenderingState htmlRendState(&htmlSel);
-        htmlRendState.SetSelectionState(wxHTML_SEL_IN);
-        cell->Draw(dc, rect.x, rect.y, 0, INT_MAX, htmlRendState);
-    }
-    else
-    {
-        // note that we can't stop drawing exactly at the window boundary as then
-        // even the visible cells part could be not drawn, so always draw the
-        // entire cell
-        wxHtmlRenderingState htmlRendState(NULL);
-        cell->Draw(dc, rect.x, rect.y, 0, INT_MAX, htmlRendState);
+        htmlSel.Set(wxPoint(0,0), cell, wxPoint(INT_MAX, INT_MAX), cell);
+        htmlRendInfo.SetSelection(&htmlSel);
+        if ( m_htmlRendStyle )
+            htmlRendInfo.SetStyle(m_htmlRendStyle);
+        htmlRendInfo.GetState().SetSelectionState(wxHTML_SEL_IN);
     }
+
+    // note that we can't stop drawing exactly at the window boundary as then
+    // even the visible cells part could be not drawn, so always draw the
+    // entire cell
+    cell->Draw(dc,
+               rect.x + CELL_BORDER, rect.y + CELL_BORDER,
+               0, INT_MAX, htmlRendInfo);
 }
 
 wxCoord wxHtmlListBox::OnMeasureItem(size_t n) const
@@ -180,6 +385,160 @@ wxCoord wxHtmlListBox::OnMeasureItem(size_t n) const
     wxHtmlCell *cell = m_cache->Get(n);
     wxCHECK_MSG( cell, 0, _T("this cell should be cached!") );
 
-    return cell->GetHeight() + cell->GetDescent();
+    return cell->GetHeight() + cell->GetDescent() + 4;
+}
+
+// ----------------------------------------------------------------------------
+// wxHtmlListBox implementation of wxHtmlListBoxWinInterface
+// ----------------------------------------------------------------------------
+
+void wxHtmlListBox::SetHTMLWindowTitle(const wxString& WXUNUSED(title))
+{
+    // nothing to do
+}
+
+void wxHtmlListBox::OnHTMLLinkClicked(const wxHtmlLinkInfo& link)
+{
+    OnLinkClicked(GetItemForCell(link.GetHtmlCell()), link);
+}
+
+wxHtmlOpeningStatus
+wxHtmlListBox::OnHTMLOpeningURL(wxHtmlURLType WXUNUSED(type),
+                                const wxString& WXUNUSED(url),
+                                wxString *WXUNUSED(redirect)) const
+{
+    return wxHTML_OPEN;
+}
+
+wxPoint wxHtmlListBox::HTMLCoordsToWindow(wxHtmlCell *cell,
+                                          const wxPoint& pos) const
+{
+    return CellCoordsToPhysical(pos, cell);
+}
+
+wxWindow* wxHtmlListBox::GetHTMLWindow() { return this; }
+
+wxColour wxHtmlListBox::GetHTMLBackgroundColour() const
+{
+    return GetBackgroundColour();
+}
+
+void wxHtmlListBox::SetHTMLBackgroundColour(const wxColour& WXUNUSED(clr))
+{
+    // nothing to do
+}
+
+void wxHtmlListBox::SetHTMLBackgroundImage(const wxBitmap& WXUNUSED(bmpBg))
+{
+    // nothing to do
+}
+
+void wxHtmlListBox::SetHTMLStatusText(const wxString& WXUNUSED(text))
+{
+    // nothing to do
+}
+
+wxCursor wxHtmlListBox::GetHTMLCursor(HTMLCursor type) const
+{
+    // we don't want to show text selection cursor in listboxes
+    if (type == HTMLCursor_Text)
+        return wxHtmlWindow::GetDefaultHTMLCursor(HTMLCursor_Default);
+
+    // in all other cases, use the same cursor as wxHtmlWindow:
+    return wxHtmlWindow::GetDefaultHTMLCursor(type);
+}
+
+// ----------------------------------------------------------------------------
+// wxHtmlListBox handling of HTML links
+// ----------------------------------------------------------------------------
+
+wxPoint wxHtmlListBox::GetRootCellCoords(size_t n) const
+{
+    wxPoint pos(CELL_BORDER, CELL_BORDER);
+    pos += GetMargins();
+    pos.y += GetLinesHeight(GetFirstVisibleLine(), n);
+    return pos;
+}
+
+bool wxHtmlListBox::PhysicalCoordsToCell(wxPoint& pos, wxHtmlCell*& cell) const
+{
+    int n = HitTest(pos);
+    if ( n == wxNOT_FOUND )
+        return false;
+
+    // convert mouse coordinates to coords relative to item's wxHtmlCell:
+    pos -= GetRootCellCoords(n);
+
+    CacheItem(n);
+    cell = m_cache->Get(n);
+
+    return true;
+}
+
+size_t wxHtmlListBox::GetItemForCell(const wxHtmlCell *cell) const
+{
+    wxCHECK_MSG( cell, 0, _T("no cell") );
+
+    cell = cell->GetRootCell();
+
+    wxCHECK_MSG( cell, 0, _T("no root cell") );
+
+    // the cell's ID contains item index, see CacheItem():
+    unsigned long n;
+    if ( !cell->GetId().ToULong(&n) )
+    {
+        wxFAIL_MSG( _T("unexpected root cell's ID") );
+        return 0;
+    }
+
+    return n;
+}
+
+wxPoint
+wxHtmlListBox::CellCoordsToPhysical(const wxPoint& pos, wxHtmlCell *cell) const
+{
+    return pos + GetRootCellCoords(GetItemForCell(cell));
+}
+
+void wxHtmlListBox::OnInternalIdle()
+{
+    wxVListBox::OnInternalIdle();
+
+    if ( wxHtmlWindowMouseHelper::DidMouseMove() )
+    {
+        wxPoint pos = ScreenToClient(wxGetMousePosition());
+        wxHtmlCell *cell;
+
+        if ( !PhysicalCoordsToCell(pos, cell) )
+            return;
+
+        wxHtmlWindowMouseHelper::HandleIdle(cell, pos);
+    }
+}
+
+void wxHtmlListBox::OnMouseMove(wxMouseEvent& event)
+{
+    wxHtmlWindowMouseHelper::HandleMouseMoved();
+    event.Skip();
+}
+
+void wxHtmlListBox::OnLeftDown(wxMouseEvent& event)
+{
+    wxPoint pos = event.GetPosition();
+    wxHtmlCell *cell;
+
+    if ( !PhysicalCoordsToCell(pos, cell) )
+    {
+        event.Skip();
+        return;
+    }
+
+    if ( !wxHtmlWindowMouseHelper::HandleMouseClick(cell, pos, event) )
+    {
+        // no link was clicked, so let the listbox code handle the click (e.g.
+        // by selecting another item in the list):
+        event.Skip();
+    }
 }
 
+#endif // wxUSE_HTML