X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5ecdc7ab6d10222bcf88610198771b5f3aee10a7..5b9003ae3213f487fa3be74804b426a8ad0db323:/include/wx/htmllbox.h?ds=sidebyside diff --git a/include/wx/htmllbox.h b/include/wx/htmllbox.h index 1b77758faf..8a2a379e35 100644 --- a/include/wx/htmllbox.h +++ b/include/wx/htmllbox.h @@ -5,7 +5,7 @@ // Modified by: // Created: 31.05.03 // RCS-ID: $Id$ -// Copyright: (c) 2003 Vadim Zeitlin +// Copyright: (c) 2003 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -13,58 +13,72 @@ #define _WX_HTMLLBOX_H_ #include "wx/vlbox.h" // base class +#include "wx/html/htmlwin.h" -class WXDLLEXPORT wxHtmlCell; -class WXDLLEXPORT wxHtmlWinParser; -class WXDLLEXPORT wxHtmlListBoxCache; +#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 WXDLLEXPORT wxHtmlListBox : public wxVListBox +class WXDLLIMPEXP_HTML wxHtmlListBox : public wxVListBox, + public wxHtmlWindowInterface, + public wxHtmlWindowMouseHelper { + DECLARE_ABSTRACT_CLASS(wxHtmlListBox) public: // constructors and such // --------------------- // default constructor, you must call Create() later - wxHtmlListBox() { Init(); } + wxHtmlListBox(); // normal constructor which calls Create() internally wxHtmlListBox(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - size_t countItems = 0, long style = 0, - const wxString& name = wxVListBoxNameStr) - { - Init(); - - (void)Create(parent, id, pos, size, countItems, style, name); - } + const wxString& name = wxVListBoxNameStr); // really creates the control and sets the initial number of items in it // (which may be changed later with SetItemCount()) // - // there are no special styles defined for wxVListBox + // 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, - size_t countItems = 0, long style = 0, const wxString& name = wxVListBoxNameStr); // destructor cleans up whatever resources we use virtual ~wxHtmlListBox(); - // refresh everything + // 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 + virtual void OnInternalIdle(); protected: // this method must be implemented in the derived class and should return @@ -75,14 +89,34 @@ protected: 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; + // 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)) {} // event handlers void OnSize(wxSizeEvent& event); + void OnMouseMove(wxMouseEvent& event); + void OnLeftDown(wxMouseEvent& event); // common part of all ctors @@ -92,13 +126,61 @@ protected: void CacheItem(size_t n) const; 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); + virtual wxCursor GetHTMLCursor(HTMLCursor type) const; + + // 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; + +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; + friend class wxHtmlListBoxWinInterface; + DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxHtmlListBox) }; #endif // _WX_HTMLLBOX_H_