]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/combobox.h
Corrected library association
[wxWidgets.git] / interface / wx / combobox.h
index d70190e385d114de366ec3ef591fadf3f9188cba..a13a5838e0a6b130cb961fa4efa4b3f97ce290f1 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
@@ -54,7 +53,7 @@
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{combobox.png} -->
+    @appearance{combobox.png}
 
     @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
 */
@@ -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();
 
     //@{
     /**
@@ -150,49 +179,49 @@ public:
         Returns @true if the combobox is editable and there is a text selection
         to copy to the clipboard. Only available on Windows.
     */
-    bool CanCopy() const;
+    virtual bool CanCopy() const;
 
     /**
         Returns @true if the combobox is editable and there is a text selection
         to copy to the clipboard. Only available on Windows.
     */
-    bool CanCut() const;
+    virtual bool CanCut() const;
 
     /**
         Returns @true if the combobox is editable and there is text on the
         clipboard that can be pasted into the text field. Only available on
         Windows.
     */
-    bool CanPaste() const;
+    virtual bool CanPaste() const;
 
     /**
         Returns @true if the combobox is editable and the last undo can be
         redone. Only available on Windows.
     */
-    bool CanRedo() const;
+    virtual bool CanRedo() const;
 
     /**
         Returns @true if the combobox is editable and the last edit can be
         undone. Only available on Windows.
     */
-    bool CanUndo() const;
+    virtual bool CanUndo() const;
 
     /**
         Copies the selected text to the clipboard.
     */
-    void Copy();
+    virtual void Copy();
 
     /**
         Copies the selected text to the clipboard and removes the selection.
     */
-    void Cut();
+    virtual void Cut();
 
     /**
         This function does the same things as wxChoice::GetCurrentSelection()
         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.
@@ -200,7 +229,7 @@ public:
         @note Under wxMSW, this function always returns 0 if the combobox
               doesn't have the focus.
     */
-    long GetInsertionPoint() const;
+    virtual long GetInsertionPoint() const;
 
     /**
         Returns the last position in the combobox text field.
@@ -214,22 +243,22 @@ 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.
     */
-    wxString GetValue() const;
+    virtual wxString GetValue() const;
 
     /**
         Pastes text from the clipboard to the text field.
     */
-    void Paste();
+    virtual void Paste();
 
     /**
         Redoes the last undo in the text field. Windows only.
     */
-    void Redo();
+    virtual void Redo();
 
     /**
         Removes the text between the two positions in the combobox text field.
@@ -239,7 +268,7 @@ public:
         @param to
             The last position.
     */
-    void Remove(long from, long to);
+    virtual void Remove(long from, long to);
 
     /**
         Replaces the text between two positions with the given text, in the
@@ -252,7 +281,7 @@ public:
         @param text
             The text to insert.
     */
-    void Replace(long from, long to, const wxString& text);
+    virtual void Replace(long from, long to, const wxString& text);
 
     /**
         Sets the insertion point in the combobox text field.
@@ -260,12 +289,12 @@ public:
         @param pos
             The new insertion point.
     */
-    void SetInsertionPoint(long pos);
+    virtual void SetInsertionPoint(long pos);
 
     /**
         Sets the insertion point at the end of the combobox text field.
     */
-    void SetInsertionPointEnd();
+    virtual void SetInsertionPointEnd();
 
     /**
         Selects the text between the two positions, 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.
@@ -292,11 +321,11 @@ public:
         @param text
             The text to set.
     */
-    void SetValue(const wxString& text);
+    virtual void SetValue(const wxString& text);
 
     /**
         Undoes the last edit in the text field. Windows only.
     */
-    void Undo();
+    virtual void Undo();
 };