docs/latex/wx/filedlg.tex

   1 \section{\class{wxFileDialog}}\label{wxfiledialog}
   2
   3 This class represents the file chooser dialog.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxDialog}{wxdialog}\\
   8 \helpref{wxWindow}{wxwindow}\\
   9 \helpref{wxEvtHandler}{wxevthandler}\\
  10 \helpref{wxObject}{wxobject}
  11
  12 \wxheading{Include files}
  13
  14 <wx/filedlg.h>
  15
  16 \wxheading{See also}
  17
  18 \helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector}
  19
  20 \wxheading{Remarks}
  21
  22 Pops up a file selector box. In Windows, this is the common file selector
  23 dialog. In X, this is a file selector box with somewhat less functionality.
  24 The path and filename are distinct elements of a full file pathname.
  25 If path is ``", the current directory will be used. If filename is ``",
  26 no default filename will be supplied. The wildcard determines what files
  27 are displayed in the file selector, and file extension supplies a type
  28 extension for the required filename. Flags may be a combination of wxOPEN,
  29 wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
  30
  31 Both the X and Windows versions implement a wildcard filter. Typing a
  32 filename containing wildcards (*, ?) in the filename text item, and
  33 clicking on Ok, will result in only those files matching the pattern being
  34 displayed. The wildcard may be a specification for multiple
  35 types of file with a description for each, such as:
  36
  37 \begin{verbatim}
  38  "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
  39 \end{verbatim}
  40
  41 It must be noted that wildcard support in the native Motif file
  42 dialog is quite limited: only one alternative is supported,
  43 and it is displayed without the descriptive test; ``BMP files (*.bmp)|*.bmp''
  44 is displayed as ``*.bmp'', and both
  45 ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif'' and
  46 ``Image files|*.bmp;*.gif'' are errors.
  47
  48 \latexignore{\rtfignore{\wxheading{Members}}}
  49
  50 \membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogctor}
  51
  52 \func{}{wxFileDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a file"},\rtfsp
  53 \param{const wxString\& }{defaultDir = ""}, \param{const wxString\& }{defaultFile = ``"},\rtfsp
  54 \param{const wxString\& }{wildcard = ``*.*"}, \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
  55
  56 Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to show the dialog.
  57
  58 \wxheading{Parameters}
  59
  60 \docparam{parent}{Parent window.}
  61
  62 \docparam{message}{Message to show on the dialog.}
  63
  64 \docparam{defaultDir}{The default directory, or the empty string.}
  65
  66 \docparam{defaultFile}{The default filename, or the empty string.}
  67
  68 \docparam{wildcard}{A wildcard, such as ``*.*" or ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
  69
  70 Note that the native Motif dialog has some limitations with respect to
  71 wildcards; see the Remarks section above.}
  72
  73 \docparam{style}{A dialog style. A bitlist of:
  74
  75 \twocolwidtha{5cm}
  76 \begin{twocollist}
  77 \twocolitem{{\bf wxOPEN}}{This is an open dialog.}
  78 \twocolitem{{\bf wxSAVE}}{This is a save dialog.}
  79 \twocolitem{{\bf wxOVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.}
  80 \twocolitem{{\bf wxMULTIPLE}}{For open dialog only: allows selecting multiple files.}
  81 \twocolitem{{\bf wxCHANGE\_DIR}}{Change the current working directory to the directory where the file(s) chosen by the user are.}
  82 \end{twocollist}%
  83 }
  84
  85 \docparam{pos}{Dialog position. Not implemented.}
  86
  87 {\bf NB:} Previous versions of wxWidgets used {\tt wxCHANGE\_DIR} by default
  88 under MS Windows which allowed the program to simply remember the last
  89 directory where user selected the files to open/save. This (desired)
  90 functionality must be implemented in the program itself now (manually remember
  91 the last path used and pass it to the dialog the next time it is called) or
  92 by using this flag.
  93
  94 \membersection{wxFileDialog::\destruct{wxFileDialog}}\label{wxfiledialogdtor}
  95
  96 \func{}{\destruct{wxFileDialog}}{\void}
  97
  98 Destructor.
  99
 100 \membersection{wxFileDialog::GetDirectory}\label{wxfiledialoggetdirectory}
 101
 102 \constfunc{wxString}{GetDirectory}{\void}
 103
 104 Returns the default directory.
 105
 106 \membersection{wxFileDialog::GetFilename}\label{wxfiledialoggetfilename}
 107
 108 \constfunc{wxString}{GetFilename}{\void}
 109
 110 Returns the default filename.
 111
 112 \membersection{wxFileDialog::GetFilenames}\label{wxfiledialoggetfilenames}
 113
 114 \constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}}
 115
 116 Fills the array {\it filenames} with the names of the files chosen. This
 117 function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
 118 use \helpref{GetFilename}{wxfiledialoggetfilename} for the others.
 119
 120 Note that under Windows, if the user selects shortcuts, the filenames
 121 include paths, since the application cannot determine the full path
 122 of each referenced file by appending the directory containing the shortcuts
 123 to the filename.
 124
 125 \membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex}
 126
 127 \constfunc{int}{GetFilterIndex}{\void}
 128
 129 Returns the index into the list of filters supplied, optionally, in the wildcard parameter.
 130 Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
 131 After the dialog is shown, this is the index selected by the user.
 132
 133 \membersection{wxFileDialog::GetMessage}\label{wxfiledialoggetmessage}
 134
 135 \constfunc{wxString}{GetMessage}{\void}
 136
 137 Returns the message that will be displayed on the dialog.
 138
 139 \membersection{wxFileDialog::GetPath}\label{wxfiledialoggetpath}
 140
 141 \constfunc{wxString}{GetPath}{\void}
 142
 143 Returns the full path (directory and filename) of the selected file.
 144
 145 \membersection{wxFileDialog::GetPaths}\label{wxfiledialoggetpaths}
 146
 147 \constfunc{void}{GetPaths}{\param{wxArrayString\& }{paths}}
 148
 149 Fills the array {\it paths} with the full paths of the files chosen. This
 150 function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
 151 use \helpref{GetPath}{wxfiledialoggetpath} for the others.
 152
 153 \membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle}
 154
 155 \constfunc{long}{GetStyle}{\void}
 156
 157 Returns the dialog style.
 158
 159 \membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard}
 160
 161 \constfunc{wxString}{GetWildcard}{\void}
 162
 163 Returns the file dialog wildcard.
 164
 165 \membersection{wxFileDialog::SetDirectory}\label{wxfiledialogsetdirectory}
 166
 167 \func{void}{SetDirectory}{\param{const wxString\& }{directory}}
 168
 169 Sets the default directory.
 170
 171 \membersection{wxFileDialog::SetFilename}\label{wxfiledialogsetfilename}
 172
 173 \func{void}{SetFilename}{\param{const wxString\& }{setfilename}}
 174
 175 Sets the default filename.
 176
 177 \membersection{wxFileDialog::SetFilterIndex}\label{wxfiledialogsetfilterindex}
 178
 179 \func{void}{SetFilterIndex}{\param{int }{filterIndex}}
 180
 181 Sets the default filter index, starting from zero.
 182
 183 \membersection{wxFileDialog::SetMessage}\label{wxfiledialogsetmessage}
 184
 185 \func{void}{SetMessage}{\param{const wxString\& }{message}}
 186
 187 Sets the message that will be displayed on the dialog.
 188
 189 \membersection{wxFileDialog::SetPath}\label{wxfiledialogsetpath}
 190
 191 \func{void}{SetPath}{\param{const wxString\& }{path}}
 192
 193 Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
 194
 195 \membersection{wxFileDialog::SetStyle}\label{wxfiledialogsetstyle}
 196
 197 \func{void}{SetStyle}{\param{long }{style}}
 198
 199 Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogctor} for details.
 200
 201 \membersection{wxFileDialog::SetWildcard}\label{wxfiledialogsetwildcard}
 202
 203 \func{void}{SetWildcard}{\param{const wxString\& }{wildCard}}
 204
 205 Sets the wildcard, which can contain multiple file types, for example:
 206
 207 ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
 208
 209 Note that the native Motif dialog has some limitations with respect to
 210 wildcards; see the Remarks section above.
 211
 212 \membersection{wxFileDialog::ShowModal}\label{wxfiledialogshowmodal}
 213
 214 \func{int}{ShowModal}{\void}
 215
 216 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
 217 otherwise.
 218
 219