wxdirpickerctrl

this control allows the user to select a directory. the generic implementation is a button which brings up a wxdirdialog when clicked. native implementation may differ but this is usually a (small) widget which give access to the dir-chooser dialog. it is only available if wxuse_dirpickerctrl is set to 1 (the default).

derived from

wxpickerbase
wxcontrol
wxwindow
wxevthandler
wxobject

include files

window styles

wxdirp_default_style	the default style: includes wxdirp_dir_must_exist and, under wxmsw only, wxdirp_use_textctrl.
wxdirp_use_textctrl	creates a text control to the left of the picker button which is completely managed by the wxdirpickerctrl 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.
wxdirp_dir_must_exist	creates a picker which allows to select only existing directories. wxgtk control always adds this flag internally as it does not support its absence.
wxdirp_change_dir	change current working directory on each user directory selection change.

event handling

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

evt_dirpicker_changed(id, func)

the user changed the directory selected in the control either using the button or using text control (see wxdirp_use_textctrl; note that in this case the event is fired only if the user's input is valid, e.g. an existing directory path).

see also

wxdirdialog,
wxfiledirpickerevent

members

wxdirpickerctrl::wxdirpickerctrl
wxdirpickerctrl::create
wxdirpickerctrl::getpath
wxdirpickerctrl::setpath

wxdirpickerctrl::wxdirpickerctrl

wxdirpickerctrl(wxwindow *parent, wxwindowid id, const wxstring& path = wxemptystring, const wxstring& message = "select a folder", const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdirp_default_style, const wxvalidator& validator = wxdefaultvalidator, const wxstring& name = "dirpickerctrl")

initializes the object and calls create with all the parameters.

wxdirpickerctrl::create

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

parameters

parent

null

the identifier for the control.

path

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

message

wxdirdialog

pos

initial position.

size

initial size.

style

wxdirp_*

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.

wxdirpickerctrl::getpath

wxstring getpath() const

returns the absolute path of the currently selected directory.

wxdirpickerctrl::setpath

void setpath(const wxstring &dirname)

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