wxfilepickerctrl

this control allows the user to select a file. the generic implementation is a button which brings up a wxfiledialog 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 wxuse_filepickerctrl is set to 1 (the default).

derived from

wxpickerbase
wxcontrol
wxwindow
wxevthandler
wxobject

include files

window styles

nb: the wxfd_multiple style of wxfiledialog is not supported!

wxflp_default_style	the default style: includes wxflp_open \| wxflp_file_must_exist and, under wxmsw only, wxflp_use_textctrl.
wxflp_use_textctrl	creates a text control to the left of the picker button which is completely managed by the wxfilepickerctrl 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 wxpickerbase to modify the text control.
wxflp_open	creates a picker which allows the user to select a file to open.
wxflp_save	creates a picker which allows the user to select a file to save.
wxflp_overwrite_prompt	can be combined with wxflp_save only: ask confirmation to the user before selecting a file.
wxflp_file_must_exist	can be combined with wxflp_open only: the selected file must be an existing file.
wxflp_change_dir	change current working directory on each user file selection change.

event handling

to process a file picker event, use these event handler macros to direct input to member functions that take a wxfiledirpickerevent argument.

evt_filepicker_changed(id, func)

the user changed the file selected in the control either using the button or using text control (see wxflp_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 wxflp_file_must_exist was given).

see also

wxfiledialog,
wxfiledirpickerevent

members

wxfilepickerctrl::wxfilepickerctrl
wxfilepickerctrl::create
wxfilepickerctrl::getpath
wxfilepickerctrl::setpath

wxfilepickerctrl::wxfilepickerctrl

wxfilepickerctrl(wxwindow *parent, wxwindowid id, const wxstring& path = wxemptystring, const wxstring& message = "select a file", const wxstring& wildcard = "*.*", const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxflp_default_style, const wxvalidator& validator = wxdefaultvalidator, const wxstring& name = "filepickerctrl")

initializes the object and calls create with all the parameters.

wxfilepickerctrl::create

bool create(wxwindow *parent, wxwindowid id, const wxstring& path = wxemptystring, const wxstring& message = "select a file", const wxstring& wildcard = "*.*", const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxflp_default_style, const wxvalidator& validator = wxdefaultvalidator, const wxstring& name = "filepickerctrl")

parameters

parent

null

the identifier for the control.

path

the initial file shown in the control. must be a valid path to a file or the empty string.

message

wxfiledialog

wildcard

wxfiledialog

pos

initial position.

size

initial size.

style

wxflp_*

validator

validator which can be used for additional date checks.

name

control name.

return value

true if the control was successfully created or false if creation failed.

wxfilepickerctrl::getpath

wxstring getpath() const

returns the absolute path of the currently selected file.

wxfilepickerctrl::setpath

void setpath(const wxstring &filename)

sets the absolute path of the currently selected file. this must be a valid file if the wxflp_file_must_exist style was given.