]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dirdlg.tex
Fix formatting tag in frame.tex
[wxWidgets.git] / docs / latex / wx / dirdlg.tex
index 366294269321d9d3d01598b93156f6a819c8391e..5ac906af222f2840f577e935fa0ef9f095f98ae1 100644 (file)
@@ -18,10 +18,11 @@ This class represents the directory chooser dialog.
 
 \twocolwidtha{5cm}
 \begin{twocollist}
-\twocolitem{\indexit{wxDD\_NEW\_DIR\_BUTTON}}{Add "Create new directory" button and allow
-directory names to be editable. Available only on platforms that use the generic
-dialog chooser: GTK+, Motif, X11, MGL. For other platforms, use the wxGenericDirDialog
-implementation explicitly if you wish to use this style.}
+\twocolitem{\windowstyle{wxDD\_DEFAULT\_STYLE}}{Equivalent to a combination of wxDEFAULT\_DIALOG\_STYLE, wxDD\_NEW\_DIR\_BUTTON and wxRESIZE\_BORDER (the last one is not used under wxWinCE).}
+\twocolitem{\windowstyle{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.}
 \end{twocollist}
 
 See also \helpref{Generic window styles}{windowstyles}.
@@ -32,12 +33,16 @@ 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}, \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}
 
@@ -47,11 +52,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. Not implemented.}
+\docparam{pos}{Dialog position. Ignored under Windows.}
 
-\membersection{wxDirDialog::\destruct{wxDirDialog}}
+\docparam{size}{Dialog size. Ignored under Windows.}
+
+\docparam{name}{The dialog name, not used.}
+
+\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor}
 
 \func{}{\destruct{wxDirDialog}}{\void}
 
@@ -97,7 +106,7 @@ Sets the dialog style. This is currently unused.
 
 \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.