Document wxComboBox::SetValue() better in wxCB_READONLY case

Make it clear that the control doesn't send wxEVT_TEXT event in this
case.
This commit is contained in:
Vadim Zeitlin
2017-11-25 10:38:40 +01:00
parent 075ebbe12a
commit 838a687d94

View File

@@ -253,12 +253,15 @@ public:
/** /**
Sets the text for the combobox text field. Sets the text for the combobox text field.
Notice that this method will generate a @c wxEVT_TEXT For normal, editable comboboxes with a text entry field calling this
event, use wxTextEntry::ChangeValue() if this is undesirable. method will generate a @c wxEVT_TEXT event, consistently with
wxTextEntry::SetValue() behaviour, use wxTextEntry::ChangeValue() if
this is undesirable.
@note For a combobox with @c wxCB_READONLY style the string must be in For controls with @c wxCB_READONLY style the method behaves somewhat
the combobox choices list, otherwise the call to SetValue() is differently: the string must be in the combobox choices list (the check
ignored. This is case insensitive. for this is case-insensitive) and @c wxEVT_TEXT is @e not generated in
this case.
@param text @param text
The text to set. The text to set.