wxGenericDirCtrl Class Reference
[Controls]
#include <wx/dirctrl.h>
Inheritance diagram for wxGenericDirCtrl:
Detailed Description
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.
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_EDIT_LABELS:Allow the folder and file labels to be editable.
Library: wxBase
Category: Controls
Public Member Functions | |
| wxGenericDirCtrl () | |
| wxGenericDirCtrl (wxWindow *parent, const wxWindowID id=-1, const wxString &dir=wxDirDialogDefaultFolderStr, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDIRCTRL_3D_INTERNAL|wxBORDER_SUNKEN, const wxString &filter=wxEmptyString, int defaultFilter=0, const wxString &name=wxTreeCtrlNameStr) | |
| virtual | ~wxGenericDirCtrl () |
| virtual bool | CollapsePath (const wxString &path) |
| virtual void | CollapseTree () |
| bool | Create (wxWindow *parent, const wxWindowID id=wxID_ANY, const wxString &dir=wxDirDialogDefaultFolderStr, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDIRCTRL_3D_INTERNAL, const wxString &filter=wxEmptyString, int defaultFilter=0, const wxString &name=wxTreeCtrlNameStr) |
| virtual bool | ExpandPath (const wxString &path) |
| virtual wxString | GetDefaultPath () const |
| virtual wxString | GetFilePath () const |
| virtual wxString | GetFilter () const |
| virtual int | GetFilterIndex () const |
| virtual wxDirFilterListCtrl * | GetFilterListCtrl () const |
| virtual wxString | GetPath () const |
| virtual wxTreeItemId | GetRootId () |
| virtual wxTreeCtrl * | GetTreeCtrl () const |
| virtual void | Init () |
| virtual void | ReCreateTree () |
| virtual void | SetDefaultPath (const wxString &path) |
| virtual void | SetFilter (const wxString &filter) |
| virtual void | SetFilterIndex (int n) |
| virtual void | SetPath (const wxString &path) |
| virtual void | ShowHidden (bool show) |
Constructor & Destructor Documentation
| wxGenericDirCtrl::wxGenericDirCtrl | ( | ) |
Default constructor.
| wxGenericDirCtrl::wxGenericDirCtrl | ( | wxWindow * | parent, | |
| const wxWindowID | id = -1, |
|||
| const wxString & | dir = wxDirDialogDefaultFolderStr, |
|||
| const wxPoint & | pos = wxDefaultPosition, |
|||
| const wxSize & | size = wxDefaultSize, |
|||
| long | style = wxDIRCTRL_3D_INTERNAL|wxBORDER_SUNKEN, |
|||
| const wxString & | filter = wxEmptyString, |
|||
| int | defaultFilter = 0, |
|||
| const wxString & | name = wxTreeCtrlNameStr | |||
| ) |
Main constructor.
- Parameters:
-
parent Parent window. id Window identifier. dir Initial folder. pos Position. size Size. style Window style. Please see wxGenericDirCtrl for a list of possible styles. filter A filter string, using the same syntax as that for wxFileDialog. This may be empty if filters are not being used. Example: "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"defaultFilter The zero-indexed default filter setting. name The window name.
| virtual wxGenericDirCtrl::~wxGenericDirCtrl | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual bool wxGenericDirCtrl::CollapsePath | ( | const wxString & | path | ) | [virtual] |
Collapse the given path.
| virtual void wxGenericDirCtrl::CollapseTree | ( | ) | [virtual] |
Collapses the entire tree.
| bool wxGenericDirCtrl::Create | ( | wxWindow * | parent, | |
| const wxWindowID | id = wxID_ANY, |
|||
| const wxString & | dir = wxDirDialogDefaultFolderStr, |
|||
| const wxPoint & | pos = wxDefaultPosition, |
|||
| const wxSize & | size = wxDefaultSize, |
|||
| long | style = wxDIRCTRL_3D_INTERNAL, |
|||
| const wxString & | filter = wxEmptyString, |
|||
| int | defaultFilter = 0, |
|||
| const wxString & | name = wxTreeCtrlNameStr | |||
| ) |
Create function for two-step construction. See wxGenericDirCtrl() for details.
| virtual bool wxGenericDirCtrl::ExpandPath | ( | const wxString & | path | ) | [virtual] |
Tries to expand as much of the given path as possible, so that the filename or directory is visible in the tree control.
| virtual wxString wxGenericDirCtrl::GetDefaultPath | ( | ) | const [virtual] |
Gets the default path.
| virtual wxString wxGenericDirCtrl::GetFilePath | ( | ) | const [virtual] |
Gets selected filename path only (else empty string).
This function doesn't count a directory as a selection.
| virtual wxString wxGenericDirCtrl::GetFilter | ( | ) | const [virtual] |
Returns the filter string.
| virtual int wxGenericDirCtrl::GetFilterIndex | ( | ) | const [virtual] |
Returns the current filter index (zero-based).
| virtual wxDirFilterListCtrl* wxGenericDirCtrl::GetFilterListCtrl | ( | ) | const [virtual] |
Returns a pointer to the filter list control (if present).
| virtual wxString wxGenericDirCtrl::GetPath | ( | ) | const [virtual] |
Gets the currently-selected directory or filename.
| virtual wxTreeItemId wxGenericDirCtrl::GetRootId | ( | ) | [virtual] |
Returns the root id for the tree control.
| virtual wxTreeCtrl* wxGenericDirCtrl::GetTreeCtrl | ( | ) | const [virtual] |
Returns a pointer to the tree control.
| virtual void wxGenericDirCtrl::Init | ( | ) | [virtual] |
Initializes variables.
| virtual void wxGenericDirCtrl::ReCreateTree | ( | ) | [virtual] |
Collapse and expand the tree, thus re-creating it from scratch. May be used to update the displayed directory content.
| virtual void wxGenericDirCtrl::SetDefaultPath | ( | const wxString & | path | ) | [virtual] |
Sets the default path.
| virtual void wxGenericDirCtrl::SetFilter | ( | const wxString & | filter | ) | [virtual] |
Sets the filter string.
| virtual void wxGenericDirCtrl::SetFilterIndex | ( | int | n | ) | [virtual] |
Sets the current filter index (zero-based).
| virtual void wxGenericDirCtrl::SetPath | ( | const wxString & | path | ) | [virtual] |
Sets the current path.
| virtual void wxGenericDirCtrl::ShowHidden | ( | bool | show | ) | [virtual] |
- Parameters:
-
show If true, hidden folders and files will be displayed by the control. If false, they will not be displayed.
