[wxWidgets.git] / docs / latex / wx / sngchdlg.tex

\section{\class{wxSingleChoiceDialog}}\label{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.

\wxheading{Derived from}

\helpref{wxDialog}{wxdialog}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/choicdlg.h>

\wxheading{See also}

\helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogconstr}

\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices},\rtfsp
\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}}

Constructor, taking an array of wxString choices and optional client data.

\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption}, \param{const wxStringList\& }{choices},\rtfsp
\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition}}

Constructor, taking a string list and optional client data.

\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 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}
}

\docparam{pos}{Dialog position. Not Windows.}

\wxheading{Remarks}

Use \helpref{wxSingleChoiceDialog::ShowModal}{wxsinglechoicedialogshowmodal} to show the dialog.


\membersection{wxSingleChoiceDialog::\destruct{wxSingleChoiceDialog}}

\func{}{\destruct{wxSingleChoiceDialog}}{\void}

Destructor.

\membersection{wxSingleChoiceDialog::GetSelection}

\constfunc{int}{GetSelection}{\void}

Returns the index of selected item.

\membersection{wxSingleChoiceDialog::GetSelectionClientData}

\constfunc{char*}{GetSelectionClientData}{\void}

Returns the client data associated with the selection.

\membersection{wxSingleChoiceDialog::GetStringSelection}

\constfunc{wxString}{GetStringSelection}{\void}

Returns the selected string.

\membersection{wxSingleChoiceDialog::ShowModal}\label{wxsinglechoicedialogshowmodal}

\func{int}{ShowModal}{\void}

Shows the dialog, returning either wxID\_OK or wxID\_CANCEL.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxSingleChoiceDialog}}\label{wxsinglechoicedialog}
	2
	3	This class represents a dialog that shows a list of strings, and allows
	4	the user to select one. Double-clicking on a list item is equivalent to single-clicking
	5	and then pressing OK.
	6
	7	\wxheading{Derived from}
	8
	9	\helpref{wxDialog}{wxdialog}\\
	10	\helpref{wxWindow}{wxwindow}\\
	11	\helpref{wxEvtHandler}{wxevthandler}\\
	12	\helpref{wxObject}{wxobject}
	13
954b8ae6 JS	14	\wxheading{Include files}
	15
	16	<wx/choicdlg.h>
	17
a660d684 KB	18	\wxheading{See also}
	19
	20	\helpref{wxSingleChoiceDialog overview}{wxsinglechoicedialogoverview}
	21
	22	\latexignore{\rtfignore{\wxheading{Members}}}
	23
	24	\membersection{wxSingleChoiceDialog::wxSingleChoiceDialog}\label{wxsinglechoicedialogconstr}
	25
	26	\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
eaaa6a06	27	\param{const wxString\& }{caption}, \param{int }{n}, \param{const wxString* }{choices},\rtfsp
a660d684 KB	28	\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
	29	\param{const wxPoint\& }{pos = wxDefaultPosition}}
	30
	31	Constructor, taking an array of wxString choices and optional client data.
	32
	33	\func{}{wxSingleChoiceDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
	34	\param{const wxString\& }{caption}, \param{const wxStringList\& }{choices},\rtfsp
	35	\param{char**}{ clientData = NULL}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE},\rtfsp
	36	\param{const wxPoint\& }{pos = wxDefaultPosition}}
	37
	38	Constructor, taking a string list and optional client data.
	39
	40	\wxheading{Parameters}
	41
	42	\docparam{parent}{Parent window.}
	43
	44	\docparam{message}{Message to show on the dialog.}
	45
	46	\docparam{caption}{The dialog caption.}
	47
	48	\docparam{n}{The number of choices.}
	49
	50	\docparam{choices}{An array of strings, or a string list, containing the choices.}
	51
	52	\docparam{style}{A dialog style (bitlist) containing flags chosen from the following:
	53
	54	\twocolwidtha{5cm}
	55	\begin{twocollist}
	56	\twocolitem{{\bf wxOK}}{Show an OK button.}
	57	\twocolitem{{\bf wxCANCEL}}{Show a Cancel button.}
	58	\twocolitem{{\bf wxCENTRE}}{Centre the message. Not Windows.}
	59	\end{twocollist}
	60	}
	61
	62	\docparam{pos}{Dialog position. Not Windows.}
	63
	64	\wxheading{Remarks}
	65
	66	Use \helpref{wxSingleChoiceDialog::ShowModal}{wxsinglechoicedialogshowmodal} to show the dialog.
	67
	68
	69	\membersection{wxSingleChoiceDialog::\destruct{wxSingleChoiceDialog}}
	70
	71	\func{}{\destruct{wxSingleChoiceDialog}}{\void}
	72
	73	Destructor.
	74
	75	\membersection{wxSingleChoiceDialog::GetSelection}
	76
	77	\constfunc{int}{GetSelection}{\void}
	78
	79	Returns the index of selected item.
	80
	81	\membersection{wxSingleChoiceDialog::GetSelectionClientData}
	82
	83	\constfunc{char*}{GetSelectionClientData}{\void}
	84
	85	Returns the client data associated with the selection.
	86
	87	\membersection{wxSingleChoiceDialog::GetStringSelection}
	88
	89	\constfunc{wxString}{GetStringSelection}{\void}
	90
	91	Returns the selected string.
92
93	\membersection{wxSingleChoiceDialog::ShowModal}\label{wxsinglechoicedialogshowmodal}
94
95	\func{int}{ShowModal}{\void}
96
97	Shows the dialog, returning either wxID\_OK or wxID\_CANCEL.
98