X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..e00a5d3ca15eec8db3e231d79d82ff6965e3466b:/docs/latex/wx/filedlg.tex diff --git a/docs/latex/wx/filedlg.tex b/docs/latex/wx/filedlg.tex index 69bf775c08..29e10053dc 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,23 +26,25 @@ 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} +It must be noted that wildcard support in the native Motif file +dialog is quite limited: only one alternative is supported, +and it is displayed without the descriptive test; ``BMP files (*.bmp)|*.bmp'' +is displayed as ``*.bmp'', and both +``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif'' and +``Image files|*.bmp;*.gif'' are errors. + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogconstr} @@ -62,21 +65,33 @@ Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to sho \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". + +Note that the native Motif dialog has some limitations with respect to +wildcards; see the Remarks section above.} \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}}{For open dialog only: hide the checkbox allowing to open the file in read-only mode.} +\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.} +{\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} @@ -95,6 +110,19 @@ 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. + +Note that under Windows, if the user selects shortcuts, the filenames +include paths, since the application cannot determine the full path +of each referenced file by appending the directory containing the shortcuts +to the filename. + \membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex} \constfunc{int}{GetFilterIndex}{\void} @@ -115,6 +143,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} @@ -143,7 +179,7 @@ Sets the default filename. \func{void}{SetFilterIndex}{\param{int }{filterIndex}} -Sets the default filter index, starting from zero. Windows only. +Sets the default filter index, starting from zero. \membersection{wxFileDialog::SetMessage}\label{wxfiledialogsetmessage} @@ -167,13 +203,18 @@ Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogcons \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" + +Note that the native Motif dialog has some limitations with respect to +wildcards; see the Remarks section above. \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.