6bd719f16c
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40238 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
99 lines
3.1 KiB
TeX
99 lines
3.1 KiB
TeX
\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}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/dirdlg.h>
|
|
|
|
\wxheading{Window styles}
|
|
|
|
\begin{twocollist}\itemsep=0pt
|
|
\twocolitem{\windowstyle{wxDD\_DEFAULT\_STYLE}}{Equivalent to a combination of wxDEFAULT\_DIALOG\_STYLE and wxRESIZE\_BORDER (the last one is not used under wxWinCE).}
|
|
\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.}
|
|
\twocolitem{\windowstyle{wxDD\_CHANGE\_DIR}}{Change the current working directory to the directory chosen by the user.}
|
|
\end{twocollist}
|
|
|
|
{\bf NB:} on Windows the new directory button is only available with recent versions of the common dialogs.
|
|
|
|
See also \helpref{Generic window styles}{windowstyles}.
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogctor}
|
|
|
|
\func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
|
|
\param{const wxString\& }{defaultPath = ""}, \param{long }{style = wxDD\_DEFAULT\_STYLE},\rtfsp
|
|
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
|
|
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
|
|
\param{const wxString\& }{name = "wxDirCtrl"}}
|
|
|
|
Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show
|
|
the dialog.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{parent}{Parent window.}
|
|
|
|
\docparam{message}{Message to show on the dialog.}
|
|
|
|
\docparam{defaultPath}{The default path, or the empty string.}
|
|
|
|
\docparam{style}{The dialog style. See \helpref{wxDirDialog}{wxdirdialog}}
|
|
|
|
\docparam{pos}{Dialog position. Ignored under Windows.}
|
|
|
|
\docparam{size}{Dialog size. Ignored under Windows.}
|
|
|
|
\docparam{name}{The dialog name, not used.}
|
|
|
|
\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor}
|
|
|
|
\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}
|
|
|
|
Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
|
|
otherwise.
|
|
|
|
|