]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/listbox.h
return wxStandardPaths, not wxStandardPathsBase, from wxStandardPathsBase::Get()...
[wxWidgets.git] / interface / wx / listbox.h
index 029a510b5a1410935d7991cd5f147d0b57265ed6..fa39ac5dbaa22c0418ccb7a5a4833a31df03ed5e 100644 (file)
 
     @beginStyleTable
     @style{wxLB_SINGLE}
-           Single-selection list.
+        Single-selection list.
     @style{wxLB_MULTIPLE}
-           Multiple-selection list: the user can toggle multiple items on and off.
-           This is the same as wxLB_EXTENDED in wxGTK2 port.
+        Multiple-selection list: the user can toggle multiple items on and off.
+        This is the same as wxLB_EXTENDED in wxGTK2 port.
     @style{wxLB_EXTENDED}
-           Extended-selection list: the user can extend the selection by using
-           @c SHIFT or @c CTRL keys together with the cursor movement keys or
-           the mouse.
+        Extended-selection list: the user can extend the selection by using
+        @c SHIFT or @c CTRL keys together with the cursor movement keys or
+        the mouse.
     @style{wxLB_HSCROLL}
-           Create horizontal scrollbar if contents are too wide (Windows only).
+        Create horizontal scrollbar if contents are too wide (Windows only).
     @style{wxLB_ALWAYS_SB}
-           Always show a vertical scrollbar.
+        Always show a vertical scrollbar.
     @style{wxLB_NEEDED_SB}
-           Only create a vertical scrollbar if needed.
+        Only create a vertical scrollbar if needed.
     @style{wxLB_SORT}
-           The listbox contents are sorted in alphabetical order.
+        The listbox contents are sorted in alphabetical order.
     @endStyleTable
 
     Note that @c wxLB_SINGLE, @c wxLB_MULTIPLE and @c wxLB_EXTENDED styles are
     mutually exclusive and you can specify at most one of them (single selection
     is the default). See also @ref overview_windowstyles.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{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.
+        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_LISTBOXDOUBLECLICKED event, when the listbox
-           is double-clicked.
+        Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox
+        is double-clicked.
     @endEventTable
 
     @library{wxcore}
@@ -79,9 +79,10 @@ public:
             The ID of this control. A value of @c wxID_ANY indicates a default value.
         @param pos
             The initial position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @param size
             The initial size.
-            If wxDefaultSize is specified then the window is sized appropriately.
+            If ::wxDefaultSize is specified then the window is sized appropriately.
         @param n
             Number of strings with which to initialise the control.
         @param choices
@@ -129,21 +130,20 @@ public:
         Creates the listbox for two-step construction.
         See wxListBox() for further details.
     */
-    bool Create(wxWindowparent, 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 = 0,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "listBox");
-    bool Create(wxWindowparent, wxWindowID id,
+                const wxString& name = wxListBoxNameStr);
+    bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos,
                 const wxSize& size,
                 const wxArrayString& choices,
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "listBox");
+                const wxString& name = wxListBoxNameStr);
     //@}
 
     /**
@@ -188,6 +188,11 @@ public:
     */
     int HitTest(const wxPoint& point) const;
 
+    /**
+        @overload
+    */
+    int HitTest(int x, int y) const;
+
     /**
         Insert the given number of strings before the specified position.
 
@@ -199,7 +204,7 @@ public:
             Position before which to insert the items: if pos is 0 the
             items will be inserted in the beginning of the listbox
     */
-    void InsertItems(int nItems, const wxString *items,
+    void InsertItems(unsigned int nItems, const wxString *items,
                      unsigned int pos);
 
     /**
@@ -234,7 +239,7 @@ public:
         @param clientData
             Options array of client data pointers
     */
-    void Set(int n, const wxString* choices, void **clientData = NULL);
+    void Set(unsigned int n, const wxString* choices, void *clientData);
 
     /**
         Clears the list box and adds the given strings to it.
@@ -246,7 +251,7 @@ public:
         @param clientData
             Options array of client data pointers
     */
-    void Set(const wxArrayString& choices, void **clientData = NULL);
+    void Set(const wxArrayString& choices, void *clientData);
 
     /**
         Set the specified item to be the first visible item.