Applied Patch #1502804: wx*PickerCtrl documentation fixes

[wxWidgets.git] / docs / latex / wx / dirdlg.tex

diff --git a/docs/latex/wx/dirdlg.tex b/docs/latex/wx/dirdlg.tex
index 0ad1387fdd45b4e030fb474730b69938707ba78c..ad92224286af7eb1af76a215a665175bbcd33f37 100644 (file)
--- a/docs/latex/wx/dirdlg.tex
+++ b/docs/latex/wx/dirdlg.tex
@@ -12,18 +12,17 @@ This class represents the directory chooser dialog.
 \wxheading{Include files}
 
 <wx/dirdlg.h>
 \wxheading{Include files}
 
 <wx/dirdlg.h>

-<wx/generic/dirdlgg.h>

 
 \wxheading{Window styles}
 
 
 \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}
 
 \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}
 See also \helpref{Generic window styles}{windowstyles}.
 
 \wxheading{See also}


@@ -35,7 +34,7 @@ See also \helpref{Generic window styles}{windowstyles}.
 \membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogctor}
 
 \func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
 \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"}}
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{const wxString\& }{name = "wxDirCtrl"}}


@@ -51,7 +50,7 @@ the dialog.
 
 \docparam{defaultPath}{The default path, or the empty string.}
 
 
 \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. Ignored under Windows.}
 


@@ -77,12 +76,6 @@ Returns the default or user-selected path.
 
 Returns the message that will be displayed on the dialog.
 
 
 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}}
 \membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}
 
 \func{void}{SetMessage}{\param{const wxString\& }{message}}


@@ -95,17 +88,11 @@ Sets the message that will be displayed on the dialog.
 
 Sets the default path.
 
 
 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}
 
 \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.
 
 
 otherwise.