1998-05-20 10:25:30 -04:00
\section { \class { wxDirDialog} } \label { wxdirdialog}
This class represents the directory chooser dialog.
\wxheading { Derived from}
\helpref { wxDialog} { wxdialog} \\
\helpref { wxWindow} { wxwindow} \\
\helpref { wxEvtHandler} { wxevthandler} \\
\helpref { wxObject} { wxobject}
1999-02-15 15:41:29 -05:00
\wxheading { Include files}
<wx/dirdlg.h>
2002-04-10 05:35:36 -04:00
2007-07-28 08:21:03 -04:00
\wxheading { Library}
\helpref { wxCore} { librarieslist}
2002-04-10 05:35:36 -04:00
\wxheading { Window styles}
2006-05-06 16:10:11 -04:00
\begin { twocollist} \itemsep =0pt
2006-05-28 19:32:12 -04:00
\twocolitem { \windowstyle { wxDD\_ DEFAULT\_ STYLE} } { Equivalent to a combination of wxDEFAULT\_ DIALOG\_ STYLE and wxRESIZE\_ BORDER (the last one is not used under wxWinCE).}
2006-07-22 14:47:17 -04:00
\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.}
2006-05-06 16:10:11 -04:00
\twocolitem { \windowstyle { wxDD\_ CHANGE\_ DIR} } { Change the current working directory to the directory chosen by the user.}
2002-04-10 05:35:36 -04:00
\end { twocollist}
2006-05-28 19:32:12 -04:00
{ \bf NB:} on Windows the new directory button is only available with recent versions of the common dialogs.
2002-04-10 05:35:36 -04:00
See also \helpref { Generic window styles} { windowstyles} .
1999-02-15 15:41:29 -05:00
1998-05-20 10:25:30 -04:00
\wxheading { See also}
\helpref { wxDirDialog overview} { wxdirdialogoverview} , \helpref { wxFileDialog} { wxfiledialog}
\latexignore { \rtfignore { \wxheading { Members} } }
2004-09-21 09:24:41 -04:00
\membersection { wxDirDialog::wxDirDialog} \label { wxdirdialogctor}
1998-05-20 10:25:30 -04:00
\func { } { wxDirDialog} { \param { wxWindow* } { parent} , \param { const wxString\& } { message = "Choose a directory"} ,\rtfsp
2005-09-20 06:57:33 -04:00
\param { const wxString\& } { defaultPath = ""} , \param { long } { style = wxDD\_ DEFAULT\_ STYLE} ,\rtfsp
2002-05-04 08:43:49 -04:00
\param { const wxPoint\& } { pos = wxDefaultPosition} ,\rtfsp
\param { const wxSize\& } { size = wxDefaultSize} ,\rtfsp
\param { const wxString\& } { name = "wxDirCtrl"} }
1998-05-20 10:25:30 -04:00
2002-05-04 08:43:49 -04:00
Constructor. Use \helpref { wxDirDialog::ShowModal} { wxdirdialogshowmodal} to show
the dialog.
1998-05-20 10:25:30 -04:00
\wxheading { Parameters}
\docparam { parent} { Parent window.}
\docparam { message} { Message to show on the dialog.}
\docparam { defaultPath} { The default path, or the empty string.}
2005-09-20 06:57:33 -04:00
\docparam { style} { The dialog style. See \helpref { wxDirDialog} { wxdirdialog} }
1998-05-20 10:25:30 -04:00
2002-05-04 08:43:49 -04:00
\docparam { pos} { Dialog position. Ignored under Windows.}
\docparam { size} { Dialog size. Ignored under Windows.}
\docparam { name} { The dialog name, not used.}
1998-05-20 10:25:30 -04:00
2004-09-20 07:21:04 -04:00
\membersection { wxDirDialog::\destruct { wxDirDialog} } \label { wxdirdialogdtor}
1998-05-20 10:25:30 -04:00
\func { } { \destruct { wxDirDialog} } { \void }
Destructor.
\membersection { wxDirDialog::GetPath} \label { wxdirdialoggetpath}
\constfunc { wxString} { GetPath} { \void }
Returns the default or user-selected path.
\membersection { wxDirDialog::GetMessage} \label { wxdirdialoggetmessage}
\constfunc { wxString} { GetMessage} { \void }
Returns the message that will be displayed on the dialog.
\membersection { wxDirDialog::SetMessage} \label { wxdirdialogsetmessage}
\func { void} { SetMessage} { \param { const wxString\& } { message} }
Sets the message that will be displayed on the dialog.
\membersection { wxDirDialog::SetPath} \label { wxdirdialogsetpath}
\func { void} { SetPath} { \param { const wxString\& } { path} }
Sets the default path.
\membersection { wxDirDialog::ShowModal} \label { wxdirdialogshowmodal}
\func { int} { ShowModal} { \void }
2004-10-04 12:11:04 -04:00
Shows the dialog, returning wxID\_ OK if the user pressed OK, and wxID\_ CANCEL
1998-05-20 10:25:30 -04:00
otherwise.