X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/90a6f1cca8cfc0c80f1c68bef429d2dce2ba8999..e815120e412d91e79c98dd0afac2a1e399f10810:/docs/latex/wx/dirdlg.tex?ds=sidebyside diff --git a/docs/latex/wx/dirdlg.tex b/docs/latex/wx/dirdlg.tex index 0e9d7fca8c..5059e39ec9 100644 --- a/docs/latex/wx/dirdlg.tex +++ b/docs/latex/wx/dirdlg.tex @@ -5,6 +5,7 @@ This class represents the directory chooser dialog. \wxheading{Derived from} \helpref{wxDialog}{wxdialog}\\ +\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} @@ -12,18 +13,21 @@ This class represents the directory chooser dialog. \wxheading{Include files} - + +\wxheading{Library} + +\helpref{wxCore}{librarieslist} \wxheading{Window styles} -\twocolwidtha{5cm} -\begin{twocollist} -\twocolitem{\indexit{wxDD\_NEW\_DIR\_BUTTON}}{Add "Create new -directory" button and allow directory names to be editable. On -Windows the new directory button is only available with recent -versions of the common dialogs.} +\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} @@ -32,10 +36,10 @@ See also \helpref{Generic window styles}{windowstyles}. \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},\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"}} @@ -51,7 +55,7 @@ the dialog. \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.} @@ -59,7 +63,7 @@ the dialog. \docparam{name}{The dialog name, not used.} -\membersection{wxDirDialog::\destruct{wxDirDialog}} +\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor} \func{}{\destruct{wxDirDialog}}{\void} @@ -77,12 +81,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}} @@ -95,17 +93,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.