don't call wxYield() from EnsureVisible(), this is too dangerous - and unnecessary...

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

diff --git a/docs/latex/wx/filedlg.tex b/docs/latex/wx/filedlg.tex
index 69bf775c0834d44cbc5dc52aa851e3e48cf3232f..f110e1271985cd971aab8a7f2f4323c4a3628959 100644 (file)
--- a/docs/latex/wx/filedlg.tex
+++ b/docs/latex/wx/filedlg.tex
@@ -9,12 +9,13 @@ This class represents the file chooser dialog.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/filedlg.h>
+

 \wxheading{See also}
 
 \helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector}
 \wxheading{See also}
 
 \helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector}

-%\rtfsp\helpref{wxFileSelectorEx}{wxfileselectorex}
-%\helpref{wxLoadFileSelector}{wxloadfileselector},\rtfsp
-%\helpref{wxSaveFileSelector}{wxsavefileselector}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -25,21 +26,16 @@ If path is ``", the current directory will be used. If filename is ``",
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,

-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0. They are only significant
-at present in Windows.
+wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.

 
 Both the X and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and
 clicking on Ok, will result in only those files matching the pattern being
 
 Both the X and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and
 clicking on Ok, will result in only those files matching the pattern being

-displayed. In the X version, supplying no default name will result in the
-wildcard filter being inserted in the filename text item; the filter is
-ignored if a default name is supplied.
-
-Under Windows (only), the wildcard may be a specification for multiple
+displayed. The wildcard may be a specification for multiple

 types of file with a description for each, such as:
 
 \begin{verbatim}
 types of file with a description for each, such as:
 
 \begin{verbatim}

- "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"

 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \end{verbatim}
 
 \latexignore{\rtfignore{\wxheading{Members}}}


@@ -62,21 +58,31 @@ Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to sho
 
 \docparam{defaultFile}{The default filename, or the empty string.}
 
 
 \docparam{defaultFile}{The default filename, or the empty string.}
 

-\docparam{wildcard}{A wildcard, such as ``*.*".}
+\docparam{wildcard}{A wildcard, such as ``*.*" or ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".}

 
 \docparam{style}{A dialog style. A bitlist of:
 
 \twocolwidtha{5cm}
 \begin{twocollist}
 
 \docparam{style}{A dialog style. A bitlist of:
 
 \twocolwidtha{5cm}
 \begin{twocollist}

-\twocolitem{{\bf wxOPEN}}{This is an open dialog (Windows only).}
-\twocolitem{{\bf wxSAVE}}{This is a save dialog (Windows only).}
-\twocolitem{{\bf wxHIDE\_READONLY}}{Hide read-only files (Windows only).}
-\twocolitem{{\bf wxOVERWRITE\_PROMPT}}{Prompt for a conformation if a file will be overridden (Windows only).}
+\twocolitem{{\bf wxOPEN}}{This is an open dialog.}
+\twocolitem{{\bf wxSAVE}}{This is a save dialog.}
+\twocolitem{{\bf wxHIDE\_READONLY}}{Hide read-only files.}
+\twocolitem{{\bf wxOVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.}
+\twocolitem{{\bf wxMULTIPLE}}{For open dialog only: allows selecting multiple files.}
+\twocolitem{{\bf wxCHANGE\_DIR}}{Change the current working directory to the
+directory where the file(s) chosen by the user are.}

 \end{twocollist}%
 }
 
 \docparam{pos}{Dialog position. Not implemented.}
 
 \end{twocollist}%
 }
 
 \docparam{pos}{Dialog position. Not implemented.}
 

+{\bf NB:} Previous versions of wxWindows used {\tt wxCHANGE\_DIR} by default
+under MS Windows which allowed the program to simply remember the last
+directory where user selected the files to open/save. This (desired)
+functionality must be implemented in the program itself now (manually remember
+the last path used and pass it to the dialog the next time it is called) or
+by using this flag.
+

 \membersection{wxFileDialog::\destruct{wxFileDialog}}
 
 \func{}{\destruct{wxFileDialog}}{\void}
 \membersection{wxFileDialog::\destruct{wxFileDialog}}
 
 \func{}{\destruct{wxFileDialog}}{\void}


@@ -95,6 +101,14 @@ Returns the default directory.
 
 Returns the default filename.
 
 
 Returns the default filename.
 

+\membersection{wxFileDialog::GetFilenames}\label{wxfiledialoggetfilenames}
+
+\constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}}
+
+Fills the array {\it filenames} with the names of the files chosen. This
+function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
+use \helpref{GetFilename}{wxfiledialoggetfilename} for the others.
+

 \membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex}
 
 \constfunc{int}{GetFilterIndex}{\void}
 \membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex}
 
 \constfunc{int}{GetFilterIndex}{\void}


@@ -115,6 +129,14 @@ Returns the message that will be displayed on the dialog.
 
 Returns the full path (directory and filename) of the selected file.
 
 
 Returns the full path (directory and filename) of the selected file.
 

+\membersection{wxFileDialog::GetPaths}\label{wxfiledialoggetpaths}
+
+\constfunc{void}{GetPaths}{\param{wxArrayString\& }{paths}}
+
+Fills the array {\it paths} with the full paths of the files chosen. This
+function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
+use \helpref{GetPath}{wxfiledialoggetpath} for the others.
+

 \membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle}
 
 \constfunc{long}{GetStyle}{\void}
 \membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle}
 
 \constfunc{long}{GetStyle}{\void}


@@ -167,13 +189,15 @@ Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogcons
 
 \func{void}{SetWildcard}{\param{const wxString\& }{wildCard}}
 
 
 \func{void}{SetWildcard}{\param{const wxString\& }{wildCard}}
 

-Sets the wildcard, which in Windows can contain multiple file types.
+Sets the wildcard, which can contain multiple file types, for example:
+
+``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"

 
 \membersection{wxFileDialog::ShowModal}\label{wxfiledialogshowmodal}
 
 \func{int}{ShowModal}{\void}
 
 
 \membersection{wxFileDialog::ShowModal}\label{wxfiledialogshowmodal}
 
 \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.