src/generic/htmllbox.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/htmllbox.cpp
   3 // Purpose:     implementation of wxHtmlListBox
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     31.05.03
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 // License:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/dcclient.h"
  29 #endif //WX_PRECOMP
  30
  31 #include "wx/htmllbox.h"
  32
  33 #include "wx/html/htmlcell.h"
  34 #include "wx/html/winpars.h"
  35
  36 // this hack forces the linker to always link in m_* files
  37 #include "wx/html/forcelnk.h"
  38 FORCE_WXHTML_MODULES()
  39
  40 // ============================================================================
  41 // private classes
  42 // ============================================================================
  43
  44 // ----------------------------------------------------------------------------
  45 // wxHtmlListBoxCache
  46 // ----------------------------------------------------------------------------
  47
  48 // this class is used by wxHtmlListBox to cache the parsed representation of
  49 // the items to avoid doing it anew each time an item must be drawn
  50 class wxHtmlListBoxCache
  51 {
  52 public:
  53     wxHtmlListBoxCache()
  54     {
  55         for ( size_t n = 0; n < SIZE; n++ )
  56         {
  57             m_items[n] = (size_t)-1;
  58             m_cells[n] = NULL;
  59         }
  60
  61         m_next = 0;
  62     }
  63
  64     ~wxHtmlListBoxCache()
  65     {
  66         for ( size_t n = 0; n < SIZE; n++ )
  67         {
  68             delete m_cells[n];
  69         }
  70     }
  71
  72     // completely invalidate the cache
  73     void Clear()
  74     {
  75         for ( size_t n = 0; n < SIZE; n++ )
  76         {
  77             m_items[n] = (size_t)-1;
  78             delete m_cells[n];
  79             m_cells[n] = NULL;
  80         }
  81     }
  82
  83     // return the cached cell for this index or NULL if none
  84     wxHtmlCell *Get(size_t item) const
  85     {
  86         for ( size_t n = 0; n < SIZE; n++ )
  87         {
  88             if ( m_items[n] == item )
  89                 return m_cells[n];
  90         }
  91
  92         return NULL;
  93     }
  94
  95     // returns true if we already have this item cached
  96     bool Has(size_t item) const { return Get(item) != NULL; }
  97
  98     // ensure that the item is cached
  99     void Store(size_t item, wxHtmlCell *cell)
 100     {
 101         delete m_cells[m_next];
 102         m_cells[m_next] = cell;
 103         m_items[m_next] = item;
 104
 105         // advance to the next item wrapping around if there are no more
 106         if ( ++m_next == SIZE )
 107             m_next = 0;
 108     }
 109
 110 private:
 111     // the max number of the items we cache
 112     enum { SIZE = 50 };
 113
 114     // the index of the LRU (oldest) cell
 115     size_t m_next;
 116
 117     // the parsed representation of the cached item or NULL
 118     wxHtmlCell *m_cells[SIZE];
 119
 120     // the index of the currently cached item (only valid if m_cells != NULL)
 121     size_t m_items[SIZE];
 122 };
 123
 124 // ----------------------------------------------------------------------------
 125 // wxHtmlListBoxStyle
 126 // ----------------------------------------------------------------------------
 127
 128 // just forward wxDefaultHtmlRenderingStyle callbacks to the main class so that
 129 // they could be overridden by the user code
 130 class wxHtmlListBoxStyle : public wxDefaultHtmlRenderingStyle
 131 {
 132 public:
 133     wxHtmlListBoxStyle(wxHtmlListBox& hlbox) : m_hlbox(hlbox) { }
 134
 135     virtual wxColour GetSelectedTextColour(const wxColour& colFg)
 136     {
 137         return m_hlbox.GetSelectedTextColour(colFg);
 138     }
 139
 140     virtual wxColour GetSelectedTextBgColour(const wxColour& colBg)
 141     {
 142         return m_hlbox.GetSelectedTextBgColour(colBg);
 143     }
 144
 145 private:
 146     const wxHtmlListBox& m_hlbox;
 147
 148     DECLARE_NO_COPY_CLASS(wxHtmlListBoxStyle)
 149 };
 150
 151
 152 // ----------------------------------------------------------------------------
 153 // event tables
 154 // ----------------------------------------------------------------------------
 155
 156 BEGIN_EVENT_TABLE(wxHtmlListBox, wxVListBox)
 157     EVT_SIZE(wxHtmlListBox::OnSize)
 158 END_EVENT_TABLE()
 159
 160 // ============================================================================
 161 // implementation
 162 // ============================================================================
 163
 164 // ----------------------------------------------------------------------------
 165 // wxHtmlListBox creation
 166 // ----------------------------------------------------------------------------
 167
 168 void wxHtmlListBox::Init()
 169 {
 170     m_htmlParser = NULL;
 171     m_htmlRendStyle = new wxHtmlListBoxStyle(*this);
 172     m_cache = new wxHtmlListBoxCache;
 173 }
 174
 175 bool wxHtmlListBox::Create(wxWindow *parent,
 176                            wxWindowID id,
 177                            const wxPoint& pos,
 178                            const wxSize& size,
 179                            long style,
 180                            const wxString& name)
 181 {
 182     return wxVListBox::Create(parent, id, pos, size, style, name);
 183 }
 184
 185 wxHtmlListBox::~wxHtmlListBox()
 186 {
 187     delete m_cache;
 188
 189     if ( m_htmlParser )
 190     {
 191         delete m_htmlParser->GetDC();
 192         delete m_htmlParser;
 193     }
 194
 195     delete m_htmlRendStyle;
 196 }
 197
 198 // ----------------------------------------------------------------------------
 199 // wxHtmlListBox appearance
 200 // ----------------------------------------------------------------------------
 201
 202 wxColour wxHtmlListBox::GetSelectedTextColour(const wxColour& colFg) const
 203 {
 204     return m_htmlRendStyle->
 205                 wxDefaultHtmlRenderingStyle::GetSelectedTextColour(colFg);
 206 }
 207
 208 wxColour
 209 wxHtmlListBox::GetSelectedTextBgColour(const wxColour& WXUNUSED(colBg)) const
 210 {
 211     return GetSelectionBackground();
 212 }
 213
 214 // ----------------------------------------------------------------------------
 215 // wxHtmlListBox items markup
 216 // ----------------------------------------------------------------------------
 217
 218 wxString wxHtmlListBox::OnGetItemMarkup(size_t n) const
 219 {
 220     // we don't even need to wrap the value returned by OnGetItem() inside
 221     // "<html><body>" and "</body></html>" because wxHTML can parse it even
 222     // without these tags
 223     return OnGetItem(n);
 224 }
 225
 226 // ----------------------------------------------------------------------------
 227 // wxHtmlListBox cache handling
 228 // ----------------------------------------------------------------------------
 229
 230 void wxHtmlListBox::CacheItem(size_t n) const
 231 {
 232     if ( !m_cache->Has(n) )
 233     {
 234         if ( !m_htmlParser )
 235         {
 236             wxHtmlListBox *self = wxConstCast(this, wxHtmlListBox);
 237
 238             self->m_htmlParser = new wxHtmlWinParser;
 239             m_htmlParser->SetDC(new wxClientDC(self));
 240         }
 241
 242         wxHtmlContainerCell *cell = (wxHtmlContainerCell *)m_htmlParser->
 243                 Parse(OnGetItemMarkup(n));
 244         wxCHECK_RET( cell, _T("wxHtmlParser::Parse() returned NULL?") );
 245
 246         cell->Layout(GetClientSize().x - 2*GetMargins().x);
 247
 248         m_cache->Store(n, cell);
 249     }
 250 }
 251
 252 void wxHtmlListBox::OnSize(wxSizeEvent& event)
 253 {
 254     // we need to relayout all the cached cells
 255     m_cache->Clear();
 256
 257     event.Skip();
 258 }
 259
 260 void wxHtmlListBox::RefreshAll()
 261 {
 262     m_cache->Clear();
 263
 264     wxVListBox::RefreshAll();
 265 }
 266
 267 void wxHtmlListBox::SetItemCount(size_t count)
 268 {
 269     // the items are going to change, forget the old ones
 270     m_cache->Clear();
 271
 272     wxVListBox::SetItemCount(count);
 273 }
 274
 275 // ----------------------------------------------------------------------------
 276 // wxHtmlListBox implementation of wxVListBox pure virtuals
 277 // ----------------------------------------------------------------------------
 278
 279 void wxHtmlListBox::OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const
 280 {
 281     CacheItem(n);
 282
 283     wxHtmlCell *cell = m_cache->Get(n);
 284     wxCHECK_RET( cell, _T("this cell should be cached!") );
 285
 286     wxHtmlRenderingInfo htmlRendInfo;
 287
 288     // draw the selected cell in selected state
 289     if ( IsSelected(n) )
 290     {
 291         wxHtmlSelection htmlSel;
 292         htmlSel.Set(wxPoint(0, 0), cell, wxPoint(INT_MAX, INT_MAX), cell);
 293         htmlRendInfo.SetSelection(&htmlSel);
 294         if ( m_htmlRendStyle )
 295             htmlRendInfo.SetStyle(m_htmlRendStyle);
 296         htmlRendInfo.GetState().SetSelectionState(wxHTML_SEL_IN);
 297     }
 298
 299     // note that we can't stop drawing exactly at the window boundary as then
 300     // even the visible cells part could be not drawn, so always draw the
 301     // entire cell
 302     cell->Draw(dc, rect.x, rect.y, 0, INT_MAX, htmlRendInfo);
 303 }
 304
 305 wxCoord wxHtmlListBox::OnMeasureItem(size_t n) const
 306 {
 307     CacheItem(n);
 308
 309     wxHtmlCell *cell = m_cache->Get(n);
 310     wxCHECK_MSG( cell, 0, _T("this cell should be cached!") );
 311
 312     return cell->GetHeight() + cell->GetDescent();
 313 }
 314