Applied patch #15286: documentation and col/rowspan demo by dghart

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

diff --git a/interface/wx/htmllbox.h b/interface/wx/htmllbox.h
index 64c8096403eb6d5e3ce891454052ccdd546a775e..72023134231c2f775f3121716f9be23f8bef3236 100644 (file)
--- a/interface/wx/htmllbox.h
+++ b/interface/wx/htmllbox.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxHtmlListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -14,7 +14,7 @@
     derive your own class from it (see htlbox sample for the example) but you will
     only need to override a single wxHtmlListBox::OnGetItem function.
 
-    @beginEventTable{wxHtmlCellEvent,wxHtmlLinkEvent}
+    @beginEventEmissionTable{wxHtmlCellEvent,wxHtmlLinkEvent}
     @event{EVT_HTML_CELL_CLICKED(id, func)}
         A wxHtmlCell was clicked.
     @event{EVT_HTML_CELL_HOVER(id, func)}
@@ -55,7 +55,7 @@ public:
         (it may also be set or changed later with wxVListBox::SetItemCount).
 
         There are no special styles defined for wxHtmlListBox, in particular the
-        wxListBox styles (with the exception of @c wxLB_MULTIPLE) can not be used here.
+        wxListBox styles (with the exception of @c wxLB_MULTIPLE) cannot be used here.
 
         Returns @true on success or @false if the control couldn't be created
     */
@@ -180,34 +180,29 @@ protected:
 
     A wxSimpleHtmlListBox emits the same events used by wxListBox and by wxHtmlListBox.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable
     @event{EVT_LISTBOX(id, func)}
-        Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list
-        is selected.
+        Process a @c wxEVT_LISTBOX event, when an item on the list
+        is selected. See wxCommandEvent.
     @event{EVT_LISTBOX_DCLICK(id, func)}
-        Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
-        double-clicked.
-    @endEventTable
-
-    @beginEventTable{wxHtmlCellEvent}
+        Process a @c wxEVT_LISTBOX_DCLICK event, when the listbox is
+        double-clicked. See wxCommandEvent.
     @event{EVT_HTML_CELL_CLICKED(id, func)}
-        A wxHtmlCell was clicked.
+        A wxHtmlCell was clicked. See wxHtmlCellEvent.
     @event{EVT_HTML_CELL_HOVER(id, func)}
-        The mouse passed over a wxHtmlCell.
-    @endEventTable
-
-    @beginEventTable{wxHtmlLinkEvent}
+        The mouse passed over a wxHtmlCell. See wxHtmlCellEvent.
     @event{EVT_HTML_LINK_CLICKED(id, func)}
-        A wxHtmlCell which contains an hyperlink was clicked.
+        A wxHtmlCell which contains an hyperlink was clicked. See wxHtmlLinkEvent
     @endEventTable
 
     @library{wxhtml}
     @category{ctrl}
-    @appearance{simplehtmllistbox.png}
+    @appearance{simplehtmllistbox}
 
     @see wxSimpleHtmlListBox::Create
 */
-class wxSimpleHtmlListBox : public wxHtmlListBox
+class wxSimpleHtmlListBox : public wxHtmlListBox,
+                            public wxItemContainer
 {
 public:
     /**
@@ -219,8 +214,10 @@ public:
             Window identifier. A value of -1 indicates a default value.
         @param pos
             Window position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @param size
-            Window size. If wxDefaultSize is specified then the window is sized appropriately.
+            Window size. 
+            If ::wxDefaultSize is specified then the window is sized appropriately.
         @param n
             Number of strings with which to initialise the control.
         @param choices
@@ -284,15 +281,14 @@ public:
         Creates the HTML listbox for two-step construction.
         See wxSimpleHtmlListBox() for further details.
     */
-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
-                int n,
-                const wxString choices[] = NULL,
+                int n = 0, const wxString choices[] = NULL,
                 long style = wxHLB_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxSimpleHtmlListBoxNameStr);
-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,