X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..70897a70383c4030fcf80e9ae951ff0862c9ec4c:/interface/listbox.h

diff --git a/interface/listbox.h b/interface/listbox.h
index fd357dc193..8f5eb48ff0 100644
--- a/interface/listbox.h
+++ b/interface/listbox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        listbox.h
-// Purpose:     documentation for wxListBox class
+// Purpose:     interface of wxListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -22,42 +22,41 @@
 
     A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for single
     clicks, and
-    wxEVT_COMMAND_LISTBOX_DOUBLE_CLICKED for double clicks.
+    wxEVT_COMMAND_LISTBOX_DOUBLECLICKED for double clicks.
 
     @beginStyleTable
-    @style{wxLB_SINGLE}:
+    @style{wxLB_SINGLE}
            Single-selection list.
-    @style{wxLB_MULTIPLE}:
+    @style{wxLB_MULTIPLE}
            Multiple-selection list: the user can toggle multiple items on and
            off.
-    @style{wxLB_EXTENDED}:
+    @style{wxLB_EXTENDED}
            Extended-selection list: the user can select multiple items using
            the SHIFT key and the mouse or special key combinations.
-    @style{wxLB_HSCROLL}:
+    @style{wxLB_HSCROLL}
            Create horizontal scrollbar if contents are too wide (Windows only).
-    @style{wxLB_ALWAYS_SB}:
+    @style{wxLB_ALWAYS_SB}
            Always show a vertical scrollbar.
-    @style{wxLB_NEEDED_SB}:
+    @style{wxLB_NEEDED_SB}
            Only create a vertical scrollbar if needed.
-    @style{wxLB_SORT}:
+    @style{wxLB_SORT}
            The listbox contents are sorted in alphabetical order.
     @endStyleTable
 
-    @beginEventTable
-    @event{EVT_LISTBOX(id, func)}:
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_LISTBOX(id, func)}
            Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
            list is selected or the selection changes.
-    @event{EVT_LISTBOX_DCLICK(id, func)}:
-           Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the
+    @event{EVT_LISTBOX_DCLICK(id, func)}
+           Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the
            listbox is double-clicked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{listbox.png}
+    <!-- @appearance{listbox.png} -->
 
-    @seealso
-    wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
+    @see wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
 */
 class wxListBox : public wxControlWithItems
 {
@@ -65,7 +64,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a list box.
-        
+
         @param parent
             Parent window. Must not be @NULL.
         @param id
@@ -86,7 +85,7 @@ public:
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
     wxListBox();
@@ -136,25 +135,25 @@ public:
 
     /**
         Deselects an item in the list box.
-        
+
         @param n
             The zero-based item to deselect.
-        
+
         @remarks This applies to multiple selection listboxes only.
     */
     void Deselect(int n);
 
     /**
         Fill an array of ints with the positions of the currently selected items.
-        
+
         @param selections
             A reference to an wxArrayInt instance that is used to store the result of
         the query.
-        
+
         @returns The number of selections.
-        
+
         @remarks Use this with a multiple selection listbox.
-        
+
         @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
              wxControlWithItems::SetSelection
     */
@@ -163,22 +162,23 @@ public:
     /**
         Returns the item located at @e point, or @c wxNOT_FOUND if there
         is no item located at @e point.
-        This function is new since wxWidgets version 2.7.0. It is currently implemented
-        for wxMSW, wxMac and wxGTK2
-        ports.
-        
+
+        It is currently implemented for wxMSW, wxMac and wxGTK2 ports.
+
         @param point
             Point of item (in client coordinates) to obtain
-        
+
         @returns Item located at point, or wxNOT_FOUND if unimplemented or the
                  item does not exist.
+
+        @since 2.7.0
     */
     int HitTest(const wxPoint point) const;
 
     //@{
     /**
         Insert the given number of strings before the specified position.
-        
+
         @param nItems
             Number of items in the array items
         @param items
@@ -196,10 +196,10 @@ public:
 
     /**
         Determines whether an item is selected.
-        
+
         @param n
             The zero-based item index.
-        
+
         @returns @true if the given item is selected, @false otherwise.
     */
     bool IsSelected(int n) const;
@@ -207,14 +207,14 @@ public:
     //@{
     /**
         Clears the list box and adds the given strings to it.
-        
+
         @param n
             The number of strings to set.
         @param choices
             An array of strings to set.
         @param clientData
             Options array of client data pointers
-        
+
         @remarks You may free the array from the calling program after this
                  function has been called.
     */
@@ -226,7 +226,7 @@ public:
     //@{
     /**
         Set the specified item to be the first visible item.
-        
+
         @param n
             The zero-based item index.
         @param string
@@ -236,3 +236,4 @@ public:
     void SetFirstItem(const wxString& string);
     //@}
 };
+