X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3a194bda7be7c240a3856413e19d7152ecfd7439..4e621d24713f971d1a2d440f79ccc4593aede4b6:/interface/wx/combobox.h diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index 602916cccf..bbe877bd1b 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -116,11 +116,6 @@ public: @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 - @beginWxPerlOnly Not supported by wxPerl. @endWxPerlOnly @@ -159,11 +154,6 @@ public: @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 - @beginWxPerlOnly Use an array reference for the @a choices parameter. @endWxPerlOnly @@ -225,12 +215,40 @@ public: virtual long GetInsertionPoint() const; /** - Same as wxTextEntry::SetSelection(). + IsEmpty() is not available in this class. + + This method is documented here only to notice that it can't be used + with this class because of the ambiguity between the methods with the + same name inherited from wxItemContainer and wxTextEntry base classes. + + Because of this, any attempt to call it results in a compilation error + and you should use either IsListEmpty() or IsTextEmpty() depending on + what exactly do you want to test. + */ + bool IsEmpty() const; + + /** + Returns true if the list of combobox choices is empty. + + Use this method instead of (not available in this class) IsEmpty() to + test if the list of items is empty. + + @since 2.9.3 + */ + bool IsListEmpty() const; + + /** + Returns true if the text of the combobox is empty. + + Use this method instead of (not available in this class) IsEmpty() to + test if the text currently entered into the combobox is empty. + + @since 2.9.3 + */ + bool IsTextEmpty() const; - @beginWxPythonOnly - This method is called SetMark() in wxPython, "SetSelection" is kept for - wxControlWithItems::SetSelection(). - @endWxPythonOnly + /** + Same as wxTextEntry::SetSelection(). */ virtual void SetSelection(long from, long to); @@ -252,10 +270,11 @@ public: /** Shows the list box portion of the combo box. - Currently only implemented in wxMSW and wxGTK. + Currently this method is implemented in wxMSW, wxGTK and wxOSX/Cocoa. Notice that calling this function will generate a - @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event. + @c wxEVT_COMMAND_COMBOBOX_DROPDOWN event except under wxOSX where + generation of this event is not supported at all. @since 2.9.1 */ @@ -264,13 +283,32 @@ public: /** Hides the list box portion of the combo box. - Currently only implemented in wxMSW and wxGTK. + Currently this method is implemented in wxMSW, wxGTK and wxOSX/Cocoa. Notice that calling this function will generate a - @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event. + @c wxEVT_COMMAND_COMBOBOX_CLOSEUP event except under wxOSX where + generation of this event is not supported at all. @since 2.9.1 */ virtual void Dismiss(); + + virtual int GetSelection() const; + virtual void GetSelection(long *from, long *to) const; + virtual void SetSelection(int n); + virtual int FindString(const wxString& s, bool bCase = false) const; + virtual wxString GetString(unsigned int n) const; + virtual wxString GetStringSelection() const; + + /** + Changes the text of the specified combobox item. + + Notice that if the item is the currently selected one, i.e. if its text + is displayed in the text part of the combobox, then the text is also + replaced with the new @a text. + */ + virtual void SetString(unsigned int n, const wxString& text); + + virtual unsigned int GetCount() const; };