wx.FileDialog

Inheritance diagram for wx.FileDialog:

Description

This class represents the file chooser dialog.

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"

Note

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.

See also

wx.FileSelector

Derived From

• wx.Dialog
• wx.Window
• wx.EvtHandler
• wx.Object

Window Styles

Window Style	Description
wx.FD_DEFAULT_STYLE	Equivalent to wx.FD_OPEN.
wx.FD_OPEN	This is an open dialog; usually this means that the default button’s label of the dialog is “Open”. Cannot be combined with wx.FD_SAVE.
wx.FD_SAVE	This is a save dialog; usually this means that the default button’s label of the dialog is “Save”. Cannot be combined with wx.FD_OPEN.
wx.FD_OVERWRITE_PROMPT	For save dialog only: prompt for a confirmation if a file will be overwritten.
wx.FD_FILE_MUST_EXIST	For open dialog only: the user may only select files that actually exist.
wx.FD_MULTIPLE	For open dialog only: allows selecting multiple files.
wx.FD_CHANGE_DIR	Change the current working directory to the directory where the file(s) chosen by the user are.
wx.FD_PREVIEW	Show the preview of the selected files (currently only supported by wxGTK using GTK+ 2.4 or later).

Methods Summary

• __init__
• GetDirectory
• GetFilename
• GetFilenames
• GetFilterIndex
• GetMessage
• GetPath
• GetPaths
• GetWildcard
• SetDirectory
• SetFilename
• SetFilterIndex
• SetMessage
• SetPath
• SetWildcard
• ShowModal

Properties Summary

• Directory
• Filename
• Filenames
• FilterIndex
• Message
• Path
• Paths
• Wildcard

Class API

Methods

__init__(parent, message=wx.FileSelectorPromptStr, defaultDir="", defaultFile="", wildcard=wx.FileSelectorDefaultWildcardStr, style=wx.FD_DEFAULT_STYLE, pos=wx.DefaultPosition)

Constructor. Use ShowModal method to show the dialog.

Parameters:

• parent (wx.Window)
• message (string)
• defaultDir (string)
• defaultFile (string)
• wildcard (string)
• style (long)
• pos (wx.Point)

Returns:

wx.FileDialog

---

GetDirectory()

Returns the default directory.

Returns:

string

---

GetFilename()

Returns the default filename.

Returns:

string

---

GetFilenames()

Returns a list of filenames chosen in the dialog. This function should only be used with the dialogs which have wx.FD_MULTIPLE style, use GetFilename for the others.

Returns:

list of strings

Note

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.

---

GetFilterIndex()

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.

Returns:

int

---

GetMessage()

Returns the message that will be displayed on the dialog.

Returns:

string

---

GetPath()

Returns the full path (directory and filename) of the selected file.

Returns:

string

---

GetPaths()

Returns an array of paths with the full paths of the files chosen. This function should only be used with the dialogs which have wx.FD_MULTIPLE style, use GetPath for the others.

Returns:

list of strings

---

GetWildcard()

Returns the file dialog wildcard.

Returns:

string

---

SetDirectory(directory)

Sets the default directory.

Parameters:

• directory (string)

---

SetFilename(setfilename)

Sets the default filename.

Parameters:

• setfilename (string)

---

SetFilterIndex(filterIndex)

Sets the default filter index, starting from zero.

Parameters:

• filterIndex (int)

---

SetMessage(message)

Sets the message that will be displayed on the dialog.

Parameters:

• message (string)

---

SetPath(path)

Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).

Parameters:

• path (string)

---

SetWildcard(wildCard)

Sets the wildcard, which can contain multiple file types, for example:

"BMP files (*.bmp)|*.bmp | GIF files (*.gif)|*.gif"

Parameters:

• wildCard (string)

Note

Note that the native Motif dialog has some limitations with respect to wildcards; see the note above.

---

ShowModal()

Shows the dialog, returning one of wx.ID_OK or wx.ID_CANCEL.

Returns:

int

---

Properties

Directory

See GetDirectory and SetDirectory

Filename

See GetFilename and SetFilename

Filenames

See GetFilenames

FilterIndex

See GetFilterIndex and SetFilterIndex

Message

See GetMessage and SetMessage

Path

See GetPath and SetPath

Paths

See GetPaths

Wildcard

See GetWildcard and SetWildcard