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