wxgenericdirctrl

this control can be used to place a directory listing (with optional files) on an arbitrary window.

the control contains a wxtreectrl window representing the directory hierarchy, and optionally, a wxchoice window containing a list of filters.

derived from

wxcontrol
wxwindow
wxevthandler
wxobject

include files

window styles

wxdirctrl_dir_only	only show directories, and not files.
wxdirctrl_3d_internal	use 3d borders for internal controls.
wxdirctrl_select_first	when setting the default path, select the first file in the directory.
wxdirctrl_show_filters	show the drop-down filter list.
wxdirctrl_edit_labels	allow the folder and file labels to be editable.

wxgenericdirctrl::wxgenericdirctrl

wxgenericdirctrl()

default constructor.

wxgenericdirctrl(wxwindow* parent, const wxwindowid id = -1, const wxstring& dir = wxdirdialogdefaultfolderstr, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdirctrl_3d_internal|wxsunken_border, const wxstring& filter = wxemptystring, int defaultfilter = 0, const wxstring& name = wxtreectrlnamestr)

main constructor.

parameters

parent

parent window.

window identifier.

dir

initial folder.

pos

position.

size

size.

style

wxgenericdirctrl

filter

wxfiledialog

example: "all files (*.*)|*.*|jpeg files (*.jpg)|*.jpg"

defaultfilter

the zero-indexed default filter setting.

name

the window name.

wxgenericdirctrl::~wxgenericdirctrl

~wxgenericdirctrl()

destructor.

wxgenericdirctrl::create

bool create(wxwindow* parent, const wxwindowid id = -1, const wxstring& dir = wxdirdialogdefaultfolderstr, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdirctrl_3d_internal|wxsunken_border, const wxstring& filter = wxemptystring, int defaultfilter = 0, const wxstring& name = wxtreectrlnamestr)

create function for two-step construction. see wxgenericdirctrl::wxgenericdirctrl for details.

wxgenericdirctrl::init

void init()

initializes variables.

wxgenericdirctrl::collapsetree

void collapsetree()

collapses the entire tree.

wxgenericdirctrl::expandpath

bool expandpath(const wxstring& path)

tries to expand as much of the given path as possible, so that the filename or directory is visible in the tree control.

wxgenericdirctrl::collapsepath

bool collapsepath(const wxstring& path)

collapse the given path.

wxgenericdirctrl::getdefaultpath

wxstring getdefaultpath() const

gets the default path.

wxgenericdirctrl::getpath

wxstring getpath() const

gets the currently-selected directory or filename.

wxgenericdirctrl::getfilepath

wxstring getfilepath() const

gets selected filename path only (else empty string).

this function doesn't count a directory as a selection.

wxgenericdirctrl::getfilter

wxstring getfilter() const

returns the filter string.

wxgenericdirctrl::getfilterindex

int getfilterindex() const

returns the current filter index (zero-based).

wxgenericdirctrl::getfilterlistctrl

wxdirfilterlistctrl* getfilterlistctrl() const

returns a pointer to the filter list control (if present).

wxgenericdirctrl::getrootid

wxtreeitemid getrootid()

returns the root id for the tree control.

wxgenericdirctrl::gettreectrl

wxtreectrl* gettreectrl() const

returns a pointer to the tree control.

wxgenericdirctrl::recreatetree

void recreatetree()

collapse and expand the tree, thus re-creating it from scratch. may be used to update the displayed directory content.

wxgenericdirctrl::setdefaultpath

void setdefaultpath(const wxstring& path)

sets the default path.

wxgenericdirctrl::setfilter

void setfilter(const wxstring& filter)

sets the filter string.

wxgenericdirctrl::setfilterindex

void setfilterindex(int n)

sets the current filter index (zero-based).

wxgenericdirctrl::setpath

void setpath(const wxstring& path)

sets the current path.

wxgenericdirctrl::showhidden

void showhidden(bool show)

parameters

show

if true, hidden folders and files will be displayed by the control. if false, they will not be displayed.