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, wxHIDE\_READONLY, 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 \latexignore{\rtfignore{\wxheading{Members}}}
  42
  43 \membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogconstr}
  44
  45 \func{}{wxFileDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a file"},\rtfsp
  46 \param{const wxString\& }{defaultDir = ""}, \param{const wxString\& }{defaultFile = ``"},\rtfsp
  47 \param{const wxString\& }{wildcard = ``*.*"}, \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
  48
  49 Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to show the dialog.
  50
  51 \wxheading{Parameters}
  52
  53 \docparam{parent}{Parent window.}
  54
  55 \docparam{message}{Message to show on the dialog.}
  56
  57 \docparam{defaultDir}{The default directory, or the empty string.}
  58
  59 \docparam{defaultFile}{The default filename, or the empty string.}
  60
  61 \docparam{wildcard}{A wildcard, such as ``*.*" or ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".}
  62
  63 \docparam{style}{A dialog style. A bitlist of:
  64
  65 \twocolwidtha{5cm}
  66 \begin{twocollist}
  67 \twocolitem{{\bf wxOPEN}}{This is an open dialog.}
  68 \twocolitem{{\bf wxSAVE}}{This is a save dialog.}
  69 \twocolitem{{\bf wxHIDE\_READONLY}}{For open dialog only: hide the checkbox allowing to open the file in read-only mode.}
  70 \twocolitem{{\bf wxOVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.}
  71 \twocolitem{{\bf wxMULTIPLE}}{For open dialog only: allows selecting multiple files.}
  72 \twocolitem{{\bf wxCHANGE\_DIR}}{Change the current working directory to the directory where the file(s) chosen by the user are.}
  73 \end{twocollist}%
  74 }
  75
  76 \docparam{pos}{Dialog position. Not implemented.}
  77
  78 {\bf NB:} Previous versions of wxWindows used {\tt wxCHANGE\_DIR} by default
  79 under MS Windows which allowed the program to simply remember the last
  80 directory where user selected the files to open/save. This (desired)
  81 functionality must be implemented in the program itself now (manually remember
  82 the last path used and pass it to the dialog the next time it is called) or
  83 by using this flag.
  84
  85 \membersection{wxFileDialog::\destruct{wxFileDialog}}
  86
  87 \func{}{\destruct{wxFileDialog}}{\void}
  88
  89 Destructor.
  90
  91 \membersection{wxFileDialog::GetDirectory}\label{wxfiledialoggetdirectory}
  92
  93 \constfunc{wxString}{GetDirectory}{\void}
  94
  95 Returns the default directory.
  96
  97 \membersection{wxFileDialog::GetFilename}\label{wxfiledialoggetfilename}
  98
  99 \constfunc{wxString}{GetFilename}{\void}
 100
 101 Returns the default filename.
 102
 103 \membersection{wxFileDialog::GetFilenames}\label{wxfiledialoggetfilenames}
 104
 105 \constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}}
 106
 107 Fills the array {\it filenames} with the names of the files chosen. This
 108 function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
 109 use \helpref{GetFilename}{wxfiledialoggetfilename} for the others.
 110
 111 \membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex}
 112
 113 \constfunc{int}{GetFilterIndex}{\void}
 114
 115 Returns the index into the list of filters supplied, optionally, in the wildcard parameter.
 116 Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
 117 After the dialog is shown, this is the index selected by the user.
 118
 119 \membersection{wxFileDialog::GetMessage}\label{wxfiledialoggetmessage}
 120
 121 \constfunc{wxString}{GetMessage}{\void}
 122
 123 Returns the message that will be displayed on the dialog.
 124
 125 \membersection{wxFileDialog::GetPath}\label{wxfiledialoggetpath}
 126
 127 \constfunc{wxString}{GetPath}{\void}
 128
 129 Returns the full path (directory and filename) of the selected file.
 130
 131 \membersection{wxFileDialog::GetPaths}\label{wxfiledialoggetpaths}
 132
 133 \constfunc{void}{GetPaths}{\param{wxArrayString\& }{paths}}
 134
 135 Fills the array {\it paths} with the full paths of the files chosen. This
 136 function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
 137 use \helpref{GetPath}{wxfiledialoggetpath} for the others.
 138
 139 \membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle}
 140
 141 \constfunc{long}{GetStyle}{\void}
 142
 143 Returns the dialog style.
 144
 145 \membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard}
 146
 147 \constfunc{wxString}{GetWildcard}{\void}
 148
 149 Returns the file dialog wildcard.
 150
 151 \membersection{wxFileDialog::SetDirectory}\label{wxfiledialogsetdirectory}
 152
 153 \func{void}{SetDirectory}{\param{const wxString\& }{directory}}
 154
 155 Sets the default directory.
 156
 157 \membersection{wxFileDialog::SetFilename}\label{wxfiledialogsetfilename}
 158
 159 \func{void}{SetFilename}{\param{const wxString\& }{setfilename}}
 160
 161 Sets the default filename.
 162
 163 \membersection{wxFileDialog::SetFilterIndex}\label{wxfiledialogsetfilterindex}
 164
 165 \func{void}{SetFilterIndex}{\param{int }{filterIndex}}
 166
 167 Sets the default filter index, starting from zero. Windows only.
 168
 169 \membersection{wxFileDialog::SetMessage}\label{wxfiledialogsetmessage}
 170
 171 \func{void}{SetMessage}{\param{const wxString\& }{message}}
 172
 173 Sets the message that will be displayed on the dialog.
 174
 175 \membersection{wxFileDialog::SetPath}\label{wxfiledialogsetpath}
 176
 177 \func{void}{SetPath}{\param{const wxString\& }{path}}
 178
 179 Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
 180
 181 \membersection{wxFileDialog::SetStyle}\label{wxfiledialogsetstyle}
 182
 183 \func{void}{SetStyle}{\param{long }{style}}
 184
 185 Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogconstr} for details.
 186
 187 \membersection{wxFileDialog::SetWildcard}\label{wxfiledialogsetwildcard}
 188
 189 \func{void}{SetWildcard}{\param{const wxString\& }{wildCard}}
 190
 191 Sets the wildcard, which can contain multiple file types, for example:
 192
 193 ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
 194
 195 \membersection{wxFileDialog::ShowModal}\label{wxfiledialogshowmodal}
 196
 197 \func{int}{ShowModal}{\void}
 198
 199 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
 200 otherwise.
 201
 202