X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/792255cc6d3dfd55626c821bb8fdea48bfe919ba..5b88a837ba75928cd3835a6b97ae2bf5ad983a6e:/interface/wx/combobox.h diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index f0a56fa4a4..93e7f3eee7 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -9,9 +9,11 @@ /** @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. A combobox permits a single selection only. Combobox items are numbered from zero. @@ -19,6 +21,9 @@ 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. + @beginStyleTable @style{wxCB_SIMPLE} Creates a combobox with a permanently displayed list. Windows only. @@ -37,7 +42,7 @@ only. @endStyleTable - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_COMBOBOX(id, func)} Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on the list is selected. Note that calling GetValue() returns the new @@ -49,15 +54,27 @@ 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)} + 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)} + 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. @endEventTable @library{wxcore} @category{ctrl} - <!-- @appearance{combobox.png} --> + @appearance{combobox.png} @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent */ -class wxComboBox : public wxControl, public wxItemContainer +class wxComboBox : public wxControl, + public wxItemContainer, + public wxTextEntry { public: /** @@ -75,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 @@ -99,14 +119,14 @@ public: @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. @@ -144,176 +164,70 @@ public: const wxArrayString& choices, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + const wxString& name = wxComboBoxNameStr); //@} /** Destructor, destroying the combobox. */ - ~wxComboBox(); + virtual ~wxComboBox(); //@{ /** 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 @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 the item being selected right now. - /** - 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. */ - int GetCurrentSelection() const; + 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; - - /** - Returns the last position in the combobox text field. - */ - virtual wxTextPos GetLastPosition() const; - - /** - 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(). - - Currently this method is only implemented in wxMSW and wxGTK. - */ - void GetSelection(long* from, long* to) const; + virtual long GetInsertionPoint() const; /** - Returns the current value in the combobox text field. - */ - wxString GetValue() const; - - /** - Pastes text from the clipboard to the text field. - */ - void Paste(); - - /** - Redoes the last undo in the text field. Windows only. - */ - void Redo(); - - /** - Removes the text between the two positions in the combobox text field. - - @param from - The first position. - @param to - The last position. - */ - void Remove(long from, long to); - - /** - Replaces the text between two positions with the given text, in the - combobox text field. - - @param from - The first position. - @param to - The second position. - @param text - The text to insert. - */ - void Replace(long from, long to, const wxString& text); - - /** - Sets the insertion point in the combobox text field. - - @param pos - The new insertion point. - */ - void SetInsertionPoint(long pos); - - /** - Sets the insertion point at the end of the combobox text field. - */ - void SetInsertionPointEnd(); - - /** - Selects the text between the two positions, in the combobox text field. - - @param from - The first position. - @param to - The second position. + Same as wxTextEntry::SetSelection(). @beginWxPythonOnly This method is called SetMark() in wxPython, "SetSelection" is kept for wxControlWithItems::SetSelection(). @endWxPythonOnly */ - void SetSelection(long from, long to); + virtual void SetSelection(long from, long to); /** 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. @@ -321,11 +235,6 @@ public: @param text The text to set. */ - void SetValue(const wxString& text); - - /** - Undoes the last edit in the text field. Windows only. - */ - void Undo(); + virtual void SetValue(const wxString& text); };