1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: generic/htmllbox.cpp
3 // Purpose: implementation of wxHtmlListBox
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9 // License: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
28 #include "wx/dcclient.h"
31 #include "wx/htmllbox.h"
33 #include "wx/html/htmlcell.h"
34 #include "wx/html/winpars.h"
36 // this hack forces the linker to always link in m_* files
37 #include "wx/html/forcelnk.h"
38 FORCE_WXHTML_MODULES()
40 // ============================================================================
42 // ============================================================================
44 // ----------------------------------------------------------------------------
46 // ----------------------------------------------------------------------------
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
55 for ( size_t n
= 0; n
< SIZE
; n
++ )
57 m_items
[n
] = (size_t)-1;
66 for ( size_t n
= 0; n
< SIZE
; n
++ )
72 // completely invalidate the cache
75 for ( size_t n
= 0; n
< SIZE
; n
++ )
77 m_items
[n
] = (size_t)-1;
83 // return the cached cell for this index or NULL if none
84 wxHtmlCell
*Get(size_t item
) const
86 for ( size_t n
= 0; n
< SIZE
; n
++ )
88 if ( m_items
[n
] == item
)
95 // returns true if we already have this item cached
96 bool Has(size_t item
) const { return Get(item
) != NULL
; }
98 // ensure that the item is cached
99 void Store(size_t item
, wxHtmlCell
*cell
)
101 delete m_cells
[m_next
];
102 m_cells
[m_next
] = cell
;
103 m_items
[m_next
] = item
;
105 // advance to the next item wrapping around if there are no more
106 if ( ++m_next
== SIZE
)
111 // the max number of the items we cache
114 // the index of the LRU (oldest) cell
117 // the parsed representation of the cached item or NULL
118 wxHtmlCell
*m_cells
[SIZE
];
120 // the index of the currently cached item (only valid if m_cells != NULL)
121 size_t m_items
[SIZE
];
124 // ----------------------------------------------------------------------------
125 // wxHtmlListBoxStyle
126 // ----------------------------------------------------------------------------
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
133 wxHtmlListBoxStyle(wxHtmlListBox
& hlbox
) : m_hlbox(hlbox
) { }
135 virtual wxColour
GetSelectedTextColour(const wxColour
& colFg
)
137 return m_hlbox
.GetSelectedTextColour(colFg
);
140 virtual wxColour
GetSelectedTextBgColour(const wxColour
& colBg
)
142 return m_hlbox
.GetSelectedTextBgColour(colBg
);
146 const wxHtmlListBox
& m_hlbox
;
148 DECLARE_NO_COPY_CLASS(wxHtmlListBoxStyle
)
152 // ----------------------------------------------------------------------------
154 // ----------------------------------------------------------------------------
156 BEGIN_EVENT_TABLE(wxHtmlListBox
, wxVListBox
)
157 EVT_SIZE(wxHtmlListBox::OnSize
)
160 // ============================================================================
162 // ============================================================================
164 // ----------------------------------------------------------------------------
165 // wxHtmlListBox creation
166 // ----------------------------------------------------------------------------
168 void wxHtmlListBox::Init()
171 m_htmlRendStyle
= new wxHtmlListBoxStyle(*this);
172 m_cache
= new wxHtmlListBoxCache
;
175 bool wxHtmlListBox::Create(wxWindow
*parent
,
180 const wxString
& name
)
182 return wxVListBox::Create(parent
, id
, pos
, size
, style
, name
);
185 wxHtmlListBox::~wxHtmlListBox()
191 delete m_htmlParser
->GetDC();
195 delete m_htmlRendStyle
;
198 // ----------------------------------------------------------------------------
199 // wxHtmlListBox appearance
200 // ----------------------------------------------------------------------------
202 wxColour
wxHtmlListBox::GetSelectedTextColour(const wxColour
& colFg
) const
204 return m_htmlRendStyle
->
205 wxDefaultHtmlRenderingStyle::GetSelectedTextColour(colFg
);
209 wxHtmlListBox::GetSelectedTextBgColour(const wxColour
& WXUNUSED(colBg
)) const
211 return GetSelectionBackground();
214 // ----------------------------------------------------------------------------
215 // wxHtmlListBox items markup
216 // ----------------------------------------------------------------------------
218 wxString
wxHtmlListBox::OnGetItemMarkup(size_t n
) const
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
226 // ----------------------------------------------------------------------------
227 // wxHtmlListBox cache handling
228 // ----------------------------------------------------------------------------
230 void wxHtmlListBox::CacheItem(size_t n
) const
232 if ( !m_cache
->Has(n
) )
236 wxHtmlListBox
*self
= wxConstCast(this, wxHtmlListBox
);
238 self
->m_htmlParser
= new wxHtmlWinParser
;
239 m_htmlParser
->SetDC(new wxClientDC(self
));
242 wxHtmlContainerCell
*cell
= (wxHtmlContainerCell
*)m_htmlParser
->
243 Parse(OnGetItemMarkup(n
));
244 wxCHECK_RET( cell
, _T("wxHtmlParser::Parse() returned NULL?") );
246 cell
->Layout(GetClientSize().x
- 2*GetMargins().x
);
248 m_cache
->Store(n
, cell
);
252 void wxHtmlListBox::OnSize(wxSizeEvent
& event
)
254 // we need to relayout all the cached cells
260 void wxHtmlListBox::RefreshAll()
264 wxVListBox::RefreshAll();
267 void wxHtmlListBox::SetItemCount(size_t count
)
269 // the items are going to change, forget the old ones
272 wxVListBox::SetItemCount(count
);
275 // ----------------------------------------------------------------------------
276 // wxHtmlListBox implementation of wxVListBox pure virtuals
277 // ----------------------------------------------------------------------------
279 void wxHtmlListBox::OnDrawItem(wxDC
& dc
, const wxRect
& rect
, size_t n
) const
283 wxHtmlCell
*cell
= m_cache
->Get(n
);
284 wxCHECK_RET( cell
, _T("this cell should be cached!") );
286 wxHtmlRenderingInfo htmlRendInfo
;
288 // draw the selected cell in selected state
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
);
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
302 cell
->Draw(dc
, rect
.x
, rect
.y
, 0, INT_MAX
, htmlRendInfo
);
305 wxCoord
wxHtmlListBox::OnMeasureItem(size_t n
) const
309 wxHtmlCell
*cell
= m_cache
->Get(n
);
310 wxCHECK_MSG( cell
, 0, _T("this cell should be cached!") );
312 return cell
->GetHeight() + cell
->GetDescent();