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