]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/dirctrlg.h
Add missing wxUSE_OLE checks to safearray.cpp.
[wxWidgets.git] / include / wx / generic / dirctrlg.h
CommitLineData
51a58d8b 1/////////////////////////////////////////////////////////////////////////////
80fdcdb9 2// Name: wx/generic/dirctrlg.h
51a58d8b
JS
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
1e6feb95
VZ
18#if wxUSE_DIRDLG
19
51a58d8b 20#include "wx/treectrl.h"
748fcded 21#include "wx/dialog.h"
3509d340
VS
22#include "wx/dirdlg.h"
23#include "wx/choice.h"
51a58d8b
JS
24
25//-----------------------------------------------------------------------------
26// classes
27//-----------------------------------------------------------------------------
28
b5dbe15d 29class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
b5dbe15d 30class WXDLLIMPEXP_FWD_BASE wxHashTable;
748fcded 31
51a58d8b
JS
32//-----------------------------------------------------------------------------
33// Extra styles for wxGenericDirCtrl
34//-----------------------------------------------------------------------------
35
748fcded
VS
36enum
37{
38 // Only allow directory viewing/selection, no files
39 wxDIRCTRL_DIR_ONLY = 0x0010,
40 // When setting the default path, select the first file in the directory
41 wxDIRCTRL_SELECT_FIRST = 0x0020,
d0bc78e2
VZ
42#if WXWIN_COMPATIBILITY_2_8
43 // Unused, for compatibility only
748fcded 44 wxDIRCTRL_SHOW_FILTERS = 0x0040,
d0bc78e2 45#endif // WXWIN_COMPATIBILITY_2_8
748fcded 46 // Use 3D borders on internal controls
fd775aae
JS
47 wxDIRCTRL_3D_INTERNAL = 0x0080,
48 // Editable labels
80f624ec
VZ
49 wxDIRCTRL_EDIT_LABELS = 0x0100,
50 // Allow multiple selection
51 wxDIRCTRL_MULTIPLE = 0x0200
748fcded 52};
51a58d8b
JS
53
54//-----------------------------------------------------------------------------
55// wxDirItemData
56//-----------------------------------------------------------------------------
57
53a2db12 58class WXDLLIMPEXP_CORE wxDirItemData : public wxTreeItemData
51a58d8b
JS
59{
60public:
748fcded 61 wxDirItemData(const wxString& path, const wxString& name, bool isDir);
d3c7fc99 62 virtual ~wxDirItemData(){}
748fcded
VS
63 void SetNewDirName(const wxString& path);
64
65 bool HasSubDirs() const;
66 bool HasFiles(const wxString& spec = wxEmptyString) const;
67
68 wxString m_path, m_name;
69 bool m_isHidden;
70 bool m_isExpanded;
71 bool m_isDir;
51a58d8b
JS
72};
73
74//-----------------------------------------------------------------------------
75// wxDirCtrl
76//-----------------------------------------------------------------------------
77
b5dbe15d 78class WXDLLIMPEXP_FWD_CORE wxDirFilterListCtrl;
51a58d8b 79
53a2db12 80class WXDLLIMPEXP_CORE wxGenericDirCtrl: public wxControl
51a58d8b
JS
81{
82public:
83 wxGenericDirCtrl();
ca65c044 84 wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = wxID_ANY,
51a58d8b
JS
85 const wxString &dir = wxDirDialogDefaultFolderStr,
86 const wxPoint& pos = wxDefaultPosition,
87 const wxSize& size = wxDefaultSize,
e5048854 88 long style = wxDIRCTRL_3D_INTERNAL,
51a58d8b
JS
89 const wxString& filter = wxEmptyString,
90 int defaultFilter = 0,
91 const wxString& name = wxTreeCtrlNameStr )
92 {
93 Init();
94 Create(parent, id, dir, pos, size, style, filter, defaultFilter, name);
95 }
ca65c044
WS
96
97 bool Create(wxWindow *parent, const wxWindowID id = wxID_ANY,
51a58d8b
JS
98 const wxString &dir = wxDirDialogDefaultFolderStr,
99 const wxPoint& pos = wxDefaultPosition,
100 const wxSize& size = wxDefaultSize,
e5048854 101 long style = wxDIRCTRL_3D_INTERNAL,
51a58d8b
JS
102 const wxString& filter = wxEmptyString,
103 int defaultFilter = 0,
104 const wxString& name = wxTreeCtrlNameStr );
105
2b5f62a0 106 virtual void Init();
51a58d8b 107
2b5f62a0 108 virtual ~wxGenericDirCtrl();
51a58d8b
JS
109
110 void OnExpandItem(wxTreeEvent &event );
111 void OnCollapseItem(wxTreeEvent &event );
112 void OnBeginEditItem(wxTreeEvent &event );
113 void OnEndEditItem(wxTreeEvent &event );
84605707 114 void OnTreeSelChange(wxTreeEvent &event);
51a58d8b
JS
115 void OnSize(wxSizeEvent &event );
116
117 // Try to expand as much of the given path as possible.
2b5f62a0 118 virtual bool ExpandPath(const wxString& path);
f395a825
VZ
119 // collapse the path
120 virtual bool CollapsePath(const wxString& path);
51a58d8b
JS
121
122 // Accessors
123
2b5f62a0
VZ
124 virtual inline wxString GetDefaultPath() const { return m_defaultPath; }
125 virtual void SetDefaultPath(const wxString& path) { m_defaultPath = path; }
51a58d8b 126
51a58d8b 127 // Get dir or filename
2b5f62a0 128 virtual wxString GetPath() const;
80f624ec 129 virtual void GetPaths(wxArrayString& paths) const;
ca65c044 130
51a58d8b
JS
131 // Get selected filename path only (else empty string).
132 // I.e. don't count a directory as a selection
2b5f62a0 133 virtual wxString GetFilePath() const;
80f624ec 134 virtual void GetFilePaths(wxArrayString& paths) const;
2b5f62a0 135 virtual void SetPath(const wxString& path);
ca65c044 136
80f624ec
VZ
137 virtual void SelectPath(const wxString& path, bool select = true);
138 virtual void SelectPaths(const wxArrayString& paths);
139
2b5f62a0
VZ
140 virtual void ShowHidden( bool show );
141 virtual bool GetShowHidden() { return m_showHidden; }
51a58d8b 142
2b5f62a0
VZ
143 virtual wxString GetFilter() const { return m_filter; }
144 virtual void SetFilter(const wxString& filter);
51a58d8b 145
2b5f62a0
VZ
146 virtual int GetFilterIndex() const { return m_currentFilter; }
147 virtual void SetFilterIndex(int n);
51a58d8b 148
2b5f62a0 149 virtual wxTreeItemId GetRootId() { return m_rootId; }
51a58d8b 150
2b5f62a0
VZ
151 virtual wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; }
152 virtual wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; }
51a58d8b 153
80f624ec
VZ
154 virtual void UnselectAll();
155
42dcacf0 156 // Helper
2b5f62a0 157 virtual void SetupSections();
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
e3f084fd
VZ
165 wxString GetPath(wxTreeItemId itemId) const;
166
51a58d8b 167 // Resize the components of the control
2b5f62a0 168 virtual void DoResize();
ca65c044 169
08887820 170 // Collapse & expand the tree, thus re-creating it from scratch:
2b5f62a0 171 virtual void ReCreateTree();
ca65c044 172
c06dde42
JS
173 // Collapse the entire tree
174 virtual void CollapseTree();
175
905e0905
VZ
176 // overridden base class methods
177 virtual void SetFocus();
178
51a58d8b 179protected:
c06dde42 180 virtual void ExpandRoot();
22328fa4
JS
181 virtual void ExpandDir(wxTreeItemId parentId);
182 virtual void CollapseDir(wxTreeItemId parentId);
183 virtual const wxTreeItemId AddSection(const wxString& path, const wxString& name, int imageId = 0);
184 virtual wxTreeItemId AppendItem (const wxTreeItemId & parent,
185 const wxString & text,
186 int image = -1, int selectedImage = -1,
187 wxTreeItemData * data = NULL);
51a58d8b 188 //void FindChildFiles(wxTreeItemId id, int dirFlags, wxArrayString& filenames);
a78955e3 189 virtual wxTreeCtrl* CreateTreeCtrl(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long treeStyle);
51a58d8b
JS
190
191 // Extract description and actual filter from overall filter string
192 bool ExtractWildcard(const wxString& filterStr, int n, wxString& filter, wxString& description);
193
194private:
ef57807f 195 void PopulateNode(wxTreeItemId node);
0d6f66f4 196 wxDirItemData* GetItemData(wxTreeItemId itemId);
ef57807f 197
51a58d8b
JS
198 bool m_showHidden;
199 wxTreeItemId m_rootId;
51a58d8b
JS
200 wxString m_defaultPath; // Starting path
201 long m_styleEx; // Extended style
202 wxString m_filter; // Wildcards in same format as per wxFileDialog
203 int m_currentFilter; // The current filter index
204 wxString m_currentFilterStr; // Current filter string
205 wxTreeCtrl* m_treeCtrl;
206 wxDirFilterListCtrl* m_filterListCtrl;
207
208private:
209 DECLARE_EVENT_TABLE()
210 DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl)
c0c133e1 211 wxDECLARE_NO_COPY_CLASS(wxGenericDirCtrl);
51a58d8b
JS
212};
213
84605707
VZ
214wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_DIRCTRL_CHANGED, wxTreeEvent );
215
216#define wx__DECLARE_DIRCTRL_EVT(evt, id, fn) \
217 wx__DECLARE_EVT1(wxEVT_COMMAND_DIRCTRL_ ## evt, id, wxTreeEventHandler(fn))
218
219#define EVT_DIRCTRL_CHANGED(id, fn) wx__DECLARE_DIRCTRL_EVT(CHANGED, id, fn)
220
51a58d8b
JS
221//-----------------------------------------------------------------------------
222// wxDirFilterListCtrl
223//-----------------------------------------------------------------------------
224
53a2db12 225class WXDLLIMPEXP_CORE wxDirFilterListCtrl: public wxChoice
51a58d8b
JS
226{
227public:
228 wxDirFilterListCtrl() { Init(); }
ca65c044 229 wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY,
51a58d8b
JS
230 const wxPoint& pos = wxDefaultPosition,
231 const wxSize& size = wxDefaultSize,
232 long style = 0)
233 {
234 Init();
235 Create(parent, id, pos, size, style);
236 }
ca65c044
WS
237
238 bool Create(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY,
51a58d8b
JS
239 const wxPoint& pos = wxDefaultPosition,
240 const wxSize& size = wxDefaultSize,
241 long style = 0);
242
243 void Init();
244
d3c7fc99 245 virtual ~wxDirFilterListCtrl() {}
51a58d8b 246
748fcded 247 //// Operations
51a58d8b
JS
248 void FillFilterList(const wxString& filter, int defaultFilter);
249
748fcded 250 //// Events
51a58d8b
JS
251 void OnSelFilter(wxCommandEvent& event);
252
253protected:
254 wxGenericDirCtrl* m_dirCtrl;
255
256 DECLARE_EVENT_TABLE()
257 DECLARE_CLASS(wxDirFilterListCtrl)
c0c133e1 258 wxDECLARE_NO_COPY_CLASS(wxDirFilterListCtrl);
51a58d8b
JS
259};
260
748fcded
VS
261#if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXPM__)
262 #define wxDirCtrl wxGenericDirCtrl
263#endif
51a58d8b 264
a977709b
JS
265// Symbols for accessing individual controls
266#define wxID_TREECTRL 7000
267#define wxID_FILTERLISTCTRL 7001
268
13de0c8c
WS
269#endif // wxUSE_DIRDLG
270
06cc1fb9
JS
271//-------------------------------------------------------------------------
272// wxFileIconsTable - use wxTheFileIconsTable which is created as necessary
273//-------------------------------------------------------------------------
274
ad09ec03
VZ
275#if wxUSE_DIRDLG || wxUSE_FILEDLG || wxUSE_FILECTRL
276
277class WXDLLIMPEXP_FWD_CORE wxImageList;
13de0c8c 278
53a2db12 279class WXDLLIMPEXP_CORE wxFileIconsTable
06cc1fb9
JS
280{
281public:
282 wxFileIconsTable();
283 ~wxFileIconsTable();
284
285 enum iconId_Type
286 {
287 folder,
288 folder_open,
289 computer,
290 drive,
291 cdrom,
292 floppy,
293 removeable,
294 file,
295 executable
296 };
297
298 int GetIconID(const wxString& extension, const wxString& mime = wxEmptyString);
299 wxImageList *GetSmallImageList();
300
301protected:
302 void Create(); // create on first use
303
304 wxImageList *m_smallImageList;
305 wxHashTable *m_HashTable;
306};
307
308// The global fileicons table
53a2db12 309extern WXDLLIMPEXP_DATA_CORE(wxFileIconsTable *) wxTheFileIconsTable;
06cc1fb9 310
ad09ec03 311#endif // wxUSE_DIRDLG || wxUSE_FILEDLG || wxUSE_FILECTRL
1e6feb95 312
51a58d8b
JS
313#endif
314 // _WX_DIRCTRLG_H_