git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxDirDialog}}\label{wxdirdialog}
	2
	3	This class represents the directory chooser dialog.
	4
	5	\wxheading{Derived from}
	6
	7	\helpref{wxDialog}{wxdialog}\\
	8	\helpref{wxWindow}{wxwindow}\\
	9	\helpref{wxEvtHandler}{wxevthandler}\\
	10	\helpref{wxObject}{wxobject}
	11
	12	\wxheading{Include files}
	13
	14	<wx/dirdlg.h>
	15
	16	\wxheading{Library}
	17
	18	\helpref{wxCore}{librarieslist}
	19
	20	\wxheading{Window styles}
	21
	22	\begin{twocollist}\itemsep=0pt
	23	\twocolitem{\windowstyle{wxDD\_DEFAULT\_STYLE}}{Equivalent to a combination of wxDEFAULT\_DIALOG\_STYLE and wxRESIZE\_BORDER (the last one is not used under wxWinCE).}
	24	\twocolitem{\windowstyle{wxDD\_DIR\_MUST\_EXIST}}{The dialog will allow the user to choose only an existing folder. When this style is not given, a "Create new directory" button is added to the dialog (on Windows) or some other way is provided to the user to type the name of a new folder.}
	25	\twocolitem{\windowstyle{wxDD\_CHANGE\_DIR}}{Change the current working directory to the directory chosen by the user.}
	26	\end{twocollist}
	27
	28	{\bf NB:} on Windows the new directory button is only available with recent versions of the common dialogs.
	29
	30	See also \helpref{Generic window styles}{windowstyles}.
	31
	32	\wxheading{See also}
	33
	34	\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}
	35
	36	\latexignore{\rtfignore{\wxheading{Members}}}
	37
	38	\membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogctor}
	39
	40	\func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
	41	\param{const wxString\& }{defaultPath = ""}, \param{long }{style = wxDD\_DEFAULT\_STYLE},\rtfsp
	42	\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
	43	\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
	44	\param{const wxString\& }{name = "wxDirCtrl"}}
	45
	46	Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show
	47	the dialog.
	48
	49	\wxheading{Parameters}
	50
	51	\docparam{parent}{Parent window.}
	52
	53	\docparam{message}{Message to show on the dialog.}
	54
	55	\docparam{defaultPath}{The default path, or the empty string.}
	56
	57	\docparam{style}{The dialog style. See \helpref{wxDirDialog}{wxdirdialog}}
	58
	59	\docparam{pos}{Dialog position. Ignored under Windows.}
	60
	61	\docparam{size}{Dialog size. Ignored under Windows.}
	62
	63	\docparam{name}{The dialog name, not used.}
	64
	65	\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor}
	66
	67	\func{}{\destruct{wxDirDialog}}{\void}
	68
	69	Destructor.
	70
	71	\membersection{wxDirDialog::GetPath}\label{wxdirdialoggetpath}
	72
	73	\constfunc{wxString}{GetPath}{\void}
	74
	75	Returns the default or user-selected path.
	76
	77	\membersection{wxDirDialog::GetMessage}\label{wxdirdialoggetmessage}
	78
	79	\constfunc{wxString}{GetMessage}{\void}
	80
	81	Returns the message that will be displayed on the dialog.
	82
	83	\membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}
	84
	85	\func{void}{SetMessage}{\param{const wxString\& }{message}}
	86
	87	Sets the message that will be displayed on the dialog.
	88
	89	\membersection{wxDirDialog::SetPath}\label{wxdirdialogsetpath}
	90
	91	\func{void}{SetPath}{\param{const wxString\& }{path}}
	92
	93	Sets the default path.
	94
	95	\membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal}
	96
	97	\func{int}{ShowModal}{\void}
	98
	99	Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
	100	otherwise.
	101
	102