cleanup - added whitespace around operators, some blank lines, fixed comment typos...

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

diff --git a/include/wx/htmllbox.h b/include/wx/htmllbox.h
index 1b77758faf7bef9ea346f8a783bd657c7527925c..bf0d295bde861249b5d8d5391a6a60a72c8725ce 100644 (file)
--- 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 <vadim@wxwindows.org>
+// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -14,16 +14,22 @@
 
 #include "wx/vlbox.h"               // base class
 
-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
 {
+    DECLARE_ABSTRACT_CLASS(wxHtmlListBox)
 public:
     // constructors and such
     // ---------------------
@@ -36,35 +42,43 @@ public:
                   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);
+        (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())
     //
-    // 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
 
 protected:
     // this method must be implemented in the derived class and should return
@@ -75,6 +89,20 @@ 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;
@@ -92,13 +120,27 @@ protected:
     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_