X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..aaa6f9ba6bd0be1fe6a34800e6f753ffdc49900c:/docs/latex/wx/dirdlg.tex diff --git a/docs/latex/wx/dirdlg.tex b/docs/latex/wx/dirdlg.tex index 5a012a99f4..ad92224286 100644 --- a/docs/latex/wx/dirdlg.tex +++ b/docs/latex/wx/dirdlg.tex @@ -9,18 +9,38 @@ This class represents the directory chooser dialog. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + +\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{wxdirdialogconstr} +\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 = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition}} +\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. +Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show +the dialog. \wxheading{Parameters} @@ -30,11 +50,15 @@ Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show \docparam{defaultPath}{The default path, or the empty string.} -\docparam{style}{A dialog style, currently unused.} +\docparam{style}{The dialog style. See \helpref{wxDirDialog}{wxdirdialog}} + +\docparam{pos}{Dialog position. Ignored under Windows.} -\docparam{pos}{Dialog position. Not implemented.} +\docparam{size}{Dialog size. Ignored under Windows.} -\membersection{wxDirDialog::\destruct{wxDirDialog}} +\docparam{name}{The dialog name, not used.} + +\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor} \func{}{\destruct{wxDirDialog}}{\void} @@ -52,12 +76,6 @@ Returns the default or user-selected path. Returns the message that will be displayed on the dialog. -\membersection{wxDirDialog::GetStyle}\label{wxdirdialoggetstyle} - -\constfunc{long}{GetStyle}{\void} - -Returns the dialog style. - \membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage} \func{void}{SetMessage}{\param{const wxString\& }{message}} @@ -70,17 +88,11 @@ Sets the message that will be displayed on the dialog. Sets the default path. -\membersection{wxDirDialog::SetStyle}\label{wxdirdialogsetstyle} - -\func{void}{SetStyle}{\param{long }{style}} - -Sets the dialog style. This is currently unused. - \membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal} \func{int}{ShowModal}{\void} -Shows the dialog, returning wxID\_OK if the user pressed OK, and wxOK\_CANCEL +Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL otherwise.