wxFileDialogThis class represents the file chooser dialog. Derived from
wxDialog Include files <wx/filedlg.h> Window styles
NB: Previous versions of wxWidgets used 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. 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. 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::wxFileDialogwxFileDialog(wxWindow* parent, const wxString& message = "Choose a file", const wxString& defaultDir = "", const wxString& defaultFile = "", const wxString& wildcard = "*.*", long style = wxFD_DEFAULT_STYLE, const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, const wxString& name = "filedlg") 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
pos
size
name
wxFileDialog::~wxFileDialog~wxFileDialog() Destructor.
wxFileDialog::GetDirectorywxString GetDirectory() const Returns the default directory.
wxFileDialog::GetFilenamewxString GetFilename() const Returns the default filename.
wxFileDialog::GetFilenamesvoid 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 wxFD_MULTIPLE 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.
wxFileDialog::GetFilterIndexint 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.
wxFileDialog::GetMessagewxString GetMessage() const Returns the message that will be displayed on the dialog.
wxFileDialog::GetPathwxString GetPath() const Returns the full path (directory and filename) of the selected file.
wxFileDialog::GetPathsvoid 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 wxFD_MULTIPLE style, use GetPath for the others.
wxFileDialog::GetWildcardwxString GetWildcard() const Returns the file dialog wildcard.
wxFileDialog::SetDirectoryvoid SetDirectory(const wxString& directory) Sets the default directory.
wxFileDialog::SetFilenamevoid SetFilename(const wxString& setfilename) Sets the default filename.
wxFileDialog::SetFilterIndexvoid SetFilterIndex(int filterIndex) Sets the default filter index, starting from zero.
wxFileDialog::SetMessagevoid SetMessage(const wxString& message) Sets the message that will be displayed on the dialog.
wxFileDialog::SetPathvoid SetPath(const wxString& path) Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
wxFileDialog::SetWildcardvoid 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.
wxFileDialog::ShowModalint ShowModal() Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL otherwise.
|