include/wx/generic/dirctrlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/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 // Copyright:   (c) Robert Roebling, Harm van der Heijden, Julian Smart
  11 // Licence:     wxWindows licence
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_DIRCTRL_H_
  15 #define _WX_DIRCTRL_H_
  16
  17 #if wxUSE_DIRDLG
  18
  19 #include "wx/treectrl.h"
  20 #include "wx/dialog.h"
  21 #include "wx/dirdlg.h"
  22 #include "wx/choice.h"
  23
  24 //-----------------------------------------------------------------------------
  25 // classes
  26 //-----------------------------------------------------------------------------
  27
  28 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
  29 class WXDLLIMPEXP_FWD_BASE wxHashTable;
  30
  31 //-----------------------------------------------------------------------------
  32 // Extra styles for wxGenericDirCtrl
  33 //-----------------------------------------------------------------------------
  34
  35 enum
  36 {
  37     // Only allow directory viewing/selection, no files
  38     wxDIRCTRL_DIR_ONLY       = 0x0010,
  39     // When setting the default path, select the first file in the directory
  40     wxDIRCTRL_SELECT_FIRST   = 0x0020,
  41     // Show the filter list
  42     wxDIRCTRL_SHOW_FILTERS   = 0x0040,
  43     // Use 3D borders on internal controls
  44     wxDIRCTRL_3D_INTERNAL    = 0x0080,
  45     // Editable labels
  46     wxDIRCTRL_EDIT_LABELS    = 0x0100,
  47     // Allow multiple selection
  48     wxDIRCTRL_MULTIPLE       = 0x0200
  49 };
  50
  51 //-----------------------------------------------------------------------------
  52 // wxDirItemData
  53 //-----------------------------------------------------------------------------
  54
  55 class WXDLLIMPEXP_CORE wxDirItemData : public wxTreeItemData
  56 {
  57 public:
  58     wxDirItemData(const wxString& path, const wxString& name, bool isDir);
  59     virtual ~wxDirItemData(){}
  60     void SetNewDirName(const wxString& path);
  61
  62     bool HasSubDirs() const;
  63     bool HasFiles(const wxString& spec = wxEmptyString) const;
  64
  65     wxString m_path, m_name;
  66     bool m_isHidden;
  67     bool m_isExpanded;
  68     bool m_isDir;
  69 };
  70
  71 //-----------------------------------------------------------------------------
  72 // wxDirCtrl
  73 //-----------------------------------------------------------------------------
  74
  75 class WXDLLIMPEXP_FWD_CORE wxDirFilterListCtrl;
  76
  77 class WXDLLIMPEXP_CORE wxGenericDirCtrl: public wxControl
  78 {
  79 public:
  80     wxGenericDirCtrl();
  81     wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = wxID_ANY,
  82               const wxString &dir = wxDirDialogDefaultFolderStr,
  83               const wxPoint& pos = wxDefaultPosition,
  84               const wxSize& size = wxDefaultSize,
  85               long style = wxDIRCTRL_3D_INTERNAL,
  86               const wxString& filter = wxEmptyString,
  87               int defaultFilter = 0,
  88               const wxString& name = wxTreeCtrlNameStr )
  89     {
  90         Init();
  91         Create(parent, id, dir, pos, size, style, filter, defaultFilter, name);
  92     }
  93
  94     bool Create(wxWindow *parent, const wxWindowID id = wxID_ANY,
  95               const wxString &dir = wxDirDialogDefaultFolderStr,
  96               const wxPoint& pos = wxDefaultPosition,
  97               const wxSize& size = wxDefaultSize,
  98               long style = wxDIRCTRL_3D_INTERNAL,
  99               const wxString& filter = wxEmptyString,
 100               int defaultFilter = 0,
 101               const wxString& name = wxTreeCtrlNameStr );
 102
 103     virtual void Init();
 104
 105     virtual ~wxGenericDirCtrl();
 106
 107     void OnExpandItem(wxTreeEvent &event );
 108     void OnCollapseItem(wxTreeEvent &event );
 109     void OnBeginEditItem(wxTreeEvent &event );
 110     void OnEndEditItem(wxTreeEvent &event );
 111     void OnTreeSelChange(wxTreeEvent &event);
 112     void OnItemActivated(wxTreeEvent &event);
 113     void OnSize(wxSizeEvent &event );
 114
 115     // Try to expand as much of the given path as possible.
 116     virtual bool ExpandPath(const wxString& path);
 117     // collapse the path
 118     virtual bool CollapsePath(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     virtual void GetPaths(wxArrayString& paths) const;
 128
 129     // Get selected filename path only (else empty string).
 130     // I.e. don't count a directory as a selection
 131     virtual wxString GetFilePath() const;
 132     virtual void GetFilePaths(wxArrayString& paths) const;
 133     virtual void SetPath(const wxString& path);
 134
 135     virtual void SelectPath(const wxString& path, bool select = true);
 136     virtual void SelectPaths(const wxArrayString& paths);
 137
 138     virtual void ShowHidden( bool show );
 139     virtual bool GetShowHidden() { return m_showHidden; }
 140
 141     virtual wxString GetFilter() const { return m_filter; }
 142     virtual void SetFilter(const wxString& filter);
 143
 144     virtual int GetFilterIndex() const { return m_currentFilter; }
 145     virtual void SetFilterIndex(int n);
 146
 147     virtual wxTreeItemId GetRootId() { return m_rootId; }
 148
 149     virtual wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; }
 150     virtual wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; }
 151
 152     virtual void UnselectAll();
 153
 154     // Helper
 155     virtual void SetupSections();
 156
 157     // Find the child that matches the first part of 'path'.
 158     // E.g. if a child path is "/usr" and 'path' is "/usr/include"
 159     // then the child for /usr is returned.
 160     // If the path string has been used (we're at the leaf), done is set to true
 161     virtual wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
 162
 163     wxString GetPath(wxTreeItemId itemId) const;
 164
 165     // Resize the components of the control
 166     virtual void DoResize();
 167
 168     // Collapse & expand the tree, thus re-creating it from scratch:
 169     virtual void ReCreateTree();
 170
 171     // Collapse the entire tree
 172     virtual void CollapseTree();
 173
 174     // overridden base class methods
 175     virtual void SetFocus();
 176
 177 protected:
 178     virtual void ExpandRoot();
 179     virtual void ExpandDir(wxTreeItemId parentId);
 180     virtual void CollapseDir(wxTreeItemId parentId);
 181     virtual const wxTreeItemId AddSection(const wxString& path, const wxString& name, int imageId = 0);
 182     virtual wxTreeItemId AppendItem (const wxTreeItemId & parent,
 183                 const wxString & text,
 184                 int image = -1, int selectedImage = -1,
 185                 wxTreeItemData * data = NULL);
 186     //void FindChildFiles(wxTreeItemId id, int dirFlags, wxArrayString& filenames);
 187     virtual wxTreeCtrl* CreateTreeCtrl(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long treeStyle);
 188
 189     // Extract description and actual filter from overall filter string
 190     bool ExtractWildcard(const wxString& filterStr, int n, wxString& filter, wxString& description);
 191
 192 private:
 193     void PopulateNode(wxTreeItemId node);
 194     wxDirItemData* GetItemData(wxTreeItemId itemId);
 195
 196     bool            m_showHidden;
 197     wxTreeItemId    m_rootId;
 198     wxString        m_defaultPath; // Starting path
 199     long            m_styleEx; // Extended style
 200     wxString        m_filter;  // Wildcards in same format as per wxFileDialog
 201     int             m_currentFilter; // The current filter index
 202     wxString        m_currentFilterStr; // Current filter string
 203     wxTreeCtrl*     m_treeCtrl;
 204     wxDirFilterListCtrl* m_filterListCtrl;
 205
 206 private:
 207     DECLARE_EVENT_TABLE()
 208     DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl)
 209     wxDECLARE_NO_COPY_CLASS(wxGenericDirCtrl);
 210 };
 211
 212 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_DIRCTRL_SELECTIONCHANGED, wxTreeEvent );
 213 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_DIRCTRL_FILEACTIVATED, wxTreeEvent );
 214
 215 #define wx__DECLARE_DIRCTRL_EVT(evt, id, fn) \
 216     wx__DECLARE_EVT1(wxEVT_DIRCTRL_ ## evt, id, wxTreeEventHandler(fn))
 217
 218 #define EVT_DIRCTRL_SELECTIONCHANGED(id, fn) wx__DECLARE_DIRCTRL_EVT(SELECTIONCHANGED, id, fn)
 219 #define EVT_DIRCTRL_FILEACTIVATED(id, fn) wx__DECLARE_DIRCTRL_EVT(FILEACTIVATED, id, fn)
 220
 221 //-----------------------------------------------------------------------------
 222 // wxDirFilterListCtrl
 223 //-----------------------------------------------------------------------------
 224
 225 class WXDLLIMPEXP_CORE wxDirFilterListCtrl: public wxChoice
 226 {
 227 public:
 228     wxDirFilterListCtrl() { Init(); }
 229     wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY,
 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     }
 237
 238     bool Create(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY,
 239               const wxPoint& pos = wxDefaultPosition,
 240               const wxSize& size = wxDefaultSize,
 241               long style = 0);
 242
 243     void Init();
 244
 245     virtual ~wxDirFilterListCtrl() {}
 246
 247     //// Operations
 248     void FillFilterList(const wxString& filter, int defaultFilter);
 249
 250     //// Events
 251     void OnSelFilter(wxCommandEvent& event);
 252
 253 protected:
 254     wxGenericDirCtrl*    m_dirCtrl;
 255
 256     DECLARE_EVENT_TABLE()
 257     DECLARE_CLASS(wxDirFilterListCtrl)
 258     wxDECLARE_NO_COPY_CLASS(wxDirFilterListCtrl);
 259 };
 260
 261 #if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXPM__)
 262     #define wxDirCtrl wxGenericDirCtrl
 263 #endif
 264
 265 // Symbols for accessing individual controls
 266 #define wxID_TREECTRL          7000
 267 #define wxID_FILTERLISTCTRL    7001
 268
 269 #endif // wxUSE_DIRDLG
 270
 271 //-------------------------------------------------------------------------
 272 // wxFileIconsTable - use wxTheFileIconsTable which is created as necessary
 273 //-------------------------------------------------------------------------
 274
 275 #if wxUSE_DIRDLG || wxUSE_FILEDLG || wxUSE_FILECTRL
 276
 277 class WXDLLIMPEXP_FWD_CORE wxImageList;
 278
 279 class WXDLLIMPEXP_CORE wxFileIconsTable
 280 {
 281 public:
 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
 301 protected:
 302     void Create();  // create on first use
 303
 304     wxImageList *m_smallImageList;
 305     wxHashTable *m_HashTable;
 306 };
 307
 308 // The global fileicons table
 309 extern WXDLLIMPEXP_DATA_CORE(wxFileIconsTable *) wxTheFileIconsTable;
 310
 311 #endif // wxUSE_DIRDLG || wxUSE_FILEDLG || wxUSE_FILECTRL
 312
 313 // old wxEVT_COMMAND_* constants
 314 #define wxEVT_COMMAND_DIRCTRL_SELECTIONCHANGED wxEVT_DIRCTRL_SELECTIONCHANGED
 315 #define wxEVT_COMMAND_DIRCTRL_FILEACTIVATED   wxEVT_DIRCTRL_FILEACTIVATED
 316
 317 #endif
 318     // _WX_DIRCTRLG_H_