[wxWidgets.git] / include / wx / htmllbox.h

///////////////////////////////////////////////////////////////////////////////
// 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$
// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_HTMLLBOX_H_
#define _WX_HTMLLBOX_H_

#include "wx/vlbox.h"               // base class

#if wxUSE_FILESYSTEM
    #include "wx/filesys.h"
#endif // wxUSE_FILESYSTEM

class WXDLLIMPEXP_HTML wxHtmlCell;
class WXDLLIMPEXP_HTML wxHtmlWinParser;
class WXDLLIMPEXP_HTML wxHtmlListBoxCache;
class WXDLLIMPEXP_HTML wxHtmlListBoxStyle;

// ----------------------------------------------------------------------------
// wxHtmlListBox
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_HTML wxHtmlListBox : public wxVListBox
{
    DECLARE_ABSTRACT_CLASS(wxHtmlListBox)
public:
    // constructors and such
    // ---------------------

    // default constructor, you must call Create() later
    wxHtmlListBox() { Init(); }

    // normal constructor which calls Create() internally
    wxHtmlListBox(wxWindow *parent,
                  wxWindowID id = wxID_ANY,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = 0,
                  const wxString& name = wxVListBoxNameStr)
    {
        Init();

        (void)Create(parent, id, pos, size, style, name);
    }

    // really creates the control and sets the initial number of items in it
    // (which may be changed later with SetItemCount())
    //
    // the only special style which may be specified here is wxLB_MULTIPLE
    //
    // 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();

    // override some base class virtuals
    virtual void RefreshLine(size_t line);
    virtual void RefreshLines(size_t from, size_t to);
    virtual void RefreshAll();
    virtual void SetItemCount(size_t count);


#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

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;


    // 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;


    // 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;


    // event handlers
    void OnSize(wxSizeEvent& event);


    // common part of all ctors
    void Init();

    // ensure that the given item is cached
    void CacheItem(size_t n) const;

private:
    // this class caches the pre-parsed HTML to speed up display
    wxHtmlListBoxCache *m_cache;

    // HTML parser we use
    wxHtmlWinParser *m_htmlParser;

#if wxUSE_FILESYSTEM
    // file system used by m_htmlParser
    wxFileSystem m_filesystem;
#endif // wxUSE_FILESYSTEM

    // rendering style for the parser which allows us to customize our colours
    wxHtmlListBoxStyle *m_htmlRendStyle;


    // it calls our GetSelectedTextColour() and GetSelectedTextBgColour()
    friend class wxHtmlListBoxStyle;


    DECLARE_EVENT_TABLE()
    DECLARE_NO_COPY_CLASS(wxHtmlListBox)
};

#endif // _WX_HTMLLBOX_H_
Commit	Line	Data
e0c6027b VZ	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/htmllbox.h
	3	// Purpose: wxHtmlListBox is a listbox whose items are wxHtmlCells
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 31.05.03
	7	// RCS-ID: $Id$
77ffb593	8	// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
65571936	9	// Licence: wxWindows licence
e0c6027b VZ	10	///////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_HTMLLBOX_H_
	13	#define _WX_HTMLLBOX_H_
	14
	15	#include "wx/vlbox.h" // base class
	16
2d814c19 VZ	17	#if wxUSE_FILESYSTEM
	18	#include "wx/filesys.h"
	19	#endif // wxUSE_FILESYSTEM
	20
6acba9a7 VS	21	class WXDLLIMPEXP_HTML wxHtmlCell;
	22	class WXDLLIMPEXP_HTML wxHtmlWinParser;
	23	class WXDLLIMPEXP_HTML wxHtmlListBoxCache;
	24	class WXDLLIMPEXP_HTML wxHtmlListBoxStyle;
e0c6027b VZ	25
	26	// ----------------------------------------------------------------------------
	27	// wxHtmlListBox
	28	// ----------------------------------------------------------------------------
	29
6acba9a7	30	class WXDLLIMPEXP_HTML wxHtmlListBox : public wxVListBox
e0c6027b	31	{
0c8392ca	32	DECLARE_ABSTRACT_CLASS(wxHtmlListBox)
e0c6027b VZ	33	public:
	34	// constructors and such
	35	// ---------------------
	36
	37	// default constructor, you must call Create() later
	38	wxHtmlListBox() { Init(); }
	39
	40	// normal constructor which calls Create() internally
	41	wxHtmlListBox(wxWindow *parent,
	42	wxWindowID id = wxID_ANY,
	43	const wxPoint& pos = wxDefaultPosition,
	44	const wxSize& size = wxDefaultSize,
e0c6027b VZ	45	long style = 0,
	46	const wxString& name = wxVListBoxNameStr)
	47	{
	48	Init();
	49
43e319a3	50	(void)Create(parent, id, pos, size, style, name);
e0c6027b VZ	51	}
	52
	53	// really creates the control and sets the initial number of items in it
	54	// (which may be changed later with SetItemCount())
	55	//
43e319a3	56	// the only special style which may be specified here is wxLB_MULTIPLE
e0c6027b VZ	57	//
	58	// returns true on success or false if the control couldn't be created
	59	bool Create(wxWindow *parent,
	60	wxWindowID id = wxID_ANY,
	61	const wxPoint& pos = wxDefaultPosition,
	62	const wxSize& size = wxDefaultSize,
e0c6027b VZ	63	long style = 0,
	64	const wxString& name = wxVListBoxNameStr);
	65
	66	// destructor cleans up whatever resources we use
	67	virtual ~wxHtmlListBox();
	68
03495767	69	// override some base class virtuals
5c2a509f VZ	70	virtual void RefreshLine(size_t line);
5c2a509f VZ	71	virtual void RefreshLines(size_t from, size_t to);
5ecdc7ab	72	virtual void RefreshAll();
03495767	73	virtual void SetItemCount(size_t count);
5ecdc7ab	74
2d814c19 VZ	75
	76	#if wxUSE_FILESYSTEM
	77	// retrieve the file system used by the wxHtmlWinParser: if you use
	78	// relative paths in your HTML, you should use its ChangePathTo() method
	79	wxFileSystem& GetFileSystem() { return m_filesystem; }
	80	const wxFileSystem& GetFileSystem() const { return m_filesystem; }
	81	#endif // wxUSE_FILESYSTEM
	82
e0c6027b VZ	83	protected:
	84	// this method must be implemented in the derived class and should return
	85	// the body (i.e. without <html>) of the HTML for the given item
	86	virtual wxString OnGetItem(size_t n) const = 0;
	87
	88	// this function may be overridden to decorate HTML returned by OnGetItem()
	89	virtual wxString OnGetItemMarkup(size_t n) const;
	90
	91
9a9b4940 VZ	92	// this method allows to customize the selection appearance: it may be used
	93	// to specify the colour of the text which normally has the given colour
	94	// colFg when it is inside the selection
	95	//
	96	// by default, the original colour is not used at all and all text has the
	97	// same (default for this system) colour inside selection
	98	virtual wxColour GetSelectedTextColour(const wxColour& colFg) const;
	99
	100	// this is the same as GetSelectedTextColour() but allows to customize the
	101	// background colour -- this is even more rarely used as you can change it
	102	// globally using SetSelectionBackground()
	103	virtual wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
	104
	105
e0c6027b VZ	106	// we implement both of these functions in terms of OnGetItem(), they are
	107	// not supposed to be overridden by our descendants
	108	virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const;
	109	virtual wxCoord OnMeasureItem(size_t n) const;
	110
	111
5ecdc7ab VZ	112	// event handlers
	113	void OnSize(wxSizeEvent& event);
	114
	115
e0c6027b VZ	116	// common part of all ctors
	117	void Init();
	118
	119	// ensure that the given item is cached
	120	void CacheItem(size_t n) const;
	121
	122	private:
9a9b4940	123	// this class caches the pre-parsed HTML to speed up display
e0c6027b VZ	124	wxHtmlListBoxCache *m_cache;
	125
	126	// HTML parser we use
	127	wxHtmlWinParser *m_htmlParser;
5ecdc7ab	128
2d814c19 VZ	129	#if wxUSE_FILESYSTEM
	130	// file system used by m_htmlParser
	131	wxFileSystem m_filesystem;
	132	#endif // wxUSE_FILESYSTEM
	133
9a9b4940 VZ	134	// rendering style for the parser which allows us to customize our colours
	135	wxHtmlListBoxStyle *m_htmlRendStyle;
	136
	137
	138	// it calls our GetSelectedTextColour() and GetSelectedTextBgColour()
	139	friend class wxHtmlListBoxStyle;
	140
5ecdc7ab VZ	141
5ecdc7ab VZ	142	DECLARE_EVENT_TABLE()
27d0dcd0	143	DECLARE_NO_COPY_CLASS(wxHtmlListBox)
e0c6027b VZ	144	};
	145
	146	#endif // _WX_HTMLLBOX_H_
	147