]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/mltchdlg.tex
Patches-1851591 ] dataview sample is crashing (under MSW)
[wxWidgets.git] / docs / latex / wx / mltchdlg.tex
1 \section{\class{wxMultiChoiceDialog}}\label{wxmultichoicedialog}
2
3 This class represents a dialog that shows a list of strings, and allows
4 the user to select one or more.
5
6 \wxheading{Derived from}
7
8 \helpref{wxDialog}{wxdialog}\\
9 \helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
10 \helpref{wxWindow}{wxwindow}\\
11 \helpref{wxEvtHandler}{wxevthandler}\\
12 \helpref{wxObject}{wxobject}
13
14 \wxheading{Include files}
15
16 <wx/choicdlg.h>
17
18 \wxheading{See also}
19
20 \helpref{wxMultiChoiceDialog overview}{wxmultichoicedialogoverview},
21 \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}
22
23 \latexignore{\rtfignore{\wxheading{Members}}}
24
25 \membersection{wxMultiChoiceDialog::wxMultiChoiceDialog}\label{wxmultichoicedialogconstr}
26
27 \func{}{wxMultiChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
28 \param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
29 \param{const wxPoint\& }{pos = wxDefaultPosition}}
30
31 \func{}{wxMultiChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
32 \param{const wxString\& }{caption}, \param{const wxArrayString\& }{choices}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
33 \param{const wxPoint\& }{pos = wxDefaultPosition}}
34
35 Constructor taking an array of wxString choices.
36
37 \wxheading{Parameters}
38
39 \docparam{parent}{Parent window.}
40
41 \docparam{message}{Message to show on the dialog.}
42
43 \docparam{caption}{The dialog caption.}
44
45 \docparam{n}{The number of choices.}
46
47 \docparam{choices}{An array of strings, or a string list, containing the choices.}
48
49 \docparam{style}{A dialog style (bitlist) containing flags chosen from standard
50 dialog styles and the following:
51
52 \twocolwidtha{5cm}
53 \begin{twocollist}
54 \twocolitem{{\bf wxOK}}{Show an OK button.}
55 \twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
56 \twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
57 \end{twocollist}
58 The default value is equivalent to {\bf wxDEFAULT\_DIALOG\_STYLE \pipe wxRESIZE\_BORDER \pipe wxOK \pipe wxCANCEL \pipe wxCENTRE}.
59 }
60
61 \docparam{pos}{Dialog position. Not Windows.}
62
63 \wxheading{Remarks}
64
65 Use \helpref{wxMultiChoiceDialog::ShowModal}{wxmultichoicedialogshowmodal} to show the dialog.
66
67 \pythonnote{For Python the two parameters {\tt n} and {\tt choices} are collapsed
68 into a multi parameter {\tt choices} which is expected to be a Python
69 list of strings.}
70
71 \perlnote{In wxPerl there is just an array reference in place of {\tt n}.}
72
73 \membersection{wxMultiChoiceDialog::GetSelections}\label{wxmultichoicedialoggetselections}
74
75 \constfunc{wxArrayInt}{GetSelection}{\void}
76
77 Returns array with indexes of selected items.
78
79 \membersection{wxMultiChoiceDialog::SetSelections}\label{wxmultichoicedialogsetselections}
80
81 \constfunc{void}{SetSelections}{\param{const wxArrayInt\&}{ selections}}
82
83 Sets selected items from the array of selected items' indexes.
84
85 \membersection{wxMultiChoiceDialog::ShowModal}\label{wxmultichoicedialogshowmodal}
86
87 \func{int}{ShowModal}{\void}
88
89 Shows the dialog, returning either wxID\_OK or wxID\_CANCEL.
90