| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: dirctrlg.h |
| 3 | // Purpose: wxGenericDirCtrl class |
| 4 | // Builds on wxDirCtrl class written by Robert Roebling for the |
| 5 | // wxFile application, modified by Harm van der Heijden. |
| 6 | // Further modified for Windows. |
| 7 | // Author: Robert Roebling, Harm van der Heijden, Julian Smart et al |
| 8 | // Modified by: |
| 9 | // Created: 21/3/2000 |
| 10 | // RCS-ID: $Id$ |
| 11 | // Copyright: (c) Robert Roebling, Harm van der Heijden, Julian Smart |
| 12 | // Licence: wxWindows licence |
| 13 | ///////////////////////////////////////////////////////////////////////////// |
| 14 | |
| 15 | #ifndef _WX_DIRCTRL_H_ |
| 16 | #define _WX_DIRCTRL_H_ |
| 17 | |
| 18 | #if wxUSE_DIRDLG || wxUSE_FILEDLG |
| 19 | #include "wx/imaglist.h" |
| 20 | #endif |
| 21 | |
| 22 | #if wxUSE_DIRDLG |
| 23 | |
| 24 | #include "wx/treectrl.h" |
| 25 | #include "wx/dialog.h" |
| 26 | #include "wx/dirdlg.h" |
| 27 | #include "wx/choice.h" |
| 28 | |
| 29 | //----------------------------------------------------------------------------- |
| 30 | // classes |
| 31 | //----------------------------------------------------------------------------- |
| 32 | |
| 33 | class WXDLLIMPEXP_CORE wxTextCtrl; |
| 34 | class WXDLLIMPEXP_CORE wxImageList; |
| 35 | class WXDLLIMPEXP_BASE wxHashTable; |
| 36 | |
| 37 | //----------------------------------------------------------------------------- |
| 38 | // Extra styles for wxGenericDirCtrl |
| 39 | //----------------------------------------------------------------------------- |
| 40 | |
| 41 | enum |
| 42 | { |
| 43 | // Only allow directory viewing/selection, no files |
| 44 | wxDIRCTRL_DIR_ONLY = 0x0010, |
| 45 | // When setting the default path, select the first file in the directory |
| 46 | wxDIRCTRL_SELECT_FIRST = 0x0020, |
| 47 | // Show the filter list |
| 48 | wxDIRCTRL_SHOW_FILTERS = 0x0040, |
| 49 | // Use 3D borders on internal controls |
| 50 | wxDIRCTRL_3D_INTERNAL = 0x0080, |
| 51 | // Editable labels |
| 52 | wxDIRCTRL_EDIT_LABELS = 0x0100 |
| 53 | }; |
| 54 | |
| 55 | //----------------------------------------------------------------------------- |
| 56 | // wxDirItemData |
| 57 | //----------------------------------------------------------------------------- |
| 58 | |
| 59 | class WXDLLEXPORT wxDirItemData : public wxTreeItemData |
| 60 | { |
| 61 | public: |
| 62 | wxDirItemData(const wxString& path, const wxString& name, bool isDir); |
| 63 | ~wxDirItemData(){} |
| 64 | void SetNewDirName(const wxString& path); |
| 65 | |
| 66 | bool HasSubDirs() const; |
| 67 | bool HasFiles(const wxString& spec = wxEmptyString) const; |
| 68 | |
| 69 | wxString m_path, m_name; |
| 70 | bool m_isHidden; |
| 71 | bool m_isExpanded; |
| 72 | bool m_isDir; |
| 73 | }; |
| 74 | |
| 75 | //----------------------------------------------------------------------------- |
| 76 | // wxDirCtrl |
| 77 | //----------------------------------------------------------------------------- |
| 78 | |
| 79 | class WXDLLEXPORT wxDirFilterListCtrl; |
| 80 | |
| 81 | class WXDLLEXPORT wxGenericDirCtrl: public wxControl |
| 82 | { |
| 83 | public: |
| 84 | wxGenericDirCtrl(); |
| 85 | wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = wxID_ANY, |
| 86 | const wxString &dir = wxDirDialogDefaultFolderStr, |
| 87 | const wxPoint& pos = wxDefaultPosition, |
| 88 | const wxSize& size = wxDefaultSize, |
| 89 | long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, |
| 90 | const wxString& filter = wxEmptyString, |
| 91 | int defaultFilter = 0, |
| 92 | const wxString& name = wxTreeCtrlNameStr ) |
| 93 | { |
| 94 | Init(); |
| 95 | Create(parent, id, dir, pos, size, style, filter, defaultFilter, name); |
| 96 | } |
| 97 | |
| 98 | bool Create(wxWindow *parent, const wxWindowID id = wxID_ANY, |
| 99 | const wxString &dir = wxDirDialogDefaultFolderStr, |
| 100 | const wxPoint& pos = wxDefaultPosition, |
| 101 | const wxSize& size = wxDefaultSize, |
| 102 | long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER, |
| 103 | const wxString& filter = wxEmptyString, |
| 104 | int defaultFilter = 0, |
| 105 | const wxString& name = wxTreeCtrlNameStr ); |
| 106 | |
| 107 | virtual void Init(); |
| 108 | |
| 109 | virtual ~wxGenericDirCtrl(); |
| 110 | |
| 111 | void OnExpandItem(wxTreeEvent &event ); |
| 112 | void OnCollapseItem(wxTreeEvent &event ); |
| 113 | void OnBeginEditItem(wxTreeEvent &event ); |
| 114 | void OnEndEditItem(wxTreeEvent &event ); |
| 115 | void OnSize(wxSizeEvent &event ); |
| 116 | |
| 117 | // Try to expand as much of the given path as possible. |
| 118 | virtual bool ExpandPath(const wxString& path); |
| 119 | |
| 120 | // Accessors |
| 121 | |
| 122 | virtual inline wxString GetDefaultPath() const { return m_defaultPath; } |
| 123 | virtual void SetDefaultPath(const wxString& path) { m_defaultPath = path; } |
| 124 | |
| 125 | // Get dir or filename |
| 126 | virtual wxString GetPath() const; |
| 127 | |
| 128 | // Get selected filename path only (else empty string). |
| 129 | // I.e. don't count a directory as a selection |
| 130 | virtual wxString GetFilePath() const; |
| 131 | virtual void SetPath(const wxString& path); |
| 132 | |
| 133 | virtual void ShowHidden( bool show ); |
| 134 | virtual bool GetShowHidden() { return m_showHidden; } |
| 135 | |
| 136 | virtual wxString GetFilter() const { return m_filter; } |
| 137 | virtual void SetFilter(const wxString& filter); |
| 138 | |
| 139 | virtual int GetFilterIndex() const { return m_currentFilter; } |
| 140 | virtual void SetFilterIndex(int n); |
| 141 | |
| 142 | virtual wxTreeItemId GetRootId() { return m_rootId; } |
| 143 | |
| 144 | virtual wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; } |
| 145 | virtual wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; } |
| 146 | |
| 147 | // Helper |
| 148 | virtual void SetupSections(); |
| 149 | |
| 150 | #if WXWIN_COMPATIBILITY_2_4 |
| 151 | // Parse the filter into an array of filters and an array of descriptions |
| 152 | virtual int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions); |
| 153 | #endif // WXWIN_COMPATIBILITY_2_4 |
| 154 | |
| 155 | // Find the child that matches the first part of 'path'. |
| 156 | // E.g. if a child path is "/usr" and 'path' is "/usr/include" |
| 157 | // then the child for /usr is returned. |
| 158 | // If the path string has been used (we're at the leaf), done is set to true |
| 159 | virtual wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done); |
| 160 | |
| 161 | // Resize the components of the control |
| 162 | virtual void DoResize(); |
| 163 | |
| 164 | // Collapse & expand the tree, thus re-creating it from scratch: |
| 165 | virtual void ReCreateTree(); |
| 166 | |
| 167 | // Collapse the entire tree |
| 168 | virtual void CollapseTree(); |
| 169 | |
| 170 | protected: |
| 171 | virtual void ExpandRoot(); |
| 172 | virtual void ExpandDir(wxTreeItemId parentId); |
| 173 | virtual void CollapseDir(wxTreeItemId parentId); |
| 174 | virtual const wxTreeItemId AddSection(const wxString& path, const wxString& name, int imageId = 0); |
| 175 | virtual wxTreeItemId AppendItem (const wxTreeItemId & parent, |
| 176 | const wxString & text, |
| 177 | int image = -1, int selectedImage = -1, |
| 178 | wxTreeItemData * data = NULL); |
| 179 | //void FindChildFiles(wxTreeItemId id, int dirFlags, wxArrayString& filenames); |
| 180 | virtual wxTreeCtrl* CreateTreeCtrl(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long treeStyle); |
| 181 | |
| 182 | // Extract description and actual filter from overall filter string |
| 183 | bool ExtractWildcard(const wxString& filterStr, int n, wxString& filter, wxString& description); |
| 184 | |
| 185 | private: |
| 186 | bool m_showHidden; |
| 187 | wxTreeItemId m_rootId; |
| 188 | wxString m_defaultPath; // Starting path |
| 189 | long m_styleEx; // Extended style |
| 190 | wxString m_filter; // Wildcards in same format as per wxFileDialog |
| 191 | int m_currentFilter; // The current filter index |
| 192 | wxString m_currentFilterStr; // Current filter string |
| 193 | wxTreeCtrl* m_treeCtrl; |
| 194 | wxDirFilterListCtrl* m_filterListCtrl; |
| 195 | |
| 196 | private: |
| 197 | DECLARE_EVENT_TABLE() |
| 198 | DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl) |
| 199 | DECLARE_NO_COPY_CLASS(wxGenericDirCtrl) |
| 200 | }; |
| 201 | |
| 202 | //----------------------------------------------------------------------------- |
| 203 | // wxDirFilterListCtrl |
| 204 | //----------------------------------------------------------------------------- |
| 205 | |
| 206 | class WXDLLEXPORT wxDirFilterListCtrl: public wxChoice |
| 207 | { |
| 208 | public: |
| 209 | wxDirFilterListCtrl() { Init(); } |
| 210 | wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY, |
| 211 | const wxPoint& pos = wxDefaultPosition, |
| 212 | const wxSize& size = wxDefaultSize, |
| 213 | long style = 0) |
| 214 | { |
| 215 | Init(); |
| 216 | Create(parent, id, pos, size, style); |
| 217 | } |
| 218 | |
| 219 | bool Create(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY, |
| 220 | const wxPoint& pos = wxDefaultPosition, |
| 221 | const wxSize& size = wxDefaultSize, |
| 222 | long style = 0); |
| 223 | |
| 224 | void Init(); |
| 225 | |
| 226 | ~wxDirFilterListCtrl() {} |
| 227 | |
| 228 | //// Operations |
| 229 | void FillFilterList(const wxString& filter, int defaultFilter); |
| 230 | |
| 231 | //// Events |
| 232 | void OnSelFilter(wxCommandEvent& event); |
| 233 | |
| 234 | protected: |
| 235 | wxGenericDirCtrl* m_dirCtrl; |
| 236 | |
| 237 | DECLARE_EVENT_TABLE() |
| 238 | DECLARE_CLASS(wxDirFilterListCtrl) |
| 239 | DECLARE_NO_COPY_CLASS(wxDirFilterListCtrl) |
| 240 | }; |
| 241 | |
| 242 | #if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXPM__) |
| 243 | #define wxDirCtrl wxGenericDirCtrl |
| 244 | #endif |
| 245 | |
| 246 | // Symbols for accessing individual controls |
| 247 | #define wxID_TREECTRL 7000 |
| 248 | #define wxID_FILTERLISTCTRL 7001 |
| 249 | |
| 250 | #endif // wxUSE_DIRDLG |
| 251 | |
| 252 | //------------------------------------------------------------------------- |
| 253 | // wxFileIconsTable - use wxTheFileIconsTable which is created as necessary |
| 254 | //------------------------------------------------------------------------- |
| 255 | |
| 256 | #if wxUSE_DIRDLG || wxUSE_FILEDLG |
| 257 | |
| 258 | class WXDLLEXPORT wxFileIconsTable |
| 259 | { |
| 260 | public: |
| 261 | wxFileIconsTable(); |
| 262 | ~wxFileIconsTable(); |
| 263 | |
| 264 | enum iconId_Type |
| 265 | { |
| 266 | folder, |
| 267 | folder_open, |
| 268 | computer, |
| 269 | drive, |
| 270 | cdrom, |
| 271 | floppy, |
| 272 | removeable, |
| 273 | file, |
| 274 | executable |
| 275 | }; |
| 276 | |
| 277 | int GetIconID(const wxString& extension, const wxString& mime = wxEmptyString); |
| 278 | wxImageList *GetSmallImageList(); |
| 279 | |
| 280 | protected: |
| 281 | void Create(); // create on first use |
| 282 | |
| 283 | wxImageList *m_smallImageList; |
| 284 | wxHashTable *m_HashTable; |
| 285 | }; |
| 286 | |
| 287 | // The global fileicons table |
| 288 | extern WXDLLEXPORT_DATA(wxFileIconsTable *) wxTheFileIconsTable; |
| 289 | |
| 290 | #endif // wxUSE_DIRDLG || wxUSE_FILEDLG |
| 291 | |
| 292 | #endif |
| 293 | // _WX_DIRCTRLG_H_ |