]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/htmllbox.h
undo the last change as it results in buildbot configuration error
[wxWidgets.git] / interface / wx / htmllbox.h
index c7cb35e86df80106ada78ed56d326cacc9631a91..723b24ea848d12b9eec47dae4710cdc8280d3697 100644 (file)
@@ -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.
 
     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)}
     @event{EVT_HTML_CELL_CLICKED(id, func)}
         A wxHtmlCell was clicked.
     @event{EVT_HTML_CELL_HOVER(id, func)}
@@ -25,7 +25,6 @@
 
     @library{wxhtml}
     @category{ctrl}
 
     @library{wxhtml}
     @category{ctrl}
-    @appearance{htmllistbox.png}
 
     @see wxSimpleHtmlListBox
 */
 
     @see wxSimpleHtmlListBox
 */
@@ -90,7 +89,7 @@ protected:
         @param link
             Description of the link.
 
         @param link
             Description of the link.
 
-        @see See also wxHtmlLinkInfo.
+        @see wxHtmlLinkInfo.
     */
     virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
 
     */
     virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
 
@@ -181,25 +180,19 @@ protected:
 
     A wxSimpleHtmlListBox emits the same events used by wxListBox and by wxHtmlListBox.
 
 
     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
     @event{EVT_LISTBOX(id, func)}
         Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list
-        is selected.
+        is selected. See wxCommandEvent.
     @event{EVT_LISTBOX_DCLICK(id, func)}
         Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
     @event{EVT_LISTBOX_DCLICK(id, func)}
         Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
-        double-clicked.
-    @endEventTable
-
-    @beginEventTable{wxHtmlCellEvent}
+        double-clicked. See wxCommandEvent.
     @event{EVT_HTML_CELL_CLICKED(id, func)}
     @event{EVT_HTML_CELL_CLICKED(id, func)}
-        A wxHtmlCell was clicked.
+        A wxHtmlCell was clicked. See wxHtmlCellEvent.
     @event{EVT_HTML_CELL_HOVER(id, func)}
     @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)}
     @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}
     @endEventTable
 
     @library{wxhtml}
@@ -220,8 +213,10 @@ public:
             Window identifier. A value of -1 indicates a default value.
         @param pos
             Window position.
             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
         @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
         @param n
             Number of strings with which to initialise the control.
         @param choices
@@ -233,14 +228,14 @@ public:
         @param name
             Window name.
     */
         @param name
             Window name.
     */
-    wxHtmlListBox(wxWindow* parent, wxWindowID id,
-                  const wxPoint& pos = wxDefaultPosition,
-                  const wxSize& size = wxDefaultSize,
-                  int n = 0,
-                  const wxString choices[] = NULL,
-                  long style = wxHLB_DEFAULT_STYLE,
-                  const wxValidator& validator = wxDefaultValidator,
-                  const wxString& name = "simpleHtmlListBox");
+    wxSimpleHtmlListBox(wxWindow* parent, wxWindowID id,
+                        const wxPoint& pos = wxDefaultPosition,
+                        const wxSize& size = wxDefaultSize,
+                        int n = 0,
+                        const wxString choices[] = NULL,
+                        long style = wxHLB_DEFAULT_STYLE,
+                        const wxValidator& validator = wxDefaultValidator,
+                        const wxString& name = wxSimpleHtmlListBoxNameStr);
 
     /**
         Constructor, creating and showing the HTML list box.
 
     /**
         Constructor, creating and showing the HTML list box.
@@ -262,13 +257,13 @@ public:
         @param name
             Window name.
     */
         @param name
             Window name.
     */
-    wxHtmlListBox(wxWindow* parent, wxWindowID id,
-                  const wxPoint& pos,
-                  const wxSize& size,
-                  const wxArrayString& choices,
-                  long style = wxHLB_DEFAULT_STYLE,
-                  const wxValidator& validator = wxDefaultValidator,
-                  const wxString& name = "simpleHtmlListBox");
+    wxSimpleHtmlListBox(wxWindow* parent, wxWindowID id,
+                        const wxPoint& pos,
+                        const wxSize& size,
+                        const wxArrayString& choices,
+                        long style = wxHLB_DEFAULT_STYLE,
+                        const wxValidator& validator = wxDefaultValidator,
+                        const wxString& name = wxSimpleHtmlListBoxNameStr);
 
     /**
         Default constructor, you must call Create() later.
 
     /**
         Default constructor, you must call Create() later.
@@ -285,21 +280,20 @@ public:
         Creates the HTML listbox for two-step construction.
         See wxSimpleHtmlListBox() for further details.
     */
         Creates the HTML listbox for two-step construction.
         See wxSimpleHtmlListBox() for further details.
     */
-    bool Create(wxWindowparent, wxWindowID id,
+    bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 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,
                 long style = wxHLB_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "simpleHtmlListBox");
-    bool Create(wxWindowparent, wxWindowID id,
+                const wxString& name = wxSimpleHtmlListBoxNameStr);
+    bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,
                 long style = wxHLB_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,
                 long style = wxHLB_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "simpleHtmlListBox");
+                const wxString& name = wxSimpleHtmlListBoxNameStr);
     //@}
 };
 
     //@}
 };