X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c61f4f6dbd971245f694eb01034c86040a44db00..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/filedlg.tex diff --git a/docs/latex/wx/filedlg.tex b/docs/latex/wx/filedlg.tex index 63d4a9bd1a..f89856c61f 100644 --- a/docs/latex/wx/filedlg.tex +++ b/docs/latex/wx/filedlg.tex @@ -13,20 +13,44 @@ This class represents the file chooser dialog. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + +\wxheading{Window styles} + +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxFD\_DEFAULT\_STYLE}}{Equivalent to wxFD\_OPEN.} +\twocolitem{\windowstyle{wxFD\_OPEN}}{This is an open dialog; usually this means that the default button's label of the dialog is "Open". Cannot be combined with wxFD\_SAVE.} +\twocolitem{\windowstyle{wxFD\_SAVE}}{This is a save dialog; usually this means that the default button's label of the dialog is "Save". Cannot be combined with wxFD\_OPEN.} +\twocolitem{{\windowstyle wxFD\_OVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.} +\twocolitem{{\windowstyle wxFD\_FILE\_MUST\_EXIST}}{For open dialog only: the user may only select files that actually exist.} +\twocolitem{{\windowstyle wxFD\_MULTIPLE}}{For open dialog only: allows selecting multiple files.} +\twocolitem{{\windowstyle wxFD\_CHANGE\_DIR}}{Change the current working directory to the directory where the file(s) chosen by the user are.} +\twocolitem{{\windowstyle wxFD\_PREVIEW}}{Show the preview of the selected files (currently only supported by wxGTK using GTK+ 2.4 or later).} +\end{twocollist} + +{\bf NB:} Previous versions of wxWidgets used {\tt wxFD\_CHANGE\_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. + + \wxheading{See also} \helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector} \wxheading{Remarks} -Pops up a file selector box. In Windows, this is the common file selector -dialog. In X, this is a file selector box with somewhat less functionality. -The path and filename are distinct elements of a full file pathname. +Pops up a file selector box. In Windows and GTK2.4+, this is the common +file selector dialog. In X, this is a file selector box with somewhat less +functionality. The path and filename are distinct elements of a full file pathname. 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, wxMULTIPLE or 0. +extension for the required filename. Both the X and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and @@ -35,16 +59,23 @@ 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 and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png" \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} +\membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogctor} \func{}{wxFileDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a file"},\rtfsp \param{const wxString\& }{defaultDir = ""}, \param{const wxString\& }{defaultFile = ``"},\rtfsp -\param{const wxString\& }{wildcard = ``*.*"}, \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition}} +\param{const wxString\& }{wildcard = ``*.*"}, \param{long }{style = wxFD\_DEFAULT\_STYLE}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{sz = wxDefaultSize}, \param{const wxString\& }{name = "filedlg"}} Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to show the dialog. @@ -58,23 +89,21 @@ 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". -\docparam{style}{A dialog style. A bitlist of: +Note that the native Motif dialog has some limitations with respect to +wildcards; see the Remarks section above.} -\twocolwidtha{5cm} -\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 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}% -} +\docparam{style}{A dialog style. See wxFD\_* styles for more info.} \docparam{pos}{Dialog position. Not implemented.} -\membersection{wxFileDialog::\destruct{wxFileDialog}} +\docparam{size}{Dialog size. Not implemented.} + +\docparam{name}{Dialog name. Not implemented.} + + +\membersection{wxFileDialog::\destruct{wxFileDialog}}\label{wxfiledialogdtor} \func{}{\destruct{wxFileDialog}}{\void} @@ -97,9 +126,14 @@ Returns the default filename. \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, +function should only be used with the dialogs which have {\tt wxFD\_MULTIPLE} 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} @@ -125,15 +159,9 @@ Returns the full path (directory and filename) of the selected file. \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, +function should only be used with the dialogs which have {\tt wxFD\_MULTIPLE} style, use \helpref{GetPath}{wxfiledialoggetpath} for the others. -\membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle} - -\constfunc{long}{GetStyle}{\void} - -Returns the dialog style. - \membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard} \constfunc{wxString}{GetWildcard}{\void} @@ -156,7 +184,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} @@ -170,23 +198,22 @@ Sets the message that will be displayed on the dialog. Sets the path (the combined directory and filename that will be returned when the dialog is dismissed). -\membersection{wxFileDialog::SetStyle}\label{wxfiledialogsetstyle} - -\func{void}{SetStyle}{\param{long }{style}} - -Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogconstr} for details. - \membersection{wxFileDialog::SetWildcard}\label{wxfiledialogsetwildcard} \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.