]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/combobox.h
Doc and comment cleanup, fixes, tweaks
[wxWidgets.git] / interface / wx / combobox.h
index d70190e385d114de366ec3ef591fadf3f9188cba..e3324620a1b40f02bf38a421687f12accd34c02b 100644 (file)
@@ -8,7 +8,6 @@
 
 /**
     @class wxComboBox
-    @wxheader{combobox.h}
 
     A combobox is like a combination of an edit control and a listbox. It can
     be displayed as static list with editable or read-only text field; or a
@@ -108,6 +107,36 @@ public:
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = "comboBox");
+    /**
+        Constructor, creating and showing a combobox.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param value
+            Initial selection string. An empty string indicates no selection.
+        @param pos
+            Window position.
+        @param size
+            Window size. If wxDefaultSize is specified then the window is sized
+            appropriately.
+        @param choices
+            An array of strings with which to initialise the control.
+        @param style
+            Window style. See wxComboBox.
+        @param validator
+            Window validator.
+        @param name
+            Window name.
+
+        @beginWxPythonOnly
+        The wxComboBox constructor in wxPython reduces the @a n and @a choices
+        arguments are to a single argument, which is a list of strings.
+        @endWxPythonOnly
+
+        @see Create(), wxValidator
+    */
     wxComboBox(wxWindow* parent, wxWindowID id,
                const wxString& value,
                const wxPoint& pos,
@@ -121,7 +150,7 @@ public:
     /**
         Destructor, destroying the combobox.
     */
-    ~wxComboBox();
+    virtual ~wxComboBox();
 
     //@{
     /**
@@ -192,7 +221,7 @@ public:
         and returns the item currently selected in the dropdown list if it's
         open or the same thing as wxControlWithItems::GetSelection() otherwise.
     */
-    int GetCurrentSelection() const;
+    virtual int GetCurrentSelection() const;
 
     /**
         Returns the insertion point for the combobox's text field.
@@ -214,7 +243,7 @@ public:
 
         Currently this method is only implemented in wxMSW and wxGTK.
     */
-    void GetSelection(long* from, long* to) const;
+    virtual void GetSelection(long* from, long* to) const;
 
     /**
         Returns the current value in the combobox text field.
@@ -280,7 +309,7 @@ public:
         wxControlWithItems::SetSelection().
         @endWxPythonOnly
     */
-    void SetSelection(long from, long to);
+    virtual void SetSelection(long from, long to);
 
     /**
         Sets the text for the combobox text field.