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