Updated translations manual page with latest status given by the website translations...

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

diff --git a/include/wx/generic/dirctrlg.h b/include/wx/generic/dirctrlg.h
index cfc86d1430a91bd74bb7abcca6a0e928632e208a..bd09b3c8a6fb4cd8209071a6458981259698873f 100644 (file)
--- a/include/wx/generic/dirctrlg.h
+++ b/include/wx/generic/dirctrlg.h
@@ -4,22 +4,25 @@
 //              Builds on wxDirCtrl class written by Robert Roebling for the
 //              wxFile application, modified by Harm van der Heijden.
 //              Further modified for Windows.
 //              Builds on wxDirCtrl class written by Robert Roebling for the
 //              wxFile application, modified by Harm van der Heijden.
 //              Further modified for Windows.

-// Author:      Julian Smart et al
+// Author:      Robert Roebling, Harm van der Heijden, Julian Smart et al

 // Modified by:
 // Created:     21/3/2000
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     21/3/2000
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart
-// Licence:    wxWindows licence
+// Copyright:   (c) Robert Roebling, Harm van der Heijden, Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIRCTRL_H_
 #define _WX_DIRCTRL_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIRCTRL_H_
 #define _WX_DIRCTRL_H_
 

-#ifdef __GNUG__
-#pragma interface "dirctrlg.h"
+#if wxUSE_DIRDLG || wxUSE_FILEDLG
+    #include "wx/imaglist.h"

 #endif
 
 #endif
 

+#if wxUSE_DIRDLG
+

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

+#include "wx/dialog.h"

 #include "wx/dirdlg.h"
 #include "wx/choice.h"
 
 #include "wx/dirdlg.h"
 #include "wx/choice.h"
 


@@ -27,55 +30,65 @@
 // classes
 //-----------------------------------------------------------------------------
 
 // classes
 //-----------------------------------------------------------------------------
 

-//class wxDirItemData;
-class wxDirCtrl;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
+class WXDLLIMPEXP_FWD_CORE wxImageList;
+class WXDLLIMPEXP_FWD_BASE wxHashTable;

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

-// Only allow directory viewing/selection, no files
-#define wxDIRCTRL_DIR_ONLY       0x0010
-// When setting the default path, select the first file in the directory
-#define wxDIRCTRL_SELECT_FIRST   0x0020
-// Show the filter list
-#define wxDIRCTRL_SHOW_FILTERS   0x0040
-// Use 3D borders on internal controls
-#define wxDIRCTRL_3D_INTERNAL    0x0080
+enum
+{
+    // Only allow directory viewing/selection, no files
+    wxDIRCTRL_DIR_ONLY       = 0x0010,
+    // When setting the default path, select the first file in the directory
+    wxDIRCTRL_SELECT_FIRST   = 0x0020,
+#if WXWIN_COMPATIBILITY_2_8
+    // Unused, for compatibility only
+    wxDIRCTRL_SHOW_FILTERS   = 0x0040,
+#endif // WXWIN_COMPATIBILITY_2_8
+    // Use 3D borders on internal controls
+    wxDIRCTRL_3D_INTERNAL    = 0x0080,
+    // Editable labels
+    wxDIRCTRL_EDIT_LABELS    = 0x0100
+};

 
 //-----------------------------------------------------------------------------
 // wxDirItemData
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxDirItemData
 //-----------------------------------------------------------------------------
 

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

 {
 public:
 {
 public:

-  wxDirItemDataEx(const wxString& path, const wxString& name, bool isDir);
-  ~wxDirItemDataEx();
-  bool HasSubDirs();
-  void SetNewDirName( wxString path );
-  wxString m_path, m_name;
-  bool m_isHidden;
-  bool m_hasSubDirs;
-  bool m_isExpanded;
-  bool m_isDir;
+    wxDirItemData(const wxString& path, const wxString& name, bool isDir);
+    virtual ~wxDirItemData(){}
+    void SetNewDirName(const wxString& path);
+
+    bool HasSubDirs() const;
+    bool HasFiles(const wxString& spec = wxEmptyString) const;
+
+    wxString m_path, m_name;
+    bool m_isHidden;
+    bool m_isExpanded;
+    bool m_isDir;

 };
 
 //-----------------------------------------------------------------------------
 // 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 )


@@ -83,19 +96,19 @@ 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 );
 

-    void Init();
+    virtual void Init();

 
 

-    ~wxGenericDirCtrl();
+    virtual ~wxGenericDirCtrl();

 
     void OnExpandItem(wxTreeEvent &event );
     void OnCollapseItem(wxTreeEvent &event );
 
     void OnExpandItem(wxTreeEvent &event );
     void OnCollapseItem(wxTreeEvent &event );


@@ -104,50 +117,70 @@ public:
     void OnSize(wxSizeEvent &event );
 
     // Try to expand as much of the given path as possible.
     void OnSize(wxSizeEvent &event );
 
     // Try to expand as much of the given path as possible.

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

 
     // Accessors
 
 
     // Accessors
 

-    inline wxString GetDefaultPath() const { return m_defaultPath; }
-    void SetDefaultPath(const wxString& path) { m_defaultPath = path; }
-
-    //inline long GetStyleEx() const { return m_styleEx; }
-    //void SetStyleEx(long styleEx) { m_styleEx = styleEx; }
+    virtual inline wxString GetDefaultPath() const { return m_defaultPath; }
+    virtual void SetDefaultPath(const wxString& path) { m_defaultPath = path; }

 
     // Get dir or filename
 
     // Get dir or filename

-    wxString GetPath() const ;
+    virtual wxString GetPath() const;
+

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

-    wxString GetFilePath() const ;
-    void SetPath(const wxString& path) ;
+    virtual wxString GetFilePath() const;
+    virtual void SetPath(const wxString& path);
+
+    virtual void ShowHidden( bool show );
+    virtual bool GetShowHidden() { return m_showHidden; }

 
 

-    wxString GetFilter() const { return m_filter; }
-    void SetFilter(const wxString& filter);
+    virtual wxString GetFilter() const { return m_filter; }
+    virtual void SetFilter(const wxString& filter);

 
 

-    int GetFilterIndex() const { return m_currentFilter; }
-    void SetFilterIndex(int n) ;
+    virtual int GetFilterIndex() const { return m_currentFilter; }
+    virtual void SetFilterIndex(int n);

 
 

-    wxTreeItemId GetRootId() { return m_rootId; }
+    virtual wxTreeItemId GetRootId() { return m_rootId; }

 
 

-    wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; }
-    wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; }
+    virtual wxTreeCtrl* GetTreeCtrl() const { return m_treeCtrl; }
+    virtual wxDirFilterListCtrl* GetFilterListCtrl() const { return m_filterListCtrl; }
+
+    // Helper
+    virtual void SetupSections();

 
 

-//// Helpers
-    void SetupSections();
-    // Parse the filter into an array of filters and an array of descriptions
-    int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);

     // 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
-    wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
-    
+    // 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);
+

     // Resize the components of the control
     // Resize the components of the control

-    void DoResize();
+    virtual void DoResize();
+
+    // 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:

-    void ExpandDir(wxTreeItemId parentId);
-    void AddSection(const wxString& path, const wxString& name, int imageId = 0);
+    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 wxTreeItemId AppendItem (const wxTreeItemId & parent,
+                const wxString & text,
+                int image = -1, int selectedImage = -1,
+                wxTreeItemData * data = NULL);

     //void FindChildFiles(wxTreeItemId id, int dirFlags, wxArrayString& filenames);
     //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);
 
     // Extract description and actual filter from overall filter string
     bool ExtractWildcard(const wxString& filterStr, int n, wxString& filter, wxString& description);


@@ -155,7 +188,6 @@ protected:
 private:
     bool            m_showHidden;
     wxTreeItemId    m_rootId;
 private:
     bool            m_showHidden;
     wxTreeItemId    m_rootId;

-    wxImageList*    m_imageList;

     wxString        m_defaultPath; // Starting path
     long            m_styleEx; // Extended style
     wxString        m_filter;  // Wildcards in same format as per wxFileDialog
     wxString        m_defaultPath; // Starting path
     long            m_styleEx; // Extended style
     wxString        m_filter;  // Wildcards in same format as per wxFileDialog


@@ -167,17 +199,18 @@ private:
 private:
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl)
 private:
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericDirCtrl)

+    DECLARE_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)


@@ -185,20 +218,20 @@ 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
+    //// Operations

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

-//// Events
+    //// Events

     void OnSelFilter(wxCommandEvent& event);
 
 protected:
     void OnSelFilter(wxCommandEvent& event);
 
 protected:


@@ -206,53 +239,58 @@ protected:
 
     DECLARE_EVENT_TABLE()
     DECLARE_CLASS(wxDirFilterListCtrl)
 
     DECLARE_EVENT_TABLE()
     DECLARE_CLASS(wxDirFilterListCtrl)

+    DECLARE_NO_COPY_CLASS(wxDirFilterListCtrl)

 };
 
 };
 

+#if !defined(__WXMSW__) && !defined(__WXMAC__) && !defined(__WXPM__)
+    #define wxDirCtrl wxGenericDirCtrl
+#endif
+
+// Symbols for accessing individual controls

 #define wxID_TREECTRL          7000
 #define wxID_FILTERLISTCTRL    7001
 
 #define wxID_TREECTRL          7000
 #define wxID_FILTERLISTCTRL    7001
 

-//-----------------------------------------------------------------------------
-// wxGenericDirDialog
-//
-//-----------------------------------------------------------------------------
+#endif // wxUSE_DIRDLG

 
 

-class wxGenericDirDialog: public wxDialog
-{
-DECLARE_EVENT_TABLE()
-public:
-    wxGenericDirDialog(): wxDialog() {}
-    wxGenericDirDialog(wxWindow* parent, const wxString& title,
-        const wxString& defaultPath = wxEmptyString, long style = wxDEFAULT_DIALOG_STYLE, const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxSize(450, 550), const wxString& name = "dialog");
+//-------------------------------------------------------------------------
+// wxFileIconsTable - use wxTheFileIconsTable which is created as necessary
+//-------------------------------------------------------------------------

 
 

-//// Event handlers
-    void OnCloseWindow(wxCloseEvent& event);
-    void OnOK(wxCommandEvent& event);
-    void OnTreeSelected( wxTreeEvent &event );
-    void OnTreeKeyDown( wxTreeEvent &event );
-    void OnNew(wxCommandEvent& event);
+#if wxUSE_DIRDLG || wxUSE_FILEDLG

 
 

-//// Accessors
-    inline void SetMessage(const wxString& message) { m_message = message; }
-    void SetPath(const wxString& path) ;
-    inline void SetStyle(long style) { m_dialogStyle = style; }
-
-    inline wxString GetMessage(void) const { return m_message; }
-    wxString GetPath(void) const ;
-    inline long GetStyle(void) const { return m_dialogStyle; }
-
-    wxTextCtrl* GetInputCtrl() const { return m_input; }
+class WXDLLIMPEXP_CORE wxFileIconsTable
+{
+public:
+    wxFileIconsTable();
+    ~wxFileIconsTable();

 
 

-//// Overrides
-    int ShowModal();
+    enum iconId_Type
+    {
+        folder,
+        folder_open,
+        computer,
+        drive,
+        cdrom,
+        floppy,
+        removeable,
+        file,
+        executable
+    };
+
+    int GetIconID(const wxString& extension, const wxString& mime = wxEmptyString);
+    wxImageList *GetSmallImageList();

 
 protected:
 
 protected:

-    wxString    m_message;
-    long        m_dialogStyle;
-    wxString    m_path;
-    wxGenericDirCtrl* m_dirCtrl;
-    wxTextCtrl* m_input;
+    void Create();  // create on first use

 
 

+    wxImageList *m_smallImageList;
+    wxHashTable *m_HashTable;

 };
 
 };
 

+// The global fileicons table
+extern WXDLLIMPEXP_DATA_CORE(wxFileIconsTable *) wxTheFileIconsTable;
+
+#endif // wxUSE_DIRDLG || wxUSE_FILEDLG
+

 #endif
     // _WX_DIRCTRLG_H_
 #endif
     // _WX_DIRCTRLG_H_