Add wxVectorSort function for sorting wxVector<T> containers. Closes #11889

[wxWidgets.git] / interface / wx / combobox.h

diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h
index ca08253bf4d1f7597115979c564c20861d197656..ba7bbc3eafeaca6e3895b8639179f3e45f1706fa 100644 (file)
--- a/interface/wx/combobox.h
+++ b/interface/wx/combobox.h
@@ -54,6 +54,17 @@
            Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in
            the combobox (notice that the combobox must have been created with
            wxTE_PROCESS_ENTER style to receive this event).
+    @event{EVT_COMBOBOX_DROPDOWN(id, func)}
+           Process a wxEVT_COMMAND_COMBOBOX_DROPDOWN event, which is generated
+           when the list box part of the combo box is shown (drops down).
+           Notice that this event is currently only supported by wxMSW and
+           wxGTK with GTK+ 2.10 or later.
+    @event{EVT_COMBOBOX_CLOSEUP(id, func)}
+           Process a wxEVT_COMMAND_COMBOBOX_CLOSEUP event, which is generated
+           when the list box of the combo box disappears (closes up). This
+           event is only generated for the same platforms as
+           wxEVT_COMMAND_COMBOBOX_DROPDOWN above. Also note that only wxMSW
+           supports adding or deleting items in this event.
     @endEventTable
 
     @library{wxcore}
@@ -72,7 +83,6 @@ public:
     */
     wxComboBox();
 
-    //@{
     /**
         Constructor, creating and showing a combobox.
 
@@ -82,11 +92,14 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param value
             Initial selection string. An empty string indicates no selection.
+            Notice that for the controls with @c wxCB_READONLY style this
+            string must be one of the valid choices if it is not empty.
         @param pos
             Window position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @param size
-            Window size. If wxDefaultSize is specified then the window is sized
-            appropriately.
+            Window size. 
+            If ::wxDefaultSize is specified then the window is sized appropriately.
         @param n
             Number of strings with which to initialise the control.
         @param choices
@@ -103,6 +116,10 @@ public:
         arguments are to a single argument, which is a list of strings.
         @endWxPythonOnly
 
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly
+
         @see Create(), wxValidator
     */
     wxComboBox(wxWindow* parent, wxWindowID id,
@@ -142,6 +159,10 @@ public:
         arguments are to a single argument, which is a list of strings.
         @endWxPythonOnly
 
+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @endWxPerlOnly
+
         @see Create(), wxValidator
     */
     wxComboBox(wxWindow* parent, wxWindowID id,
@@ -152,7 +173,6 @@ public:
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxComboBoxNameStr);
-    //@}
 
     /**
         Destructor, destroying the combobox.
@@ -212,6 +232,9 @@ public:
     /**
         Sets the text for the combobox text field.
 
+        Notice that this method will generate a wxEVT_COMMAND_TEXT_UPDATED
+        event, use wxTextEntry::ChangeValue() if this is undesirable.
+
         @note For a combobox with @c wxCB_READONLY style the string must be in
               the combobox choices list, otherwise the call to SetValue() is
               ignored.
@@ -220,5 +243,29 @@ public:
             The text to set.
     */
     virtual void SetValue(const wxString& text);
+
+    /**
+        Shows the list box portion of the combo box.
+
+        Currently only implemented in wxMSW and wxGTK.
+
+        Notice that calling this function will generate a
+        wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
+
+        @since 2.9.1
+    */
+    virtual void Popup();
+
+    /**
+        Hides the list box portion of the combo box.
+
+        Currently only implemented in wxMSW and wxGTK.
+
+        Notice that calling this function will generate a
+        wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
+
+        @since 2.9.1
+    */
+    virtual void Dismiss();
 };