2008-03-08 08:52:38 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: combobox.h
|
2008-03-10 11:24:38 -04:00
|
|
|
// Purpose: interface of wxComboBox
|
2008-03-08 08:52:38 -05:00
|
|
|
// Author: wxWidgets team
|
|
|
|
// RCS-ID: $Id$
|
2010-07-13 09:29:13 -04:00
|
|
|
// Licence: wxWindows licence
|
2008-03-08 08:52:38 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
/**
|
|
|
|
@class wxComboBox
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2009-03-01 07:23:31 -05:00
|
|
|
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.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-04-12 19:27:36 -04:00
|
|
|
A combobox permits a single selection only. Combobox items are numbered
|
|
|
|
from zero.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-04-12 19:27:36 -04:00
|
|
|
If you need a customized combobox, have a look at wxComboCtrl,
|
|
|
|
wxOwnerDrawnComboBox, wxComboPopup and the ready-to-use wxBitmapComboBox.
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2009-03-01 07:23:31 -05:00
|
|
|
Please refer to wxTextEntry documentation for the description of methods
|
|
|
|
operating with the text entry part of the combobox.
|
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@beginStyleTable
|
2008-04-06 10:43:04 -04:00
|
|
|
@style{wxCB_SIMPLE}
|
2008-03-08 08:52:38 -05:00
|
|
|
Creates a combobox with a permanently displayed list. Windows only.
|
2008-04-06 10:43:04 -04:00
|
|
|
@style{wxCB_DROPDOWN}
|
2008-03-08 08:52:38 -05:00
|
|
|
Creates a combobox with a drop-down list.
|
2008-04-06 10:43:04 -04:00
|
|
|
@style{wxCB_READONLY}
|
2008-04-12 19:27:36 -04:00
|
|
|
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.
|
2008-04-06 10:43:04 -04:00
|
|
|
@style{wxCB_SORT}
|
2008-03-08 08:52:38 -05:00
|
|
|
Sorts the entries in the list alphabetically.
|
2008-04-06 10:43:04 -04:00
|
|
|
@style{wxTE_PROCESS_ENTER}
|
2008-03-08 08:52:38 -05:00
|
|
|
The control will generate the event wxEVT_COMMAND_TEXT_ENTER
|
|
|
|
(otherwise pressing Enter key is either processed internally by the
|
|
|
|
control or used for navigation between dialog controls). Windows
|
|
|
|
only.
|
|
|
|
@endStyleTable
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2009-02-18 12:58:51 -05:00
|
|
|
@beginEventEmissionTable{wxCommandEvent}
|
2008-04-06 10:43:04 -04:00
|
|
|
@event{EVT_COMBOBOX(id, func)}
|
2008-03-08 08:52:38 -05:00
|
|
|
Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
|
2008-04-12 19:27:36 -04:00
|
|
|
the list is selected. Note that calling GetValue() returns the new
|
2008-03-08 08:52:38 -05:00
|
|
|
value of selection.
|
2008-04-06 10:43:04 -04:00
|
|
|
@event{EVT_TEXT(id, func)}
|
2008-03-08 08:52:38 -05:00
|
|
|
Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text
|
|
|
|
changes.
|
2008-04-06 10:43:04 -04:00
|
|
|
@event{EVT_TEXT_ENTER(id, func)}
|
2008-03-08 08:52:38 -05:00
|
|
|
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).
|
2009-10-16 09:54:56 -04:00
|
|
|
@event{EVT_COMBOBOX_DROPDOWN(id, func)}
|
2009-03-18 06:42:58 -04:00
|
|
|
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.
|
2009-10-16 09:54:56 -04:00
|
|
|
@event{EVT_COMBOBOX_CLOSEUP(id, func)}
|
2009-03-18 06:42:58 -04:00
|
|
|
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
|
2009-10-02 10:15:35 -04:00
|
|
|
wxEVT_COMMAND_COMBOBOX_DROPDOWN above. Also note that only wxMSW
|
|
|
|
supports adding or deleting items in this event.
|
2008-03-08 08:52:38 -05:00
|
|
|
@endEventTable
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
@library{wxcore}
|
|
|
|
@category{ctrl}
|
2008-10-13 04:05:18 -04:00
|
|
|
@appearance{combobox.png}
|
2008-03-08 09:43:31 -05:00
|
|
|
|
2008-03-10 11:24:38 -04:00
|
|
|
@see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2009-03-01 07:23:31 -05:00
|
|
|
class wxComboBox : public wxControl,
|
|
|
|
public wxItemContainer,
|
|
|
|
public wxTextEntry
|
2008-03-08 08:52:38 -05:00
|
|
|
{
|
|
|
|
public:
|
2008-04-12 19:27:36 -04:00
|
|
|
/**
|
|
|
|
Default constructor.
|
|
|
|
*/
|
|
|
|
wxComboBox();
|
|
|
|
|
2008-03-08 08:52:38 -05:00
|
|
|
/**
|
|
|
|
Constructor, creating and showing a combobox.
|
2008-03-20 09:45:17 -04:00
|
|
|
|
2008-03-08 09:43:31 -05:00
|
|
|
@param parent
|
2008-03-09 08:33:59 -04:00
|
|
|
Parent window. Must not be @NULL.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param id
|
2008-03-09 08:33:59 -04:00
|
|
|
Window identifier. The value wxID_ANY indicates a default value.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param value
|
2008-03-09 08:33:59 -04:00
|
|
|
Initial selection string. An empty string indicates no selection.
|
2009-03-06 11:31:26 -05:00
|
|
|
Notice that for the controls with @c wxCB_READONLY style this
|
|
|
|
string must be one of the valid choices if it is not empty.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param pos
|
2008-03-09 08:33:59 -04:00
|
|
|
Window position.
|
2009-04-21 07:21:36 -04:00
|
|
|
If ::wxDefaultPosition is specified then a default position is chosen.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param size
|
2009-04-21 07:21:36 -04:00
|
|
|
Window size.
|
|
|
|
If ::wxDefaultSize is specified then the window is sized appropriately.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param n
|
2008-03-09 08:33:59 -04:00
|
|
|
Number of strings with which to initialise the control.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param choices
|
2008-03-09 08:33:59 -04:00
|
|
|
An array of strings with which to initialise the control.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param style
|
2008-03-09 08:33:59 -04:00
|
|
|
Window style. See wxComboBox.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param validator
|
2008-03-09 08:33:59 -04:00
|
|
|
Window validator.
|
2008-03-08 09:43:31 -05:00
|
|
|
@param name
|
2008-03-09 08:33:59 -04:00
|
|
|
Window name.
|
2008-03-20 09:45:17 -04:00
|
|
|
|
2008-04-12 19:27:36 -04:00
|
|
|
@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
|
|
|
|
|
2009-10-18 13:47:01 -04:00
|
|
|
@beginWxPerlOnly
|
|
|
|
Not supported by wxPerl.
|
|
|
|
@endWxPerlOnly
|
|
|
|
|
2008-03-09 08:33:59 -04:00
|
|
|
@see Create(), wxValidator
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2008-03-08 09:43:31 -05:00
|
|
|
wxComboBox(wxWindow* parent, wxWindowID id,
|
2009-01-10 13:31:45 -05:00
|
|
|
const wxString& value = wxEmptyString,
|
2008-03-08 09:43:31 -05:00
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
int n = 0,
|
2008-03-09 08:33:59 -04:00
|
|
|
const wxString choices[] = NULL,
|
2008-03-08 09:43:31 -05:00
|
|
|
long style = 0,
|
|
|
|
const wxValidator& validator = wxDefaultValidator,
|
2009-01-10 18:44:44 -05:00
|
|
|
const wxString& name = wxComboBoxNameStr);
|
2008-08-30 08:44:43 -04:00
|
|
|
/**
|
|
|
|
Constructor, creating and showing a combobox.
|
|
|
|
|
|
|
|
@param parent
|
|
|
|
Parent window. Must not be @NULL.
|
|
|
|
@param id
|
|
|
|
Window identifier. The value wxID_ANY indicates a default value.
|
|
|
|
@param value
|
|
|
|
Initial selection string. An empty string indicates no selection.
|
|
|
|
@param pos
|
|
|
|
Window position.
|
|
|
|
@param size
|
|
|
|
Window size. If wxDefaultSize is specified then the window is sized
|
|
|
|
appropriately.
|
|
|
|
@param choices
|
|
|
|
An array of strings with which to initialise the control.
|
|
|
|
@param style
|
|
|
|
Window style. See wxComboBox.
|
|
|
|
@param validator
|
|
|
|
Window validator.
|
|
|
|
@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
|
|
|
|
|
2009-10-18 13:47:01 -04:00
|
|
|
@beginWxPerlOnly
|
|
|
|
Use an array reference for the @a choices parameter.
|
|
|
|
@endWxPerlOnly
|
|
|
|
|
2008-08-30 08:44:43 -04:00
|
|
|
@see Create(), wxValidator
|
|
|
|
*/
|
2008-03-08 09:43:31 -05:00
|
|
|
wxComboBox(wxWindow* parent, wxWindowID id,
|
|
|
|
const wxString& value,
|
|
|
|
const wxPoint& pos,
|
|
|
|
const wxSize& size,
|
|
|
|
const wxArrayString& choices,
|
|
|
|
long style = 0,
|
|
|
|
const wxValidator& validator = wxDefaultValidator,
|
2009-01-10 18:44:44 -05:00
|
|
|
const wxString& name = wxComboBoxNameStr);
|
2008-03-08 08:52:38 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
Destructor, destroying the combobox.
|
|
|
|
*/
|
2008-09-22 15:01:17 -04:00
|
|
|
virtual ~wxComboBox();
|
2008-03-08 08:52:38 -05:00
|
|
|
|
2008-04-12 19:27:36 -04:00
|
|
|
//@{
|
2008-03-08 08:52:38 -05:00
|
|
|
/**
|
2008-04-12 19:27:36 -04:00
|
|
|
Creates the combobox for two-step construction. Derived classes should
|
|
|
|
call or replace this function. See wxComboBox() for further details.
|
|
|
|
*/
|
2009-01-10 17:10:54 -05:00
|
|
|
bool Create(wxWindow *parent, wxWindowID id,
|
|
|
|
const wxString& value = wxEmptyString,
|
2008-04-12 19:27:36 -04:00
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
2009-01-10 17:10:54 -05:00
|
|
|
int n = 0, const wxString choices[] = (const wxString *) NULL,
|
2008-04-12 19:27:36 -04:00
|
|
|
long style = 0,
|
|
|
|
const wxValidator& validator = wxDefaultValidator,
|
2009-01-10 17:10:54 -05:00
|
|
|
const wxString& name = wxComboBoxNameStr);
|
|
|
|
bool Create(wxWindow *parent, wxWindowID id,
|
2008-04-12 19:27:36 -04:00
|
|
|
const wxString& value,
|
|
|
|
const wxPoint& pos,
|
|
|
|
const wxSize& size,
|
|
|
|
const wxArrayString& choices,
|
|
|
|
long style = 0,
|
|
|
|
const wxValidator& validator = wxDefaultValidator,
|
2009-01-10 17:10:54 -05:00
|
|
|
const wxString& name = wxComboBoxNameStr);
|
2008-04-12 19:27:36 -04:00
|
|
|
//@}
|
|
|
|
|
|
|
|
/**
|
2009-03-01 07:23:31 -05:00
|
|
|
Returns the item being selected right now.
|
2008-03-08 08:52:38 -05:00
|
|
|
|
2008-04-12 19:27:36 -04:00
|
|
|
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.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2008-09-22 15:01:17 -04:00
|
|
|
virtual int GetCurrentSelection() const;
|
2008-03-08 08:52:38 -05:00
|
|
|
|
|
|
|
/**
|
2009-03-01 07:23:31 -05:00
|
|
|
Same as wxTextEntry::GetInsertionPoint().
|
2008-04-12 19:27:36 -04:00
|
|
|
|
2008-04-01 09:59:28 -04:00
|
|
|
@note Under wxMSW, this function always returns 0 if the combobox
|
2008-04-12 19:27:36 -04:00
|
|
|
doesn't have the focus.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2008-10-13 07:09:56 -04:00
|
|
|
virtual long GetInsertionPoint() const;
|
2008-03-08 08:52:38 -05:00
|
|
|
|
|
|
|
/**
|
2009-03-01 07:23:31 -05:00
|
|
|
Same as wxTextEntry::SetSelection().
|
2008-04-12 19:27:36 -04:00
|
|
|
|
|
|
|
@beginWxPythonOnly
|
|
|
|
This method is called SetMark() in wxPython, "SetSelection" is kept for
|
|
|
|
wxControlWithItems::SetSelection().
|
|
|
|
@endWxPythonOnly
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2008-09-22 15:01:17 -04:00
|
|
|
virtual void SetSelection(long from, long to);
|
2008-03-08 08:52:38 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
Sets the text for the combobox text field.
|
2008-03-28 12:19:12 -04:00
|
|
|
|
2009-04-14 10:35:20 -04:00
|
|
|
Notice that this method will generate a wxEVT_COMMAND_TEXT_UPDATED
|
|
|
|
event, use wxTextEntry::ChangeValue() if this is undesirable.
|
|
|
|
|
2008-03-28 12:19:12 -04:00
|
|
|
@note For a combobox with @c wxCB_READONLY style the string must be in
|
2008-04-12 19:27:36 -04:00
|
|
|
the combobox choices list, otherwise the call to SetValue() is
|
2010-08-22 18:16:05 -04:00
|
|
|
ignored. This is case insensitive.
|
2008-03-20 09:45:17 -04:00
|
|
|
|
2008-03-08 09:43:31 -05:00
|
|
|
@param text
|
2008-03-09 08:33:59 -04:00
|
|
|
The text to set.
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
2008-10-13 07:09:56 -04:00
|
|
|
virtual void SetValue(const wxString& text);
|
2010-01-23 20:00:45 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
Shows the list box portion of the combo box.
|
|
|
|
|
|
|
|
Currently only implemented in wxMSW and wxGTK.
|
|
|
|
|
2010-01-24 06:33:11 -05:00
|
|
|
Notice that calling this function will generate a
|
|
|
|
wxEVT_COMMAND_COMBOBOX_DROPDOWN event.
|
|
|
|
|
2010-01-23 20:00:45 -05:00
|
|
|
@since 2.9.1
|
|
|
|
*/
|
|
|
|
virtual void Popup();
|
|
|
|
|
|
|
|
/**
|
|
|
|
Hides the list box portion of the combo box.
|
|
|
|
|
|
|
|
Currently only implemented in wxMSW and wxGTK.
|
|
|
|
|
2010-01-24 06:33:11 -05:00
|
|
|
Notice that calling this function will generate a
|
|
|
|
wxEVT_COMMAND_COMBOBOX_CLOSEUP event.
|
|
|
|
|
2010-01-23 20:00:45 -05:00
|
|
|
@since 2.9.1
|
|
|
|
*/
|
|
|
|
virtual void Dismiss();
|
2008-03-08 08:52:38 -05:00
|
|
|
};
|
2008-03-10 11:24:38 -04:00
|
|
|
|