FilePickerCtrl

This control allows the user to select a file.

The generic implementation is a button which brings up a FileDialog when clicked. Native implementation may differ but this is usually a (small) widget which give access to the file-chooser dialog. It is only available if USE_FILEPICKERCTRL is set to 1 (the default).

Window Styles

This class supports the following styles:

• FLP_DEFAULT_STYLE: The default style: includes FLP_OPEN | FLP_FILE_MUST_EXIST and, under wxMSW only, FLP_USE_TEXTCTRL.
• FLP_USE_TEXTCTRL: Creates a text control to the left of the picker button which is completely managed by the FilePickerCtrl and which can be used by the user to specify a path (see SetPath). The text control is automatically synchronized with button’s value. Use functions defined in PickerBase to modify the text control.
• FLP_OPEN: Creates a picker which allows the user to select a file to open.
• FLP_SAVE: Creates a picker which allows the user to select a file to save.
• FLP_OVERWRITE_PROMPT: Can be combined with FLP_SAVE only: ask confirmation to the user before selecting a file.
• FLP_FILE_MUST_EXIST: Can be combined with FLP_OPEN only: the selected file must be an existing file.
• FLP_CHANGE_DIR: Change current working directory on each user file selection change.
• FLP_SMALL: Use smaller version of the control with a small ”...” button instead of the normal “Browse” one. This flag is new since wxWidgets 2.9.3.

Events Emitted by this Class

Handlers bound for the following event types will receive a FileDirPickerEvent parameter.

• EVT_FILEPICKER_CHANGED: The user changed the file selected in the control either using the button or using text control (see FLP_USE_TEXTCTRL; note that in this case the event is fired only if the user’s input is valid, e.g. an existing file path if FLP_FILE_MUST_EXIST was given).

See also

FileDialog, FileDirPickerEvent

Inheritance Diagram

Inheritance diagram for class FilePickerCtrl

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

__init__
Create	Creates this widget with the given parameters.
GetPath	Returns the absolute path of the currently selected file.
SetInitialDirectory	Set the directory to show when starting to browse for files.
SetPath	Sets the absolute path of the currently selected file.

Properties Summary

Path	See GetPath and SetPath

Class API

---

class FilePickerCtrl(PickerBase)

This control allows the user to select a file.

Possible constructors:

FilePickerCtrl()

FilePickerCtrl(parent, id=ID_ANY, path='',
               message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr,
               pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE,
               validator=DefaultValidator, name=FilePickerCtrlNameStr)

Methods

---

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

---

__init__ (self, parent, id=ID_ANY, path=’‘, message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr, pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE, validator=DefaultValidator, name=FilePickerCtrlNameStr)

Initializes the object and calls Create with all the parameters.

Parameters:

• parent (Window) –
• id (int) –
• path (string) –
• message (string) –
• wildcard (string) –
• pos (Point) –
• size (Size) –
• style (long) –
• validator (Validator) –
• name (string) –

---

---

Create(self, parent, id=ID_ANY, path='', message=FileSelectorPromptStr, wildcard=FileSelectorDefaultWildcardStr, pos=DefaultPosition, size=DefaultSize, style=FLP_DEFAULT_STYLE, validator=DefaultValidator, name=FilePickerCtrlNameStr)

Creates this widget with the given parameters.

Parameters:

• parent (Window) – Parent window, must not be not None.
• id (int) – The identifier for the control.
• path (string) – The initial file shown in the control. Must be a valid path to a file or the empty string.
• message (string) – The message shown to the user in the FileDialog shown by the control.
• wildcard (string) – A wildcard which defines user-selectable files (use the same syntax as for FileDialog’s wildcards).
• pos (Point) – Initial position.
• size (Size) – Initial size.
• style (long) – The window style, see FLP_ flags.
• validator (Validator) – Validator which can be used for additional data checks.
• name (string) – Control name.

Return type:

bool

Returns:

True if the control was successfully created or False if creation failed.

---

GetPath(self)

Returns the absolute path of the currently selected file.

Return type:string

---

SetInitialDirectory(self, dir)

Set the directory to show when starting to browse for files.

This function is mostly useful for the file picker controls which have no selection initially to configure the directory that should be shown if the user starts browsing for files as otherwise the directory of initially selected file is used, which is usually the desired behaviour and so the directory specified by this function is ignored in this case.

Parameters:dir (string) –

New in version 2.9.4.

---

SetPath(self, filename)

Sets the absolute path of the currently selected file.

This must be a valid file if the FLP_FILE_MUST_EXIST style was given.

Parameters:filename (string) –

Properties

---

Path

See GetPath and SetPath