1 \section{\class{wxDirDialog
}}\label{wxdirdialog
}
3 This class represents the directory chooser dialog.
5 \wxheading{Derived from
}
7 \helpref{wxDialog
}{wxdialog
}\\
8 \helpref{wxWindow
}{wxwindow
}\\
9 \helpref{wxEvtHandler
}{wxevthandler
}\\
10 \helpref{wxObject
}{wxobject
}
12 \wxheading{Include files
}
16 \wxheading{Window styles
}
18 \begin{twocollist
}\itemsep=
0pt
19 \twocolitem{\windowstyle{wxDD
\_DEFAULT\_STYLE}}{Equivalent to a combination of wxDEFAULT
\_DIALOG\_STYLE and wxRESIZE
\_BORDER (the last one is not used under wxWinCE).
}
20 \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.
}
21 \twocolitem{\windowstyle{wxDD
\_CHANGE\_DIR}}{Change the current working directory to the directory chosen by the user.
}
24 {\bf NB:
} on Windows the new directory button is only available with recent versions of the common dialogs.
26 See also
\helpref{Generic window styles
}{windowstyles
}.
30 \helpref{wxDirDialog overview
}{wxdirdialogoverview
},
\helpref{wxFileDialog
}{wxfiledialog
}
32 \latexignore{\rtfignore{\wxheading{Members
}}}
34 \membersection{wxDirDialog::wxDirDialog
}\label{wxdirdialogctor
}
36 \func{}{wxDirDialog
}{\param{wxWindow*
}{parent
},
\param{const wxString\&
}{message = "Choose a directory"
},
\rtfsp
37 \param{const wxString\&
}{defaultPath = ""
},
\param{long
}{style = wxDD
\_DEFAULT\_STYLE},
\rtfsp
38 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
\rtfsp
39 \param{const wxSize\&
}{size = wxDefaultSize
},
\rtfsp
40 \param{const wxString\&
}{name = "wxDirCtrl"
}}
42 Constructor. Use
\helpref{wxDirDialog::ShowModal
}{wxdirdialogshowmodal
} to show
45 \wxheading{Parameters
}
47 \docparam{parent
}{Parent window.
}
49 \docparam{message
}{Message to show on the dialog.
}
51 \docparam{defaultPath
}{The default path, or the empty string.
}
53 \docparam{style
}{The dialog style. See
\helpref{wxDirDialog
}{wxdirdialog
}}
55 \docparam{pos
}{Dialog position. Ignored under Windows.
}
57 \docparam{size
}{Dialog size. Ignored under Windows.
}
59 \docparam{name
}{The dialog name, not used.
}
61 \membersection{wxDirDialog::
\destruct{wxDirDialog
}}\label{wxdirdialogdtor
}
63 \func{}{\destruct{wxDirDialog
}}{\void}
67 \membersection{wxDirDialog::GetPath
}\label{wxdirdialoggetpath
}
69 \constfunc{wxString
}{GetPath
}{\void}
71 Returns the default or user-selected path.
73 \membersection{wxDirDialog::GetMessage
}\label{wxdirdialoggetmessage
}
75 \constfunc{wxString
}{GetMessage
}{\void}
77 Returns the message that will be displayed on the dialog.
79 \membersection{wxDirDialog::SetMessage
}\label{wxdirdialogsetmessage
}
81 \func{void
}{SetMessage
}{\param{const wxString\&
}{message
}}
83 Sets the message that will be displayed on the dialog.
85 \membersection{wxDirDialog::SetPath
}\label{wxdirdialogsetpath
}
87 \func{void
}{SetPath
}{\param{const wxString\&
}{path
}}
89 Sets the default path.
91 \membersection{wxDirDialog::ShowModal
}\label{wxdirdialogshowmodal
}
93 \func{int
}{ShowModal
}{\void}
95 Shows the dialog, returning wxID
\_OK if the user pressed OK, and wxID
\_CANCEL