X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..6e7b6cc6f79fdcacfda3cc4e498a6d6f77b75c4d:/docs/latex/wx/filedlg.tex diff --git a/docs/latex/wx/filedlg.tex b/docs/latex/wx/filedlg.tex index 69bf775c08..0932cb3306 100644 --- 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} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector} -%\rtfsp\helpref{wxFileSelectorEx}{wxfileselectorex} -%\helpref{wxLoadFileSelector}{wxloadfileselector},\rtfsp -%\helpref{wxSaveFileSelector}{wxsavefileselector} \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, -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 -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} - "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif" + "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" \end{verbatim} \latexignore{\rtfignore{\wxheading{Members}}} @@ -68,10 +64,11 @@ Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to sho \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}}{Prompt for a conformation if a file will be overridden.} +\twocolitem{{\bf wxMULTIPLE}}{For open dialog only: allows selecting multiple files} \end{twocollist}% } @@ -95,6 +92,14 @@ Returns the default directory. 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} @@ -115,6 +120,14 @@ Returns the message that will be displayed on the dialog. 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}