More initial reviews of [u*-v*] interface headers.

[wxWidgets.git] / interface / htmllbox.h

diff --git a/interface/htmllbox.h b/interface/htmllbox.h
index 0f998006058013a925067ff09db8c69f619cfb76..8b487f1ec5f9da667a42710dbf9a42dcd4566dbb 100644 (file)
--- a/interface/htmllbox.h
+++ b/interface/htmllbox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        htmllbox.h
-// Purpose:     documentation for wxHtmlListBox class
+// Purpose:     interface of wxHtmlListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -20,8 +20,7 @@
     @category{ctrl}
     @appearance{htmllistbox.png}
 
-    @seealso
-    wxSimpleHtmlListBox
+    @see wxSimpleHtmlListBox
 */
 class wxHtmlListBox : public wxVListBox
 {
@@ -66,8 +65,8 @@ public:
         wxFileSystem::ChangePathTo if you use
         relative paths for the images or other resources embedded in your HTML.
     */
-    wxFileSystem GetFileSystem();
-    const wxFileSystem GetFileSystem();
+    wxFileSystem GetFileSystem() const;
+    const wxFileSystem GetFileSystem() const;
     //@}
 
     /**
@@ -78,10 +77,10 @@ public:
         wxVListBox::SetSelectionBackground allows to
         change the selection background for all cells at once and doing anything more
         fancy is probably going to look strangely.
-        
+
         @see GetSelectedTextColour()
     */
-    wxColour GetSelectedTextBgColour(const wxColour& colBg);
+    wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
 
     /**
         This virtual function may be overridden to customize the appearance of the
@@ -89,11 +88,11 @@ public:
         look inside selection. By default all original colours are completely ignored
         and the standard, system-dependent, selection colour is used but the program
         may wish to override this to achieve some custom appearance.
-        
+
         @see GetSelectedTextBgColour(),
              wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
     */
-    wxColour GetSelectedTextColour(const wxColour& colFg);
+    wxColour GetSelectedTextColour(const wxColour& colFg) const;
 
     /**
         This method must be implemented in the derived class and should return
@@ -107,29 +106,30 @@ public:
         that the returned HTML fragment will render with the same height or else you'll
         see some artifacts when the user selects an item.
     */
-    wxString OnGetItem(size_t n);
+    wxString OnGetItem(size_t n) const;
 
     /**
         This function may be overridden to decorate HTML returned by
         OnGetItem().
     */
-    wxString OnGetItemMarkup(size_t n);
+    wxString OnGetItemMarkup(size_t n) const;
 
     /**
         Called when the user clicks on hypertext link. Does nothing by default.
         Overloading this method is deprecated; intercept the event instead.
-        
+
         @param n
             Index of the item containing the link.
         @param link
             Description of the link.
-        
+
         @see See also wxHtmlLinkInfo.
     */
     virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
 };
 
 
+
 /**
     @class wxSimpleHtmlListBox
     @wxheader{htmllbox.h}
@@ -168,9 +168,9 @@ public:
     or @c body tags.
 
     @beginStyleTable
-    @style{wxHLB_DEFAULT_STYLE}:
+    @style{wxHLB_DEFAULT_STYLE}
            The default style: wxBORDER_SUNKEN
-    @style{wxHLB_MULTIPLE}:
+    @style{wxHLB_MULTIPLE}
            Multiple-selection list: the user can toggle multiple items on and
            off.
     @endStyleTable
@@ -179,8 +179,7 @@ public:
     @category{ctrl}
     @appearance{simplehtmllistbox.png}
 
-    @seealso
-    wxSimpleHtmlListBox::Create
+    @see wxSimpleHtmlListBox::Create
 */
 class wxSimpleHtmlListBox : public wxHtmlListBox
 {
@@ -238,3 +237,4 @@ public:
                 const wxString& name = "simpleHtmlListBox");
     //@}
 };
+