X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b7e94bd7ebc205ffba5e2729b0d465778d4e48c6..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/combobox.h diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index e3324620a1..d3e75c84ab 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -2,16 +2,17 @@ // Name: combobox.h // Purpose: interface of wxComboBox // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxComboBox - 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 - drop-down list with text field; or a drop-down list without a text field. + 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 drop-down list with text field; or a drop-down list without a text + field depending on the platform and presence of wxCB_READONLY style. A combobox permits a single selection only. Combobox items are numbered from zero. @@ -19,45 +20,65 @@ If you need a customized combobox, have a look at wxComboCtrl, wxOwnerDrawnComboBox, wxComboPopup and the ready-to-use wxBitmapComboBox. + Please refer to wxTextEntry documentation for the description of methods + operating with the text entry part of the combobox and to wxItemContainer + for the methods operating with the list of strings. Notice that at least + under MSW wxComboBox doesn't behave correctly if it contains strings + differing in case only so portable programs should avoid adding such + strings to this control. + @beginStyleTable @style{wxCB_SIMPLE} Creates a combobox with a permanently displayed list. Windows only. @style{wxCB_DROPDOWN} - Creates a combobox with a drop-down list. + Creates a combobox with a drop-down list. MSW and Motif only. @style{wxCB_READONLY} - Same as wxCB_DROPDOWN but only the strings specified as the combobox - choices can be selected, it is impossible to select (even from a - program) a string which is not in the choices list. + A combobox with this style behaves like a wxChoice (and may look in + the same way as well, although this is platform-dependent), i.e. it + allows the user to choose from the list of options but doesn't allow + to enter a value not present in the list. @style{wxCB_SORT} Sorts the entries in the list alphabetically. @style{wxTE_PROCESS_ENTER} - The control will generate the event wxEVT_COMMAND_TEXT_ENTER + The control will generate the event @c wxEVT_TEXT_ENTER (otherwise pressing Enter key is either processed internally by the - control or used for navigation between dialog controls). Windows - only. + control or used for navigation between dialog controls). @endStyleTable - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_COMBOBOX(id, func)} - Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on + Process a @c wxEVT_COMBOBOX event, when an item on the list is selected. Note that calling GetValue() returns the new value of selection. @event{EVT_TEXT(id, func)} - Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text + Process a @c wxEVT_TEXT event, when the combobox text changes. @event{EVT_TEXT_ENTER(id, func)} - Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in + Process a @c wxEVT_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 @c wxEVT_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 @c wxEVT_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 + @c wxEVT_COMBOBOX_DROPDOWN above. Also note that only wxMSW + supports adding or deleting items in this event. @endEventTable @library{wxcore} @category{ctrl} - + @appearance{combobox} @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent */ -class wxComboBox : public wxControl, public wxItemContainer +class wxComboBox : public wxControl, + public wxItemContainer, + public wxTextEntry { public: /** @@ -65,7 +86,6 @@ public: */ wxComboBox(); - //@{ /** Constructor, creating and showing a combobox. @@ -75,11 +95,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 @@ -91,22 +114,21 @@ 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 @see Create(), wxValidator */ wxComboBox(wxWindow* parent, wxWindowID id, - const wxString& value = "", + const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, int n = 0, const wxString choices[] = NULL, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + const wxString& name = wxComboBoxNameStr); /** Constructor, creating and showing a combobox. @@ -130,10 +152,9 @@ 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 @see Create(), wxValidator */ @@ -144,8 +165,7 @@ public: const wxArrayString& choices, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); - //@} + const wxString& name = wxComboBoxNameStr); /** Destructor, destroying the combobox. @@ -157,66 +177,27 @@ public: Creates the combobox for two-step construction. Derived classes should call or replace this function. See wxComboBox() for further details. */ - bool Create(wxWindow* parent, wxWindowID id, - const wxString& value = "", + bool Create(wxWindow *parent, wxWindowID id, + const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - int n, const wxString choices[], + int n = 0, const wxString choices[] = (const wxString *) NULL, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); - bool Create(wxWindow* parent, wxWindowID id, + const wxString& name = wxComboBoxNameStr); + bool Create(wxWindow *parent, wxWindowID id, const wxString& value, const wxPoint& pos, const wxSize& size, const wxArrayString& choices, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + const wxString& name = wxComboBoxNameStr); //@} /** - 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; + Returns the item being selected right now. - /** - 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; - - /** - 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; - - /** - Returns @true if the combobox is editable and the last undo can be - redone. Only available on Windows. - */ - bool CanRedo() const; - - /** - Returns @true if the combobox is editable and the last edit can be - undone. Only available on Windows. - */ - bool CanUndo() const; - - /** - Copies the selected text to the clipboard. - */ - void Copy(); - - /** - Copies the selected text to the clipboard and removes the selection. - */ - 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. @@ -224,108 +205,108 @@ public: virtual int GetCurrentSelection() const; /** - Returns the insertion point for the combobox's text field. + Same as wxTextEntry::GetInsertionPoint(). @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. - */ - virtual wxTextPos GetLastPosition() const; + IsEmpty() is not available in this class. - /** - This is the same as wxTextCtrl::GetSelection() for the text control - which is part of the combobox. Notice that this is a different method - from wxControlWithItems::GetSelection(). + 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. - Currently this method is only implemented in wxMSW and wxGTK. - */ - virtual void GetSelection(long* from, long* to) const; + 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 the current value in the combobox text field. - */ - wxString GetValue() 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; /** - Pastes text from the clipboard to the text field. - */ - void Paste(); + 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; /** - Redoes the last undo in the text field. Windows only. + Same as wxTextEntry::SetSelection(). */ - void Redo(); + virtual void SetSelection(long from, long to); /** - Removes the text between the two positions in the combobox text field. + Sets the text for the combobox text field. - @param from - The first position. - @param to - The last position. - */ - void Remove(long from, long to); + Notice that this method will generate a @c wxEVT_TEXT + event, use wxTextEntry::ChangeValue() if this is undesirable. - /** - Replaces the text between two positions with the given text, in the - combobox text field. + @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. This is case insensitive. - @param from - The first position. - @param to - The second position. @param text - The text to insert. + The text to set. */ - void Replace(long from, long to, const wxString& text); + virtual void SetValue(const wxString& text); /** - Sets the insertion point in the combobox text field. + Shows the list box portion of the combo box. - @param pos - The new insertion point. - */ - void SetInsertionPoint(long pos); + Currently this method is implemented in wxMSW, wxGTK and wxOSX/Cocoa. - /** - Sets the insertion point at the end of the combobox text field. + Notice that calling this function will generate a + @c wxEVT_COMBOBOX_DROPDOWN event except under wxOSX where + generation of this event is not supported at all. + + @since 2.9.1 */ - void SetInsertionPointEnd(); + virtual void Popup(); /** - Selects the text between the two positions, in the combobox text field. + Hides the list box portion of the combo box. - @param from - The first position. - @param to - The second position. + Currently this method is implemented in wxMSW, wxGTK and wxOSX/Cocoa. - @beginWxPythonOnly - This method is called SetMark() in wxPython, "SetSelection" is kept for - wxControlWithItems::SetSelection(). - @endWxPythonOnly + Notice that calling this function will generate a + @c wxEVT_COMBOBOX_CLOSEUP event except under wxOSX where + generation of this event is not supported at all. + + @since 2.9.1 */ - virtual void SetSelection(long from, long to); + virtual void Dismiss(); - /** - Sets the text for the combobox text field. + 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; - @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. + /** + Changes the text of the specified combobox item. - @param text - The text to set. - */ - void SetValue(const wxString& text); + 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); - /** - Undoes the last edit in the text field. Windows only. - */ - void Undo(); + virtual unsigned int GetCount() const; };