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