]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/mltchdlg.tex
added CreateSeparatedButtonSizer(), changed signature and semantics of CreateButtonSi...
[wxWidgets.git] / docs / latex / wx / mltchdlg.tex
index e4ad19bb79fc5b3fc2c2375328644d11c8f73722..4965fc9eff9efda423169ca97e96909c1833f43f 100644 (file)
@@ -16,7 +16,74 @@ the user to select one or more.
 
 \wxheading{See also}
 
-\helpref{wxMultiChoiceDialog overview}{wxmultichoicedialogoverview}
+\helpref{wxMultiChoiceDialog overview}{wxmultichoicedialogoverview},
+\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+\membersection{wxMultiChoiceDialog::wxMultiChoiceDialog}\label{wxmultichoicedialogconstr}
+
+\func{}{wxMultiChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
+\param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}}
+
+\func{}{wxMultiChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
+\param{const wxString\& }{caption}, \param{const wxArrayString\& }{choices}, \param{long }{style = wxCHOICEDLG\_STYLE},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}}
+
+Constructor taking an array of wxString choices.
+
+\wxheading{Parameters}
+
+\docparam{parent}{Parent window.}
+
+\docparam{message}{Message to show on the dialog.}
+
+\docparam{caption}{The dialog caption.}
+
+\docparam{n}{The number of choices.}
+
+\docparam{choices}{An array of strings, or a string list, containing the choices.}
+
+\docparam{style}{A dialog style (bitlist) containing flags chosen from standard
+dialog styles and the following:
+
+\twocolwidtha{5cm}
+\begin{twocollist}
+\twocolitem{{\bf wxOK}}{Show an OK button.}
+\twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
+\twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
+\end{twocollist}
+The default value is equivalent to {\bf wxDEFAULT\_DIALOG\_STYLE \pipe wxRESIZE\_BORDER \pipe wxOK \pipe wxCANCEL \pipe wxCENTRE}.
+}
+
+\docparam{pos}{Dialog position. Not Windows.}
+
+\wxheading{Remarks}
+
+Use \helpref{wxMultiChoiceDialog::ShowModal}{wxmultichoicedialogshowmodal} to show the dialog.
+
+\pythonnote{For Python the two parameters {\tt n} and {\tt choices} are collapsed
+into a multi parameter {\tt choices} which is expected to be a Python
+list of strings.}
+
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}.}
+
+\membersection{wxMultiChoiceDialog::GetSelections}\label{wxmultichoicedialoggetselections}
+
+\constfunc{wxArrayInt}{GetSelection}{\void}
+
+Returns array with indexes of selected items.
+
+\membersection{wxMultiChoiceDialog::SetSelections}\label{wxmultichoicedialogsetselections}
+
+\constfunc{void}{SetSelections}{\param{const wxArrayInt\&}{ selections}}
+
+Sets selected items from the array of selected items' indexes.
+
+\membersection{wxMultiChoiceDialog::ShowModal}\label{wxmultichoicedialogshowmodal}
+
+\func{int}{ShowModal}{\void}
+
+Shows the dialog, returning either wxID\_OK or wxID\_CANCEL.
+