Remove wxDialog::OnSysColourChanged() documentation.

[wxWidgets.git] / include / wx / generic / dirctrlg.h

diff --git a/include/wx/generic/dirctrlg.h b/include/wx/generic/dirctrlg.h
index cc6624c6fceae2be1cd440422b97e01f058e8085..3a8b46de1febefc44b21dab609d4f28a2ca8a67f 100644 (file)
--- a/include/wx/generic/dirctrlg.h
+++ b/include/wx/generic/dirctrlg.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dirctrlg.h
+// Name:        wx/generic/dirctrlg.h

 // Purpose:     wxGenericDirCtrl class
 //              Builds on wxDirCtrl class written by Robert Roebling for the
 //              wxFile application, modified by Harm van der Heijden.
 // Purpose:     wxGenericDirCtrl class
 //              Builds on wxDirCtrl class written by Robert Roebling for the
 //              wxFile application, modified by Harm van der Heijden.


@@ -15,10 +15,6 @@
 #ifndef _WX_DIRCTRL_H_
 #define _WX_DIRCTRL_H_
 
 #ifndef _WX_DIRCTRL_H_
 #define _WX_DIRCTRL_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "dirctrlg.h"
-#endif
-

 #if wxUSE_DIRDLG
 
 #include "wx/treectrl.h"
 #if wxUSE_DIRDLG
 
 #include "wx/treectrl.h"


@@ -30,9 +26,8 @@
 // classes
 //-----------------------------------------------------------------------------
 
 // classes
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTextCtrl;
-class WXDLLEXPORT wxImageList;
-class WXDLLEXPORT wxHashTable;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
+class WXDLLIMPEXP_FWD_BASE wxHashTable;

 
 //-----------------------------------------------------------------------------
 // Extra styles for wxGenericDirCtrl
 
 //-----------------------------------------------------------------------------
 // Extra styles for wxGenericDirCtrl


@@ -44,23 +39,27 @@ enum
     wxDIRCTRL_DIR_ONLY       = 0x0010,
     // When setting the default path, select the first file in the directory
     wxDIRCTRL_SELECT_FIRST   = 0x0020,
     wxDIRCTRL_DIR_ONLY       = 0x0010,
     // When setting the default path, select the first file in the directory
     wxDIRCTRL_SELECT_FIRST   = 0x0020,

-    // Show the filter list
+#if WXWIN_COMPATIBILITY_2_8
+    // Unused, for compatibility only

     wxDIRCTRL_SHOW_FILTERS   = 0x0040,
     wxDIRCTRL_SHOW_FILTERS   = 0x0040,

+#endif // WXWIN_COMPATIBILITY_2_8

     // Use 3D borders on internal controls
     wxDIRCTRL_3D_INTERNAL    = 0x0080,
     // Editable labels
     // Use 3D borders on internal controls
     wxDIRCTRL_3D_INTERNAL    = 0x0080,
     // Editable labels

-    wxDIRCTRL_EDIT_LABELS    = 0x0100
+    wxDIRCTRL_EDIT_LABELS    = 0x0100,
+    // Allow multiple selection
+    wxDIRCTRL_MULTIPLE       = 0x0200

 };
 
 //-----------------------------------------------------------------------------
 // wxDirItemData
 //-----------------------------------------------------------------------------
 
 };
 
 //-----------------------------------------------------------------------------
 // wxDirItemData
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDirItemData : public wxTreeItemData
+class WXDLLIMPEXP_CORE wxDirItemData : public wxTreeItemData

 {
 public:
     wxDirItemData(const wxString& path, const wxString& name, bool isDir);
 {
 public:
     wxDirItemData(const wxString& path, const wxString& name, bool isDir);

-    ~wxDirItemData();
+    virtual ~wxDirItemData(){}

     void SetNewDirName(const wxString& path);
 
     bool HasSubDirs() const;
     void SetNewDirName(const wxString& path);
 
     bool HasSubDirs() const;


@@ -76,17 +75,17 @@ public:
 // wxDirCtrl
 //-----------------------------------------------------------------------------
 
 // wxDirCtrl
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDirFilterListCtrl;
+class WXDLLIMPEXP_FWD_CORE wxDirFilterListCtrl;

 
 

-class WXDLLEXPORT wxGenericDirCtrl: public wxControl
+class WXDLLIMPEXP_CORE wxGenericDirCtrl: public wxControl

 {
 public:
     wxGenericDirCtrl();
 {
 public:
     wxGenericDirCtrl();

-    wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = -1,
+    wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = wxID_ANY,

               const wxString &dir = wxDirDialogDefaultFolderStr,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               const wxString &dir = wxDirDialogDefaultFolderStr,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,

-              long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
+              long style = wxDIRCTRL_3D_INTERNAL,

               const wxString& filter = wxEmptyString,
               int defaultFilter = 0,
               const wxString& name = wxTreeCtrlNameStr )
               const wxString& filter = wxEmptyString,
               int defaultFilter = 0,
               const wxString& name = wxTreeCtrlNameStr )


@@ -94,12 +93,12 @@ public:
         Init();
         Create(parent, id, dir, pos, size, style, filter, defaultFilter, name);
     }
         Init();
         Create(parent, id, dir, pos, size, style, filter, defaultFilter, name);
     }

-    
-    bool Create(wxWindow *parent, const wxWindowID id = -1,
+
+    bool Create(wxWindow *parent, const wxWindowID id = wxID_ANY,

               const wxString &dir = wxDirDialogDefaultFolderStr,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               const wxString &dir = wxDirDialogDefaultFolderStr,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,

-              long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
+              long style = wxDIRCTRL_3D_INTERNAL,

               const wxString& filter = wxEmptyString,
               int defaultFilter = 0,
               const wxString& name = wxTreeCtrlNameStr );
               const wxString& filter = wxEmptyString,
               int defaultFilter = 0,
               const wxString& name = wxTreeCtrlNameStr );


@@ -116,6 +115,8 @@ public:
 
     // Try to expand as much of the given path as possible.
     virtual bool ExpandPath(const wxString& path);
 
     // Try to expand as much of the given path as possible.
     virtual bool ExpandPath(const wxString& path);

+    // collapse the path
+    virtual bool CollapsePath(const wxString& path);

 
     // Accessors
 
 
     // Accessors
 


@@ -124,12 +125,17 @@ public:
 
     // Get dir or filename
     virtual wxString GetPath() const;
 
     // Get dir or filename
     virtual wxString GetPath() const;

-    
+    virtual void GetPaths(wxArrayString& paths) const;
+

     // Get selected filename path only (else empty string).
     // I.e. don't count a directory as a selection
     virtual wxString GetFilePath() const;
     // Get selected filename path only (else empty string).
     // I.e. don't count a directory as a selection
     virtual wxString GetFilePath() const;

+    virtual void GetFilePaths(wxArrayString& paths) const;

     virtual void SetPath(const wxString& path);
     virtual void SetPath(const wxString& path);

-    
+
+    virtual void SelectPath(const wxString& path, bool select = true);
+    virtual void SelectPaths(const wxArrayString& paths);
+

     virtual void ShowHidden( bool show );
     virtual bool GetShowHidden() { return m_showHidden; }
 
     virtual void ShowHidden( bool show );
     virtual bool GetShowHidden() { return m_showHidden; }
 


@@ -144,27 +150,31 @@ public:
     virtual wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; }
     virtual wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; }
 
     virtual wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; }
     virtual wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; }
 

+    virtual void UnselectAll();
+

     // Helper
     virtual void SetupSections();
     // Helper
     virtual void SetupSections();

-    
-#if WXWIN_COMPATIBILITY_2_4
-    // Parse the filter into an array of filters and an array of descriptions
-    virtual int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);
-#endif // WXWIN_COMPATIBILITY_2_4
-    
+

     // Find the child that matches the first part of 'path'.
     // E.g. if a child path is "/usr" and 'path' is "/usr/include"
     // then the child for /usr is returned.
     // Find the child that matches the first part of 'path'.
     // E.g. if a child path is "/usr" and 'path' is "/usr/include"
     // then the child for /usr is returned.

-    // If the path string has been used (we're at the leaf), done is set to TRUE
+    // If the path string has been used (we're at the leaf), done is set to true

     virtual wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
     virtual wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);

-    
+

     // Resize the components of the control
     virtual void DoResize();
     // Resize the components of the control
     virtual void DoResize();

-    
+

     // Collapse & expand the tree, thus re-creating it from scratch:
     virtual void ReCreateTree();
     // Collapse & expand the tree, thus re-creating it from scratch:
     virtual void ReCreateTree();

-    
+
+    // Collapse the entire tree
+    virtual void CollapseTree();
+
+    // overridden base class methods
+    virtual void SetFocus();
+

 protected:
 protected:

+    virtual void ExpandRoot();

     virtual void ExpandDir(wxTreeItemId parentId);
     virtual void CollapseDir(wxTreeItemId parentId);
     virtual const wxTreeItemId AddSection(const wxString& path, const wxString& name, int imageId = 0);
     virtual void ExpandDir(wxTreeItemId parentId);
     virtual void CollapseDir(wxTreeItemId parentId);
     virtual const wxTreeItemId AddSection(const wxString& path, const wxString& name, int imageId = 0);


@@ -173,11 +183,14 @@ protected:
                 int image = -1, int selectedImage = -1,
                 wxTreeItemData * data = NULL);
     //void FindChildFiles(wxTreeItemId id, int dirFlags, wxArrayString& filenames);
                 int image = -1, int selectedImage = -1,
                 wxTreeItemData * data = NULL);
     //void FindChildFiles(wxTreeItemId id, int dirFlags, wxArrayString& filenames);

+    virtual wxTreeCtrl* CreateTreeCtrl(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long treeStyle);

 
     // Extract description and actual filter from overall filter string
     bool ExtractWildcard(const wxString& filterStr, int n, wxString& filter, wxString& description);
 
 private:
 
     // Extract description and actual filter from overall filter string
     bool ExtractWildcard(const wxString& filterStr, int n, wxString& filter, wxString& description);
 
 private:

+    void PopulateNode(wxTreeItemId node);
+

     bool            m_showHidden;
     wxTreeItemId    m_rootId;
     wxString        m_defaultPath; // Starting path
     bool            m_showHidden;
     wxTreeItemId    m_rootId;
     wxString        m_defaultPath; // Starting path


@@ -191,18 +204,18 @@ private:
 private:
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl)
 private:
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl)

-    DECLARE_NO_COPY_CLASS(wxGenericDirCtrl)
+    wxDECLARE_NO_COPY_CLASS(wxGenericDirCtrl);

 };
 
 //-----------------------------------------------------------------------------
 // wxDirFilterListCtrl
 //-----------------------------------------------------------------------------
 
 };
 
 //-----------------------------------------------------------------------------
 // wxDirFilterListCtrl
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDirFilterListCtrl: public wxChoice
+class WXDLLIMPEXP_CORE wxDirFilterListCtrl: public wxChoice

 {
 public:
     wxDirFilterListCtrl() { Init(); }
 {
 public:
     wxDirFilterListCtrl() { Init(); }

-    wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = -1,
+    wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY,

               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0)
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0)


@@ -210,15 +223,15 @@ public:
         Init();
         Create(parent, id, pos, size, style);
     }
         Init();
         Create(parent, id, pos, size, style);
     }

-    
-    bool Create(wxGenericDirCtrl* parent, const wxWindowID id = -1,
+
+    bool Create(wxGenericDirCtrl* parent, const wxWindowID id = wxID_ANY,

               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0);
 
     void Init();
 
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0);
 
     void Init();
 

-    ~wxDirFilterListCtrl() {};
+    virtual ~wxDirFilterListCtrl() {}

 
     //// Operations
     void FillFilterList(const wxString& filter, int defaultFilter);
 
     //// Operations
     void FillFilterList(const wxString& filter, int defaultFilter);


@@ -231,7 +244,7 @@ protected:
 
     DECLARE_EVENT_TABLE()
     DECLARE_CLASS(wxDirFilterListCtrl)
 
     DECLARE_EVENT_TABLE()
     DECLARE_CLASS(wxDirFilterListCtrl)

-    DECLARE_NO_COPY_CLASS(wxDirFilterListCtrl)
+    wxDECLARE_NO_COPY_CLASS(wxDirFilterListCtrl);

 };
 
 #if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXPM__)
 };
 
 #if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXPM__)


@@ -242,11 +255,17 @@ protected:
 #define wxID_TREECTRL          7000
 #define wxID_FILTERLISTCTRL    7001
 
 #define wxID_TREECTRL          7000
 #define wxID_FILTERLISTCTRL    7001
 

+#endif // wxUSE_DIRDLG
+

 //-------------------------------------------------------------------------
 // wxFileIconsTable - use wxTheFileIconsTable which is created as necessary
 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 // wxFileIconsTable - use wxTheFileIconsTable which is created as necessary
 //-------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFileIconsTable
+#if wxUSE_DIRDLG || wxUSE_FILEDLG || wxUSE_FILECTRL
+
+class WXDLLIMPEXP_FWD_CORE wxImageList;
+
+class WXDLLIMPEXP_CORE wxFileIconsTable

 {
 public:
     wxFileIconsTable();
 {
 public:
     wxFileIconsTable();


@@ -276,9 +295,9 @@ protected:
 };
 
 // The global fileicons table
 };
 
 // The global fileicons table

-WXDLLEXPORT_DATA(extern wxFileIconsTable *) wxTheFileIconsTable;
+extern WXDLLIMPEXP_DATA_CORE(wxFileIconsTable *) wxTheFileIconsTable;

 
 

-#endif // wxUSE_DIRDLG
+#endif // wxUSE_DIRDLG || wxUSE_FILEDLG || wxUSE_FILECTRL

 
 #endif
     // _WX_DIRCTRLG_H_
 
 #endif
     // _WX_DIRCTRLG_H_