Return NULL from wxWindow::GetCapture() when the capture is being lost.

[wxWidgets.git] / src / generic / htmllbox.cpp

diff --git a/src/generic/htmllbox.cpp b/src/generic/htmllbox.cpp
index dff147a45c6dc1592f97622051e2e30aca336b00..178f8c44ef431cf7c9304ecf587352b3fb70f5f7 100644 (file)
--- a/src/generic/htmllbox.cpp
+++ b/src/generic/htmllbox.cpp
@@ -1,12 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        generic/htmllbox.cpp
+// Name:        src/generic/htmllbox.cpp

 // Purpose:     implementation of wxHtmlListBox
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     31.05.03
 // Purpose:     implementation of wxHtmlListBox
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     31.05.03

-// RCS-ID:      $Id$

 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>

-// License:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -28,6 +27,8 @@
     #include "wx/dcclient.h"
 #endif //WX_PRECOMP
 
     #include "wx/dcclient.h"
 #endif //WX_PRECOMP
 

+#if wxUSE_HTML
+

 #include "wx/htmllbox.h"
 
 #include "wx/html/htmlcell.h"
 #include "wx/htmllbox.h"
 
 #include "wx/html/htmlcell.h"


@@ -37,6 +38,16 @@
 #include "wx/html/forcelnk.h"
 FORCE_WXHTML_MODULES()
 
 #include "wx/html/forcelnk.h"
 FORCE_WXHTML_MODULES()
 

+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// small border always added to the cells:
+static const wxCoord CELL_BORDER = 2;
+
+const char wxHtmlListBoxNameStr[] = "htmlListBox";
+const char wxSimpleHtmlListBoxNameStr[] = "simpleHtmlListBox";
+

 // ============================================================================
 // private classes
 // ============================================================================
 // ============================================================================
 // private classes
 // ============================================================================


@@ -49,6 +60,14 @@ FORCE_WXHTML_MODULES()
 // the items to avoid doing it anew each time an item must be drawn
 class wxHtmlListBoxCache
 {
 // the items to avoid doing it anew each time an item must be drawn
 class wxHtmlListBoxCache
 {

+private:
+    // invalidate a single item, used by Clear() and InvalidateRange()
+    void InvalidateItem(size_t n)
+    {
+        m_items[n] = (size_t)-1;
+        wxDELETE(m_cells[n]);
+    }
+

 public:
     wxHtmlListBoxCache()
     {
 public:
     wxHtmlListBoxCache()
     {


@@ -74,9 +93,7 @@ public:
     {
         for ( size_t n = 0; n < SIZE; n++ )
         {
     {
         for ( size_t n = 0; n < SIZE; n++ )
         {

-            m_items[n] = (size_t)-1;
-            delete m_cells[n];
-            m_cells[n] = NULL;
+            InvalidateItem(n);

         }
     }
 
         }
     }
 


@@ -107,6 +124,18 @@ public:
             m_next = 0;
     }
 
             m_next = 0;
     }
 

+    // forget the cached value of the item(s) between the given ones (inclusive)
+    void InvalidateRange(size_t from, size_t to)
+    {
+        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 };
 private:
     // the max number of the items we cache
     enum { SIZE = 50 };


@@ -130,22 +159,38 @@ private:
 class wxHtmlListBoxStyle : public wxDefaultHtmlRenderingStyle
 {
 public:
 class wxHtmlListBoxStyle : public wxDefaultHtmlRenderingStyle
 {
 public:

-    wxHtmlListBoxStyle(wxHtmlListBox& hlbox) : m_hlbox(hlbox) { }
+    wxHtmlListBoxStyle(const wxHtmlListBox& hlbox) : m_hlbox(hlbox) { }

 
     virtual wxColour GetSelectedTextColour(const wxColour& colFg)
     {
 
     virtual wxColour GetSelectedTextColour(const wxColour& colFg)
     {

-        return m_hlbox.GetSelectedTextColour(colFg);
+        // by default wxHtmlListBox doesn't implement GetSelectedTextColour()
+        // and returns wxNullColour from it, so use the default HTML colour for
+        // selection
+        wxColour col = m_hlbox.GetSelectedTextColour(colFg);
+        if ( !col.IsOk() )
+        {
+            col = wxDefaultHtmlRenderingStyle::GetSelectedTextColour(colFg);
+        }
+
+        return col;

     }
 
     virtual wxColour GetSelectedTextBgColour(const wxColour& colBg)
     {
     }
 
     virtual wxColour GetSelectedTextBgColour(const wxColour& colBg)
     {

-        return m_hlbox.GetSelectedTextBgColour(colBg);
+        wxColour col = m_hlbox.GetSelectedTextBgColour(colBg);
+        if ( !col.IsOk() )
+        {
+            col = wxDefaultHtmlRenderingStyle::GetSelectedTextBgColour(colBg);
+        }
+
+        return col;

     }
 
 private:
     const wxHtmlListBox& m_hlbox;
     }
 
 private:
     const wxHtmlListBox& m_hlbox;

-};

 
 

+    wxDECLARE_NO_COPY_CLASS(wxHtmlListBoxStyle);
+};

 
 // ----------------------------------------------------------------------------
 // event tables
 
 // ----------------------------------------------------------------------------
 // event tables


@@ -153,16 +198,41 @@ private:
 
 BEGIN_EVENT_TABLE(wxHtmlListBox, wxVListBox)
     EVT_SIZE(wxHtmlListBox::OnSize)
 
 BEGIN_EVENT_TABLE(wxHtmlListBox, wxVListBox)
     EVT_SIZE(wxHtmlListBox::OnSize)

+    EVT_MOTION(wxHtmlListBox::OnMouseMove)
+    EVT_LEFT_DOWN(wxHtmlListBox::OnLeftDown)

 END_EVENT_TABLE()
 
 // ============================================================================
 // implementation
 // ============================================================================
 
 END_EVENT_TABLE()
 
 // ============================================================================
 // implementation
 // ============================================================================
 

+IMPLEMENT_ABSTRACT_CLASS(wxHtmlListBox, wxVListBox)
+
+

 // ----------------------------------------------------------------------------
 // wxHtmlListBox creation
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // 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;
 void wxHtmlListBox::Init()
 {
     m_htmlParser = NULL;


@@ -197,10 +267,10 @@ wxHtmlListBox::~wxHtmlListBox()
 // wxHtmlListBox appearance
 // ----------------------------------------------------------------------------
 
 // wxHtmlListBox appearance
 // ----------------------------------------------------------------------------
 

-wxColour wxHtmlListBox::GetSelectedTextColour(const wxColour& colFg) const
+wxColour
+wxHtmlListBox::GetSelectedTextColour(const wxColour& WXUNUSED(colFg)) const

 {
 {

-    return m_htmlRendStyle->
-                wxDefaultHtmlRenderingStyle::GetSelectedTextColour(colFg);
+    return wxNullColour;

 }
 
 wxColour
 }
 
 wxColour


@@ -233,13 +303,24 @@ void wxHtmlListBox::CacheItem(size_t n) const
         {
             wxHtmlListBox *self = wxConstCast(this, wxHtmlListBox);
 
         {
             wxHtmlListBox *self = wxConstCast(this, wxHtmlListBox);
 

-            self->m_htmlParser = new wxHtmlWinParser;
+            self->m_htmlParser = new wxHtmlWinParser(self);

             m_htmlParser->SetDC(new wxClientDC(self));
             m_htmlParser->SetDC(new wxClientDC(self));

+            m_htmlParser->SetFS(&self->m_filesystem);
+#if !wxUSE_UNICODE
+            if (GetFont().IsOk())
+                m_htmlParser->SetInputEncoding(GetFont().GetEncoding());
+#endif
+            // use system's default GUI font by default:
+            m_htmlParser->SetStandardFonts();

         }
 
         wxHtmlContainerCell *cell = (wxHtmlContainerCell *)m_htmlParser->
                 Parse(OnGetItemMarkup(n));
         }
 
         wxHtmlContainerCell *cell = (wxHtmlContainerCell *)m_htmlParser->
                 Parse(OnGetItemMarkup(n));

-        wxCHECK_RET( cell, _T("wxHtmlParser::Parse() returned NULL?") );
+        wxCHECK_RET( cell, wxT("wxHtmlParser::Parse() returned NULL?") );
+
+        // set the cell's ID to item's index so that CellCoordsToPhysical()
+        // can quickly find the item:
+        cell->SetId(wxString::Format(wxT("%lu"), (unsigned long)n));

 
         cell->Layout(GetClientSize().x - 2*GetMargins().x);
 
 
         cell->Layout(GetClientSize().x - 2*GetMargins().x);
 


@@ -255,6 +336,20 @@ void wxHtmlListBox::OnSize(wxSizeEvent& event)
     event.Skip();
 }
 
     event.Skip();
 }
 

+void wxHtmlListBox::RefreshRow(size_t line)
+{
+    m_cache->InvalidateRange(line, line);
+
+    wxVListBox::RefreshRow(line);
+}
+
+void wxHtmlListBox::RefreshRows(size_t from, size_t to)
+{
+    m_cache->InvalidateRange(from, to);
+
+    wxVListBox::RefreshRows(from, to);
+}
+

 void wxHtmlListBox::RefreshAll()
 {
     m_cache->Clear();
 void wxHtmlListBox::RefreshAll()
 {
     m_cache->Clear();


@@ -274,30 +369,58 @@ void wxHtmlListBox::SetItemCount(size_t count)
 // wxHtmlListBox implementation of wxVListBox pure virtuals
 // ----------------------------------------------------------------------------
 
 // wxHtmlListBox implementation of wxVListBox pure virtuals
 // ----------------------------------------------------------------------------
 

+void
+wxHtmlListBox::OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const
+{
+    if ( IsSelected(n) )
+    {
+        if ( DoDrawSolidBackground
+             (
+                GetSelectedTextBgColour(GetBackgroundColour()),
+                dc,
+                rect,
+                n
+             ) )
+        {
+            return;
+        }
+        //else: no custom selection background colour, use base class version
+    }
+
+    wxVListBox::OnDrawBackground(dc, rect, n);
+}
+

 void wxHtmlListBox::OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const
 {
     CacheItem(n);
 
     wxHtmlCell *cell = m_cache->Get(n);
 void wxHtmlListBox::OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const
 {
     CacheItem(n);
 
     wxHtmlCell *cell = m_cache->Get(n);

-    wxCHECK_RET( cell, _T("this cell should be cached!") );
+    wxCHECK_RET( cell, wxT("this cell should be cached!") );

 
     wxHtmlRenderingInfo htmlRendInfo;
 
 
     wxHtmlRenderingInfo htmlRendInfo;
 

-    // draw the selected cell in selected state
-    if ( IsSelected(n) )
+    // draw the selected cell in selected state ourselves if we're using custom
+    // colours (to test for this, check the callbacks by passing them any dummy
+    // (but valid, to avoid asserts) colour):
+    if ( IsSelected(n) &&
+            (GetSelectedTextColour(*wxBLACK).IsOk() ||
+             GetSelectedTextBgColour(*wxWHITE).IsOk()) )

     {
         wxHtmlSelection htmlSel;
     {
         wxHtmlSelection htmlSel;

-        htmlSel.Set(wxPoint(0, 0), cell, wxPoint(INT_MAX, INT_MAX), cell);
+        htmlSel.Set(wxPoint(0,0), cell, wxPoint(INT_MAX, INT_MAX), cell);

         htmlRendInfo.SetSelection(&htmlSel);
         htmlRendInfo.SetSelection(&htmlSel);

-        if ( m_htmlRendStyle )
-            htmlRendInfo.SetStyle(m_htmlRendStyle);
+        htmlRendInfo.SetStyle(m_htmlRendStyle);

         htmlRendInfo.GetState().SetSelectionState(wxHTML_SEL_IN);
     }
         htmlRendInfo.GetState().SetSelectionState(wxHTML_SEL_IN);
     }

+    //else: normal item or selected item with default colours, its background
+    //      was already taken care of in the base class

 
     // 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
 
     // 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, rect.y, 0, INT_MAX, htmlRendInfo);
+    cell->Draw(dc,
+               rect.x + CELL_BORDER, rect.y + CELL_BORDER,
+               0, INT_MAX, htmlRendInfo);

 }
 
 wxCoord wxHtmlListBox::OnMeasureItem(size_t n) const
 }
 
 wxCoord wxHtmlListBox::OnMeasureItem(size_t n) const


@@ -305,8 +428,296 @@ wxCoord wxHtmlListBox::OnMeasureItem(size_t n) const
     CacheItem(n);
 
     wxHtmlCell *cell = m_cache->Get(n);
     CacheItem(n);
 
     wxHtmlCell *cell = m_cache->Get(n);

-    wxCHECK_MSG( cell, 0, _T("this cell should be cached!") );
+    wxCHECK_MSG( cell, 0, wxT("this cell should be cached!") );
+
+    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);
+}
+
+void wxHtmlListBox::OnLinkClicked(size_t WXUNUSED(n),
+                                  const wxHtmlLinkInfo& link)
+{
+    wxHtmlLinkEvent event(GetId(), link);
+    GetEventHandler()->ProcessEvent(event);
+}
+
+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
+// ----------------------------------------------------------------------------

 
 

-    return cell->GetHeight() + cell->GetDescent();
+wxPoint wxHtmlListBox::GetRootCellCoords(size_t n) const
+{
+    wxPoint pos(CELL_BORDER, CELL_BORDER);
+    pos += GetMargins();
+    pos.y += GetRowsHeight(GetVisibleBegin(), n);
+    return pos;
+}
+
+bool wxHtmlListBox::PhysicalCoordsToCell(wxPoint& pos, wxHtmlCell*& cell) const
+{
+    int n = VirtualHitTest(pos.y);
+    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, wxT("no cell") );
+
+    cell = cell->GetRootCell();
+
+    wxCHECK_MSG( cell, 0, wxT("no root cell") );
+
+    // the cell's ID contains item index, see CacheItem():
+    unsigned long n;
+    if ( !cell->GetId().ToULong(&n) )
+    {
+        wxFAIL_MSG( wxT("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();
+    }
+}
+
+
+// ----------------------------------------------------------------------------
+// wxSimpleHtmlListBox
+// ----------------------------------------------------------------------------
+
+IMPLEMENT_ABSTRACT_CLASS(wxSimpleHtmlListBox, wxHtmlListBox)
+
+
+bool wxSimpleHtmlListBox::Create(wxWindow *parent, wxWindowID id,
+                                 const wxPoint& pos,
+                                 const wxSize& size,
+                                 int n, const wxString choices[],
+                                 long style,
+                                 const wxValidator& validator,
+                                 const wxString& name)
+{
+    if (!wxHtmlListBox::Create(parent, id, pos, size, style, name))
+        return false;
+
+#if wxUSE_VALIDATORS
+    SetValidator(validator);
+#endif
+
+    Append(n, choices);
+
+    return true;
+}
+
+bool wxSimpleHtmlListBox::Create(wxWindow *parent, wxWindowID id,
+                                 const wxPoint& pos,
+                                 const wxSize& size,
+                                 const wxArrayString& choices,
+                                 long style,
+                                 const wxValidator& validator,
+                                 const wxString& name)
+{
+    if (!wxHtmlListBox::Create(parent, id, pos, size, style, name))
+        return false;
+
+#if wxUSE_VALIDATORS
+    SetValidator(validator);
+#endif
+
+    Append(choices);
+
+    return true;
+}
+
+wxSimpleHtmlListBox::~wxSimpleHtmlListBox()
+{
+    wxItemContainer::Clear();
+}
+
+void wxSimpleHtmlListBox::DoClear()
+{
+    wxASSERT(m_items.GetCount() == m_HTMLclientData.GetCount());
+
+    m_items.Clear();
+    m_HTMLclientData.Clear();
+
+    UpdateCount();
+}
+
+void wxSimpleHtmlListBox::Clear()
+{
+    DoClear();
+}
+
+void wxSimpleHtmlListBox::DoDeleteOneItem(unsigned int n)
+{
+    m_items.RemoveAt(n);
+
+    m_HTMLclientData.RemoveAt(n);
+
+    UpdateCount();
+}
+
+int wxSimpleHtmlListBox::DoInsertItems(const wxArrayStringsAdapter& items,
+                                       unsigned int pos,
+                                       void **clientData,
+                                       wxClientDataType type)
+{
+    const unsigned int count = items.GetCount();
+
+    m_items.Insert(wxEmptyString, pos, count);
+    m_HTMLclientData.Insert(NULL, pos, count);
+
+    for ( unsigned int i = 0; i < count; ++i, ++pos )
+    {
+        m_items[pos] = items[i];
+        AssignNewItemClientData(pos, clientData, i, type);
+    }
+
+    UpdateCount();
+
+    return pos - 1;
+}
+
+void wxSimpleHtmlListBox::SetString(unsigned int n, const wxString& s)
+{
+    wxCHECK_RET( IsValid(n),
+                 wxT("invalid index in wxSimpleHtmlListBox::SetString") );
+
+    m_items[n]=s;
+    RefreshRow(n);
+}
+
+wxString wxSimpleHtmlListBox::GetString(unsigned int n) const
+{
+    wxCHECK_MSG( IsValid(n), wxEmptyString,
+                 wxT("invalid index in wxSimpleHtmlListBox::GetString") );
+
+    return m_items[n];
+}
+
+void wxSimpleHtmlListBox::UpdateCount()
+{
+    wxASSERT(m_items.GetCount() == m_HTMLclientData.GetCount());
+    wxHtmlListBox::SetItemCount(m_items.GetCount());
+
+    // very small optimization: if you need to add lot of items to
+    // a wxSimpleHtmlListBox be sure to use the
+    // wxSimpleHtmlListBox::Append(const wxArrayString&) method instead!
+    if (!this->IsFrozen())
+        RefreshAll();

 }
 
 }
 

+#endif // wxUSE_HTML