Improved documentation for wxPGProperty::DoSetAttribute()

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

diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h
index 1e344758af562d095a098cecc00199f49ae8ad43..67029f392beb81904be14ad5b0c76983d8bd049d 100644 (file)
--- a/interface/wx/combobox.h
+++ b/interface/wx/combobox.h
@@ -54,16 +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).
            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_COMBOX_DROPDOWN(id, func)}
+    @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.
            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_COMBOX_CLOSEUP(id, func)}
+    @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
            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.
+           wxEVT_COMMAND_COMBOBOX_DROPDOWN above. Also note that only wxMSW
+           supports adding or deleting items in this event.

     @endEventTable
 
     @library{wxcore}
     @endEventTable
 
     @library{wxcore}


@@ -82,7 +83,6 @@ public:
     */
     wxComboBox();
 
     */
     wxComboBox();
 

-    //@{

     /**
         Constructor, creating and showing a combobox.
 
     /**
         Constructor, creating and showing a combobox.
 


@@ -96,9 +96,10 @@ public:
             string must be one of the valid choices if it is not empty.
         @param pos
             Window position.
             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
         @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
         @param n
             Number of strings with which to initialise the control.
         @param choices


@@ -115,6 +116,10 @@ public:
         arguments are to a single argument, which is a list of strings.
         @endWxPythonOnly
 
         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,
         @see Create(), wxValidator
     */
     wxComboBox(wxWindow* parent, wxWindowID id,


@@ -154,6 +159,10 @@ public:
         arguments are to a single argument, which is a list of strings.
         @endWxPythonOnly
 
         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,
         @see Create(), wxValidator
     */
     wxComboBox(wxWindow* parent, wxWindowID id,


@@ -164,7 +173,6 @@ public:
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxComboBoxNameStr);
                long style = 0,
                const wxValidator& validator = wxDefaultValidator,
                const wxString& name = wxComboBoxNameStr);

-    //@}

 
     /**
         Destructor, destroying the combobox.
 
     /**
         Destructor, destroying the combobox.


@@ -224,6 +232,9 @@ public:
     /**
         Sets the text for the combobox text field.
 
     /**
         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.
         @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.