wxsinglechoicedialog

this class represents a dialog that shows a list of strings, and allows the user to select one. double-clicking on a list item is equivalent to single-clicking and then pressing ok.

derived from

wxdialog
wxwindow
wxevthandler
wxobject

include files

<wx/choicdlg.h>

see also

wxsinglechoicedialog overview, wxmultichoicedialog

members

wxsinglechoicedialog::wxsinglechoicedialog
wxsinglechoicedialog::getselection
wxsinglechoicedialog::getselectionclientdata
wxsinglechoicedialog::getstringselection
wxsinglechoicedialog::setselection
wxsinglechoicedialog::showmodal

wxsinglechoicedialog::wxsinglechoicedialog

wxsinglechoicedialog(wxwindow* parent, const wxstring& message, const wxstring& caption, int n, const wxstring* choices, void** clientdata = null, long style = wxchoicedlg_style, const wxpoint& pos = wxdefaultposition)

wxsinglechoicedialog(wxwindow* parent, const wxstring& message, const wxstring& caption, const wxarraystring& choices, void** clientdata = null, long style = wxchoicedlg_style, const wxpoint& pos = wxdefaultposition)

constructor, taking an array of wxstring choices and optional client data.

parameters

parent

parent window.

message

message to show on the dialog.

caption

the dialog caption.

n

the number of choices.

choices

an array of strings, or a string list, containing the choices.

clientdata

an array of client data to be associated with the items. see getselectionclientdata.

style

a dialog style (bitlist) containing flags chosen from standard dialog styles and the following:

wxok	show an ok button.
wxcancel	show a cancel button.
wxcentre	centre the message. not windows.

the default value is equivalent to wxdefault_dialog_style | wxresize_border | wxok | wxcancel | wxcentre.

pos

dialog position. not windows.

remarks

use wxsinglechoicedialog::showmodal to show the dialog.

wxpython note: for python the two parameters n and choices are collapsed into a single parameter choices which is expected to be a python list of strings.

wxperl note: in wxperl there is just an array reference in place of n and choices, and the client data array, if present, must have the same length as the choices array.

wxsinglechoicedialog::getselection

int getselection() const

returns the index of selected item.

wxsinglechoicedialog::getselectionclientdata

char* getselectionclientdata() const

returns the client data associated with the selection.

wxsinglechoicedialog::getstringselection

wxstring getstringselection() const

returns the selected string.

wxsinglechoicedialog::setselection

void setselection(int selection) const

sets the index of the initially selected item.

wxsinglechoicedialog::showmodal

int showmodal()

shows the dialog, returning either wxid_ok or wxid_cancel.