2003-06-01 09:35:26 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
// Name: wx/htmllbox.h
|
|
|
|
|
// Purpose: wxHtmlListBox is a listbox whose items are wxHtmlCells
|
|
|
|
|
// Author: Vadim Zeitlin
|
|
|
|
|
// Modified by:
|
|
|
|
|
// Created: 31.05.03
|
|
|
|
|
// RCS-ID: $Id$
|
2004-05-23 10:56:36 -04:00
|
|
|
// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
2003-06-01 09:35:26 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
|
|
#ifndef _WX_HTMLLBOX_H_
|
|
|
|
|
#define _WX_HTMLLBOX_H_
|
|
|
|
|
|
|
|
|
|
#include "wx/vlbox.h" // base class
|
2006-04-13 18:08:28 -04:00
|
|
|
#include "wx/html/htmlwin.h"
|
2003-06-01 09:35:26 -04:00
|
|
|
|
2004-04-30 18:44:03 -04:00
|
|
|
#if wxUSE_FILESYSTEM
|
|
|
|
|
#include "wx/filesys.h"
|
|
|
|
|
#endif // wxUSE_FILESYSTEM
|
|
|
|
|
|
2003-07-04 09:04:05 -04:00
|
|
|
class WXDLLIMPEXP_HTML wxHtmlCell;
|
|
|
|
|
class WXDLLIMPEXP_HTML wxHtmlWinParser;
|
|
|
|
|
class WXDLLIMPEXP_HTML wxHtmlListBoxCache;
|
|
|
|
|
class WXDLLIMPEXP_HTML wxHtmlListBoxStyle;
|
2003-06-01 09:35:26 -04:00
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
// wxHtmlListBox
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
2006-04-13 18:08:28 -04:00
|
|
|
class WXDLLIMPEXP_HTML wxHtmlListBox : public wxVListBox,
|
|
|
|
|
public wxHtmlWindowInterface,
|
2006-04-14 16:43:06 -04:00
|
|
|
public wxHtmlWindowMouseHelper
|
2003-06-01 09:35:26 -04:00
|
|
|
{
|
2003-08-08 17:23:33 -04:00
|
|
|
DECLARE_ABSTRACT_CLASS(wxHtmlListBox)
|
2003-06-01 09:35:26 -04:00
|
|
|
public:
|
|
|
|
|
// constructors and such
|
|
|
|
|
// ---------------------
|
|
|
|
|
|
|
|
|
|
// default constructor, you must call Create() later
|
2006-04-13 18:08:28 -04:00
|
|
|
wxHtmlListBox();
|
2003-06-01 09:35:26 -04:00
|
|
|
|
|
|
|
|
// normal constructor which calls Create() internally
|
|
|
|
|
wxHtmlListBox(wxWindow *parent,
|
|
|
|
|
wxWindowID id = wxID_ANY,
|
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
|
long style = 0,
|
2006-04-13 18:08:28 -04:00
|
|
|
const wxString& name = wxVListBoxNameStr);
|
2003-06-01 09:35:26 -04:00
|
|
|
|
|
|
|
|
// really creates the control and sets the initial number of items in it
|
|
|
|
|
// (which may be changed later with SetItemCount())
|
|
|
|
|
//
|
2003-06-11 07:47:09 -04:00
|
|
|
// the only special style which may be specified here is wxLB_MULTIPLE
|
2003-06-01 09:35:26 -04:00
|
|
|
//
|
|
|
|
|
// returns true on success or false if the control couldn't be created
|
|
|
|
|
bool Create(wxWindow *parent,
|
|
|
|
|
wxWindowID id = wxID_ANY,
|
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
|
long style = 0,
|
|
|
|
|
const wxString& name = wxVListBoxNameStr);
|
|
|
|
|
|
|
|
|
|
// destructor cleans up whatever resources we use
|
|
|
|
|
virtual ~wxHtmlListBox();
|
|
|
|
|
|
2003-06-26 06:05:13 -04:00
|
|
|
// override some base class virtuals
|
2005-02-02 06:08:48 -05:00
|
|
|
virtual void RefreshLine(size_t line);
|
|
|
|
|
virtual void RefreshLines(size_t from, size_t to);
|
2003-06-02 19:02:12 -04:00
|
|
|
virtual void RefreshAll();
|
2003-06-26 06:05:13 -04:00
|
|
|
virtual void SetItemCount(size_t count);
|
2003-06-02 19:02:12 -04:00
|
|
|
|
2004-04-30 18:44:03 -04:00
|
|
|
|
|
|
|
|
#if wxUSE_FILESYSTEM
|
|
|
|
|
// retrieve the file system used by the wxHtmlWinParser: if you use
|
|
|
|
|
// relative paths in your HTML, you should use its ChangePathTo() method
|
|
|
|
|
wxFileSystem& GetFileSystem() { return m_filesystem; }
|
|
|
|
|
const wxFileSystem& GetFileSystem() const { return m_filesystem; }
|
|
|
|
|
#endif // wxUSE_FILESYSTEM
|
|
|
|
|
|
2006-04-13 18:08:28 -04:00
|
|
|
virtual void OnInternalIdle();
|
|
|
|
|
|
2003-06-01 09:35:26 -04:00
|
|
|
protected:
|
|
|
|
|
// this method must be implemented in the derived class and should return
|
|
|
|
|
// the body (i.e. without <html>) of the HTML for the given item
|
|
|
|
|
virtual wxString OnGetItem(size_t n) const = 0;
|
|
|
|
|
|
|
|
|
|
// this function may be overridden to decorate HTML returned by OnGetItem()
|
|
|
|
|
virtual wxString OnGetItemMarkup(size_t n) const;
|
|
|
|
|
|
|
|
|
|
|
2003-06-13 18:26:45 -04:00
|
|
|
// this method allows to customize the selection appearance: it may be used
|
|
|
|
|
// to specify the colour of the text which normally has the given colour
|
|
|
|
|
// colFg when it is inside the selection
|
|
|
|
|
//
|
|
|
|
|
// by default, the original colour is not used at all and all text has the
|
|
|
|
|
// same (default for this system) colour inside selection
|
|
|
|
|
virtual wxColour GetSelectedTextColour(const wxColour& colFg) const;
|
|
|
|
|
|
|
|
|
|
// this is the same as GetSelectedTextColour() but allows to customize the
|
|
|
|
|
// background colour -- this is even more rarely used as you can change it
|
|
|
|
|
// globally using SetSelectionBackground()
|
|
|
|
|
virtual wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
|
|
|
|
|
|
|
|
|
|
|
2003-06-01 09:35:26 -04:00
|
|
|
// we implement both of these functions in terms of OnGetItem(), they are
|
|
|
|
|
// not supposed to be overridden by our descendants
|
|
|
|
|
virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;
|
|
|
|
|
virtual wxCoord OnMeasureItem(size_t n) const;
|
|
|
|
|
|
2006-04-13 18:08:28 -04:00
|
|
|
// This method may be overriden to handle clicking on a link in
|
|
|
|
|
// the listbox. By default, clicking links is ignored.
|
|
|
|
|
virtual void OnLinkClicked(size_t WXUNUSED(n),
|
|
|
|
|
const wxHtmlLinkInfo& WXUNUSED(link)) {}
|
2003-06-01 09:35:26 -04:00
|
|
|
|
2003-06-02 19:02:12 -04:00
|
|
|
// event handlers
|
|
|
|
|
void OnSize(wxSizeEvent& event);
|
2006-04-13 18:08:28 -04:00
|
|
|
void OnMouseMove(wxMouseEvent& event);
|
|
|
|
|
void OnLeftDown(wxMouseEvent& event);
|
2003-06-02 19:02:12 -04:00
|
|
|
|
|
|
|
|
|
2003-06-01 09:35:26 -04:00
|
|
|
// common part of all ctors
|
|
|
|
|
void Init();
|
|
|
|
|
|
|
|
|
|
// ensure that the given item is cached
|
|
|
|
|
void CacheItem(size_t n) const;
|
|
|
|
|
|
2006-04-13 18:08:28 -04:00
|
|
|
private:
|
|
|
|
|
// wxHtmlWindowInterface methods:
|
|
|
|
|
virtual void SetHTMLWindowTitle(const wxString& title);
|
|
|
|
|
virtual void OnHTMLLinkClicked(const wxHtmlLinkInfo& link);
|
|
|
|
|
virtual wxHtmlOpeningStatus OnHTMLOpeningURL(wxHtmlURLType type,
|
|
|
|
|
const wxString& url,
|
|
|
|
|
wxString *redirect) const;
|
|
|
|
|
virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell,
|
|
|
|
|
const wxPoint& pos) const;
|
|
|
|
|
virtual wxWindow* GetHTMLWindow();
|
|
|
|
|
virtual wxColour GetHTMLBackgroundColour() const;
|
|
|
|
|
virtual void SetHTMLBackgroundColour(const wxColour& clr);
|
|
|
|
|
virtual void SetHTMLBackgroundImage(const wxBitmap& bmpBg);
|
|
|
|
|
virtual void SetHTMLStatusText(const wxString& text);
|
2006-04-14 07:38:36 -04:00
|
|
|
virtual wxCursor GetHTMLCursor(HTMLCursor type) const;
|
2006-04-13 18:08:28 -04:00
|
|
|
|
|
|
|
|
// returns index of item that contains given HTML cell
|
|
|
|
|
size_t GetItemForCell(const wxHtmlCell *cell) const;
|
|
|
|
|
|
|
|
|
|
// return physical coordinates of root wxHtmlCell of n-th item
|
|
|
|
|
wxPoint GetRootCellCoords(size_t n) const;
|
|
|
|
|
|
|
|
|
|
// Converts physical coordinates stored in @a pos into coordinates
|
|
|
|
|
// relative to the root cell of the item under mouse cursor, if any. If no
|
|
|
|
|
// cell is found under the cursor, returns false. Otherwise stores the new
|
|
|
|
|
// coordinates back into @a pos and pointer to the cell under cursor into
|
|
|
|
|
// @a cell and returns true.
|
|
|
|
|
bool PhysicalCoordsToCell(wxPoint& pos, wxHtmlCell*& cell) const;
|
|
|
|
|
|
|
|
|
|
// The opposite of PhysicalCoordsToCell: converts coordinates relative to
|
|
|
|
|
// given cell to physical coordinates in the window
|
|
|
|
|
wxPoint CellCoordsToPhysical(const wxPoint& pos, wxHtmlCell *cell) const;
|
|
|
|
|
|
2003-06-01 09:35:26 -04:00
|
|
|
private:
|
2003-06-13 18:26:45 -04:00
|
|
|
// this class caches the pre-parsed HTML to speed up display
|
2003-06-01 09:35:26 -04:00
|
|
|
wxHtmlListBoxCache *m_cache;
|
|
|
|
|
|
|
|
|
|
// HTML parser we use
|
|
|
|
|
wxHtmlWinParser *m_htmlParser;
|
2003-06-02 19:02:12 -04:00
|
|
|
|
2004-04-30 18:44:03 -04:00
|
|
|
#if wxUSE_FILESYSTEM
|
|
|
|
|
// file system used by m_htmlParser
|
|
|
|
|
wxFileSystem m_filesystem;
|
|
|
|
|
#endif // wxUSE_FILESYSTEM
|
|
|
|
|
|
2003-06-13 18:26:45 -04:00
|
|
|
// rendering style for the parser which allows us to customize our colours
|
|
|
|
|
wxHtmlListBoxStyle *m_htmlRendStyle;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// it calls our GetSelectedTextColour() and GetSelectedTextBgColour()
|
|
|
|
|
friend class wxHtmlListBoxStyle;
|
2006-04-13 18:08:28 -04:00
|
|
|
friend class wxHtmlListBoxWinInterface;
|
2003-06-13 18:26:45 -04:00
|
|
|
|
2003-06-02 19:02:12 -04:00
|
|
|
|
|
|
|
|
DECLARE_EVENT_TABLE()
|
2003-07-30 17:36:38 -04:00
|
|
|
DECLARE_NO_COPY_CLASS(wxHtmlListBox)
|
2003-06-01 09:35:26 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif // _WX_HTMLLBOX_H_
|
|
|
|
|
|
