]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/listbox.h
addind nonowned window implementation
[wxWidgets.git] / interface / listbox.h
index 3d8271a3b0dc7f02778be1c7e3ef5da7664b094a..385b800071b59702bc841a2e6c733d4a584721ad 100644 (file)
@@ -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
@@ -56,8 +56,7 @@
     @category{ctrl}
     @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,49 +135,50 @@ 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
     */
-    int GetSelections(wxArrayInt& selections);
+    int GetSelections(wxArrayInt& selections) const;
 
     /**
         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
+
+        @wxsince{2.7.0}. 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.
     */
-    int HitTest(const wxPoint point);
+    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,25 +196,25 @@ 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);
+    bool IsSelected(int n) const;
 
     //@{
     /**
         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);
     //@}
 };
+