X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/302a1ecae3fceff78222f85eb0b9052e845083d2..f973828cd9b31d3b80386fab5e6f7c4a106d97fc:/docs/latex/wx/filedlg.tex?ds=sidebyside diff --git a/docs/latex/wx/filedlg.tex b/docs/latex/wx/filedlg.tex index 8ec3aa2b91..29e10053dc 100644 --- a/docs/latex/wx/filedlg.tex +++ b/docs/latex/wx/filedlg.tex @@ -38,6 +38,13 @@ types of file with a description for each, such as: "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} @@ -58,7 +65,10 @@ 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: @@ -66,11 +76,10 @@ Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to sho \begin{twocollist} \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 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.} +\twocolitem{{\bf wxCHANGE\_DIR}}{Change the current working directory to the directory where the file(s) chosen by the user are.} \end{twocollist}% } @@ -109,6 +118,11 @@ 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} @@ -165,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} @@ -189,7 +203,12 @@ 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}