This class represents the file chooser dialog.
Derived from
wxDialog
wxWindow
wxEvtHandler
wxObject
Include files
<wx/filedlg.h>
See also
wxFileDialog overview, wxFileSelector
Remarks
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, wxFILE_MUST_EXIST, wxMULTIPLE, wxCHANGE_DIR or 0.
Both the X and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed. The wildcard may be a specification for multiple types of file with a description for each, such as:
"BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png"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.
Members
wxFileDialog::wxFileDialog
wxFileDialog::~wxFileDialog
wxFileDialog::GetDirectory
wxFileDialog::GetFilename
wxFileDialog::GetFilenames
wxFileDialog::GetFilterIndex
wxFileDialog::GetMessage
wxFileDialog::GetPath
wxFileDialog::GetPaths
wxFileDialog::GetStyle
wxFileDialog::GetWildcard
wxFileDialog::SetDirectory
wxFileDialog::SetFilename
wxFileDialog::SetFilterIndex
wxFileDialog::SetMessage
wxFileDialog::SetPath
wxFileDialog::SetStyle
wxFileDialog::SetWildcard
wxFileDialog::ShowModal
wxFileDialog(wxWindow* parent, const wxString& message = "Choose a file", const wxString& defaultDir = "", const wxString& defaultFile = "", const wxString& wildcard = "*.*", long style = 0, const wxPoint& pos = wxDefaultPosition)
Constructor. Use wxFileDialog::ShowModal to show the dialog.
Parameters
parent
message
defaultDir
defaultFile
wildcard
Note that the native Motif dialog has some limitations with respect to wildcards; see the Remarks section above.
style
| wxOPEN | This is an open dialog. |
| wxSAVE | This is a save dialog. |
| wxOVERWRITE_PROMPT | For save dialog only: prompt for a confirmation if a file will be overwritten. |
| wxHIDE_READONLY | Do not display the checkbox to toggle display of read-only files. Deprecated in 2.6; the checkbox is never shown. |
| wxFILE_MUST_EXIST | The user may only select files that actually exist. |
| wxMULTIPLE | For open dialog only: allows selecting multiple files. |
| wxCHANGE_DIR | Change the current working directory to the directory where the file(s) chosen by the user are. |
pos
NB: Previous versions of wxWidgets used wxCHANGE_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.
~wxFileDialog()
Destructor.
wxString GetDirectory() const
Returns the default directory.
wxString GetFilename() const
Returns the default filename.
void GetFilenames(wxArrayString& filenames) const
Fills the array filenames with the names of the files chosen. This function should only be used with the dialogs which have wxMULTIPLE style, use GetFilename 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.
int GetFilterIndex() const
Returns the index into the list of filters supplied, optionally, in the wildcard parameter. Before the dialog is shown, this is the index which will be used when the dialog is first displayed. After the dialog is shown, this is the index selected by the user.
wxString GetMessage() const
Returns the message that will be displayed on the dialog.
wxString GetPath() const
Returns the full path (directory and filename) of the selected file.
void GetPaths(wxArrayString& paths) const
Fills the array paths with the full paths of the files chosen. This function should only be used with the dialogs which have wxMULTIPLE style, use GetPath for the others.
long GetStyle() const
Returns the dialog style.
wxString GetWildcard() const
Returns the file dialog wildcard.
void SetDirectory(const wxString& directory)
Sets the default directory.
void SetFilename(const wxString& setfilename)
Sets the default filename.
void SetFilterIndex(int filterIndex)
Sets the default filter index, starting from zero.
void SetMessage(const wxString& message)
Sets the message that will be displayed on the dialog.
void SetPath(const wxString& path)
Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
void SetStyle(long style)
Sets the dialog style. See wxFileDialog::wxFileDialog for details.
void SetWildcard(const wxString& wildCard)
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.
int ShowModal()
Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL otherwise.