Comment-only update

[wxWidgets.git] / include / wx / filepicker.h

diff --git a/include/wx/filepicker.h b/include/wx/filepicker.h
index fb0f10f6d82c4d897e6f5c71b938260deb39517d..5264ddb3ea32068e9496936bf8b203102875ccd2 100644 (file)
--- a/include/wx/filepicker.h
+++ b/include/wx/filepicker.h
@@ -5,7 +5,6 @@
 // Modified by:
 // Created:     14/4/2006
 // Copyright:   (c) Francesco Montorsi
 // Modified by:
 // Created:     14/4/2006
 // Copyright:   (c) Francesco Montorsi

-// RCS-ID:      $Id$

 // Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -17,20 +16,64 @@
 #if wxUSE_FILEPICKERCTRL || wxUSE_DIRPICKERCTRL
 
 #include "wx/pickerbase.h"
 #if wxUSE_FILEPICKERCTRL || wxUSE_DIRPICKERCTRL
 
 #include "wx/pickerbase.h"

+#include "wx/filename.h"

 
 

-class WXDLLIMPEXP_CORE wxDialog;
-class WXDLLIMPEXP_CORE wxFileDirPickerEvent;
+class WXDLLIMPEXP_FWD_CORE wxDialog;
+class WXDLLIMPEXP_FWD_CORE wxFileDirPickerEvent;

 
 

-extern WXDLLEXPORT_DATA(const wxChar) wxFilePickerWidgetLabel[];
-extern WXDLLEXPORT_DATA(const wxChar) wxFilePickerWidgetNameStr[];
-extern WXDLLEXPORT_DATA(const wxChar) wxFilePickerCtrlNameStr[];
-extern WXDLLEXPORT_DATA(const wxChar) wxFileSelectorPromptStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxFilePickerWidgetLabel[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxFilePickerWidgetNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxFilePickerCtrlNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxFileSelectorPromptStr[];

 
 

-extern WXDLLEXPORT_DATA(const wxChar) wxDirPickerWidgetLabel[];
-extern WXDLLEXPORT_DATA(const wxChar) wxDirPickerWidgetNameStr[];
-extern WXDLLEXPORT_DATA(const wxChar) wxDirPickerCtrlNameStr[];
-extern WXDLLEXPORT_DATA(const wxChar) wxDirSelectorPromptStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxDirPickerWidgetLabel[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxDirPickerWidgetNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxDirPickerCtrlNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxDirSelectorPromptStr[];

 
 

+// ----------------------------------------------------------------------------
+// wxFileDirPickerEvent: used by wxFilePickerCtrl and wxDirPickerCtrl only
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxFileDirPickerEvent : public wxCommandEvent
+{
+public:
+    wxFileDirPickerEvent() {}
+    wxFileDirPickerEvent(wxEventType type, wxObject *generator, int id, const wxString &path)
+        : wxCommandEvent(type, id),
+          m_path(path)
+    {
+        SetEventObject(generator);
+    }
+
+    wxString GetPath() const { return m_path; }
+    void SetPath(const wxString &p) { m_path = p; }
+
+    // default copy ctor, assignment operator and dtor are ok
+    virtual wxEvent *Clone() const { return new wxFileDirPickerEvent(*this); }
+
+private:
+    wxString m_path;
+
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFileDirPickerEvent)
+};
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_FILEPICKER_CHANGED, wxFileDirPickerEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_DIRPICKER_CHANGED, wxFileDirPickerEvent );
+
+// ----------------------------------------------------------------------------
+// event types and macros
+// ----------------------------------------------------------------------------
+
+typedef void (wxEvtHandler::*wxFileDirPickerEventFunction)(wxFileDirPickerEvent&);
+
+#define wxFileDirPickerEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxFileDirPickerEventFunction, func)
+
+#define EVT_FILEPICKER_CHANGED(id, fn) \
+    wx__DECLARE_EVT1(wxEVT_FILEPICKER_CHANGED, id, wxFileDirPickerEventHandler(fn))
+#define EVT_DIRPICKER_CHANGED(id, fn) \
+    wx__DECLARE_EVT1(wxEVT_DIRPICKER_CHANGED, id, wxFileDirPickerEventHandler(fn))

 
 // ----------------------------------------------------------------------------
 // wxFileDirPickerWidgetBase: a generic abstract interface which must be
 
 // ----------------------------------------------------------------------------
 // wxFileDirPickerWidgetBase: a generic abstract interface which must be


@@ -43,9 +86,16 @@ public:
     wxFileDirPickerWidgetBase() {  }
     virtual ~wxFileDirPickerWidgetBase() {  }
 
     wxFileDirPickerWidgetBase() {  }
     virtual ~wxFileDirPickerWidgetBase() {  }
 

+    // Path here is the name of the selected file or directory.

     wxString GetPath() const { return m_path; }
     virtual void SetPath(const wxString &str) { m_path=str; }
 
     wxString GetPath() const { return m_path; }
     virtual void SetPath(const wxString &str) { m_path=str; }
 

+    // Set the directory to open the file browse dialog at initially.
+    virtual void SetInitialDirectory(const wxString& dir) = 0;
+
+    // returns the picker widget cast to wxControl
+    virtual wxControl *AsControl() = 0;
+

 protected:
     virtual void UpdateDialogPath(wxDialog *) = 0;
     virtual void UpdatePathFromDialog(wxDialog *) = 0;
 protected:
     virtual void UpdateDialogPath(wxDialog *) = 0;
     virtual void UpdatePathFromDialog(wxDialog *) = 0;


@@ -57,17 +107,19 @@ protected:
 // NB: these styles must be defined to carefully-chosen values to
 //     avoid conflicts with wxButton's styles
 
 // NB: these styles must be defined to carefully-chosen values to
 //     avoid conflicts with wxButton's styles
 

-#define wxFLP_OPEN                    0x0200
-#define wxFLP_SAVE                    0x0400
-#define wxFLP_OVERWRITE_PROMPT        0x0800
-#define wxFLP_FILE_MUST_EXIST         0x1000
-#define wxFLP_CHANGE_DIR              0x2000
+#define wxFLP_OPEN                    0x0400
+#define wxFLP_SAVE                    0x0800
+#define wxFLP_OVERWRITE_PROMPT        0x1000
+#define wxFLP_FILE_MUST_EXIST         0x2000
+#define wxFLP_CHANGE_DIR              0x4000
+#define wxFLP_SMALL                   wxPB_SMALL

 
 // NOTE: wxMULTIPLE is not supported !
 
 
 #define wxDIRP_DIR_MUST_EXIST         0x0008
 #define wxDIRP_CHANGE_DIR             0x0010
 
 // NOTE: wxMULTIPLE is not supported !
 
 
 #define wxDIRP_DIR_MUST_EXIST         0x0008
 #define wxDIRP_CHANGE_DIR             0x0010

+#define wxDIRP_SMALL                  wxPB_SMALL

 
 
 // map platform-dependent controls which implement the wxFileDirPickerWidgetBase
 
 
 // map platform-dependent controls which implement the wxFileDirPickerWidgetBase


@@ -75,7 +127,8 @@ protected:
 // NOTE: wxFileDirPickerCtrlBase will allocate a wx{File|Dir}PickerWidget and this
 //       requires that all classes being mapped as wx{File|Dir}PickerWidget have the
 //       same prototype for the contructor...
 // NOTE: wxFileDirPickerCtrlBase will allocate a wx{File|Dir}PickerWidget and this
 //       requires that all classes being mapped as wx{File|Dir}PickerWidget have the
 //       same prototype for the contructor...

-#if defined(__WXGTK26__)        // since GTK >= 2.6, there is GtkFileButton
+// since GTK >= 2.6, there is GtkFileButton
+#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)

     #include "wx/gtk/filepicker.h"
     #define wxFilePickerWidget      wxFileButton
     #define wxDirPickerWidget       wxDirButton
     #include "wx/gtk/filepicker.h"
     #define wxFilePickerWidget      wxFileButton
     #define wxDirPickerWidget       wxDirButton


@@ -88,14 +141,15 @@ protected:
 
 
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------

-// wxFileDirPickerWidgetBase
+// wxFileDirPickerCtrlBase

 // ----------------------------------------------------------------------------
 
 class WXDLLIMPEXP_CORE wxFileDirPickerCtrlBase : public wxPickerBase
 {
 public:
 // ----------------------------------------------------------------------------
 
 class WXDLLIMPEXP_CORE wxFileDirPickerCtrlBase : public wxPickerBase
 {
 public:

-    wxFileDirPickerCtrlBase() : m_bIgnoreNextTextCtrlUpdate(false) {}
+    wxFileDirPickerCtrlBase() {}

 
 

+protected:

     // NB: no default values since this function will never be used
     //     directly by the user and derived classes wouldn't use them
     bool CreateBase(wxWindow *parent,
     // NB: no default values since this function will never be used
     //     directly by the user and derived classes wouldn't use them
     bool CreateBase(wxWindow *parent,


@@ -111,10 +165,15 @@ public:
 
 public:         // public API
 
 
 public:         // public API
 

-    wxString GetPath() const
-        { return ((wxFileDirPickerWidgetBase*)m_picker)->GetPath(); }
+    wxString GetPath() const;

     void SetPath(const wxString &str);
 
     void SetPath(const wxString &str);
 

+    // Set the directory to open the file browse dialog at initially.
+    void SetInitialDirectory(const wxString& dir)
+    {
+        m_pickerIface->SetInitialDirectory(dir);
+    }
+

 public:        // internal functions
 
     void UpdatePickerFromTextCtrl();
 public:        // internal functions
 
     void UpdatePickerFromTextCtrl();


@@ -123,27 +182,29 @@ public:        // internal functions
     // event handler for our picker
     void OnFileDirChange(wxFileDirPickerEvent &);
 
     // event handler for our picker
     void OnFileDirChange(wxFileDirPickerEvent &);
 

-    virtual bool CreatePicker(wxWindow *parent, const wxString& path,
-                      const wxString& message, const wxString& wildcard) = 0;
-
-    // Returns TRUE if the current path is a valid one
-    // (i.e. a valid file for a wxFilePickerWidget or a valid
-    //  folder for a wxDirPickerWidget).
-    virtual bool CheckPath(const wxString &str) const = 0;
-

     // TRUE if any textctrl change should update the current working directory
     virtual bool IsCwdToUpdate() const = 0;
 
     // Returns the event type sent by this picker
     virtual wxEventType GetEventType() const = 0;
 
     // TRUE if any textctrl change should update the current working directory
     virtual bool IsCwdToUpdate() const = 0;
 
     // Returns the event type sent by this picker
     virtual wxEventType GetEventType() const = 0;
 

+    virtual void DoConnect( wxControl *sender, wxFileDirPickerCtrlBase *eventSink ) = 0;
+

     // Returns the filtered value currently placed in the text control (if present).
     virtual wxString GetTextCtrlValue() const = 0;
 
 protected:
     // Returns the filtered value currently placed in the text control (if present).
     virtual wxString GetTextCtrlValue() const = 0;
 
 protected:

+    // creates the picker control
+    virtual
+    wxFileDirPickerWidgetBase *CreatePicker(wxWindow *parent,
+                                            const wxString& path,
+                                            const wxString& message,
+                                            const wxString& wildcard) = 0;

 
 

-    // true if the next UpdateTextCtrl() call is to ignore
-    bool m_bIgnoreNextTextCtrlUpdate;
+protected:
+
+    // m_picker object as wxFileDirPickerWidgetBase interface
+    wxFileDirPickerWidgetBase *m_pickerIface;

 };
 
 #endif  // wxUSE_FILEPICKERCTRL || wxUSE_DIRPICKERCTRL
 };
 
 #endif  // wxUSE_FILEPICKERCTRL || wxUSE_DIRPICKERCTRL


@@ -195,30 +256,15 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxFLP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxSize& size = wxDefaultSize,
                 long style = wxFLP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = wxFilePickerCtrlNameStr)
-    {
-        return wxFileDirPickerCtrlBase::CreateBase(parent, id, path,
-                                                   message, wildcard,
-                                                   pos, size, style,
-                                                   validator, name);
-    }
-
+                const wxString& name = wxFilePickerCtrlNameStr);

 
 

-public:     // overrides
+    void SetFileName(const wxFileName &filename)
+        { SetPath(filename.GetFullPath()); }

 
 

-    bool CreatePicker(wxWindow *parent, const wxString& path,
-                      const wxString& message, const wxString& wildcard)
-    {
-        m_picker = new wxFilePickerWidget(parent, wxID_ANY,
-                                          wxFilePickerWidgetLabel,
-                                          path, message, wildcard,
-                                          wxDefaultPosition, wxDefaultSize,
-                                          GetPickerStyle(GetWindowStyle()));
-        return true;
-    }
+    wxFileName GetFileName() const
+        { return wxFileName(GetPath()); }

 
 

-    // return true if the given path is valid for this control
-    bool CheckPath(const wxString& path) const;
+public:     // overrides

 
     // return the text control value in canonical form
     wxString GetTextCtrlValue() const;
 
     // return the text control value in canonical form
     wxString GetTextCtrlValue() const;


@@ -227,14 +273,40 @@ public:     // overrides
         { return HasFlag(wxFLP_CHANGE_DIR); }
 
     wxEventType GetEventType() const
         { return HasFlag(wxFLP_CHANGE_DIR); }
 
     wxEventType GetEventType() const

-        { return wxEVT_COMMAND_FILEPICKER_CHANGED; }
+        { return wxEVT_FILEPICKER_CHANGED; }
+
+    virtual void DoConnect( wxControl *sender, wxFileDirPickerCtrlBase *eventSink )
+    {
+        sender->Connect( wxEVT_FILEPICKER_CHANGED,
+            wxFileDirPickerEventHandler( wxFileDirPickerCtrlBase::OnFileDirChange ),
+            NULL, eventSink );
+    }
+

 
 protected:
 
 protected:

+    virtual
+    wxFileDirPickerWidgetBase *CreatePicker(wxWindow *parent,
+                                            const wxString& path,
+                                            const wxString& message,
+                                            const wxString& wildcard)
+    {
+        return new wxFilePickerWidget(parent, wxID_ANY,
+                                      wxGetTranslation(wxFilePickerWidgetLabel),
+                                      path, message, wildcard,
+                                      wxDefaultPosition, wxDefaultSize,
+                                      GetPickerStyle(GetWindowStyle()));
+    }
+

     // extracts the style for our picker from wxFileDirPickerCtrlBase's style
     long GetPickerStyle(long style) const
     {
     // extracts the style for our picker from wxFileDirPickerCtrlBase's style
     long GetPickerStyle(long style) const
     {

-        return (style & (wxFLP_OPEN|wxFLP_SAVE|wxFLP_OVERWRITE_PROMPT|
-                            wxFLP_FILE_MUST_EXIST|wxFLP_CHANGE_DIR));
+        return style & (wxFLP_OPEN |
+                        wxFLP_SAVE |
+                        wxFLP_OVERWRITE_PROMPT |
+                        wxFLP_FILE_MUST_EXIST |
+                        wxFLP_CHANGE_DIR |
+                        wxFLP_USE_TEXTCTRL |
+                        wxFLP_SMALL);

     }
 
 private:
     }
 
 private:


@@ -285,28 +357,15 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxDIRP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDIRP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = wxDirPickerCtrlNameStr)
-    {
-        return wxFileDirPickerCtrlBase::CreateBase
-               (
-                    parent, id, path, message, wxEmptyString,
-                    pos, size, style, validator, name
-               );
-    }
+                const wxString& name = wxDirPickerCtrlNameStr);

 
 

+    void SetDirName(const wxFileName &dirname)
+        { SetPath(dirname.GetPath()); }

 
 

-public:     // overrides
-
-    bool CreatePicker(wxWindow *parent, const wxString& path,
-                      const wxString& message, const wxString& WXUNUSED(wildcard))
-    {
-        m_picker = new wxDirPickerWidget(parent, wxID_ANY, wxDirPickerWidgetLabel,
-                                         path, message, wxDefaultPosition, wxDefaultSize,
-                                         GetPickerStyle(GetWindowStyle()));
-        return true;
-    }
+    wxFileName GetDirName() const
+        { return wxFileName::DirName(GetPath()); }

 
 

-    bool CheckPath(const wxString &path) const;
+public:     // overrides

 
     wxString GetTextCtrlValue() const;
 
 
     wxString GetTextCtrlValue() const;
 


@@ -314,77 +373,48 @@ public:     // overrides
         { return HasFlag(wxDIRP_CHANGE_DIR); }
 
     wxEventType GetEventType() const
         { return HasFlag(wxDIRP_CHANGE_DIR); }
 
     wxEventType GetEventType() const

-        { return wxEVT_COMMAND_DIRPICKER_CHANGED; }
-
-protected:
-    // extracts the style for our picker from wxFileDirPickerCtrlBase's style
-    long GetPickerStyle(long style) const
-        { return (style & (wxDIRP_DIR_MUST_EXIST|wxDIRP_CHANGE_DIR)); }
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxDirPickerCtrl)
-};
+        { return wxEVT_DIRPICKER_CHANGED; }

 
 

-#endif      // wxUSE_DIRPICKERCTRL
-
-
-#if wxUSE_FILEPICKERCTRL || wxUSE_DIRPICKERCTRL
-
-// ----------------------------------------------------------------------------
-// wxFileDirPickerEvent: used by wxFilePickerCtrl and wxDirPickerCtrl only
-// ----------------------------------------------------------------------------
+    virtual void DoConnect( wxControl *sender, wxFileDirPickerCtrlBase *eventSink )
+    {
+        sender->Connect( wxEVT_DIRPICKER_CHANGED,
+            wxFileDirPickerEventHandler( wxFileDirPickerCtrlBase::OnFileDirChange ),
+            NULL, eventSink );
+    }

 
 

-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, wxEVT_COMMAND_FILEPICKER_CHANGED, 1102)
-    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, wxEVT_COMMAND_DIRPICKER_CHANGED, 1103)
-END_DECLARE_EVENT_TYPES()

 
 

-class WXDLLIMPEXP_CORE wxFileDirPickerEvent : public wxCommandEvent
-{
-public:
-    wxFileDirPickerEvent() {}
-    wxFileDirPickerEvent(wxEventType type, wxObject *generator, int id, const wxString &path)
-        : wxCommandEvent(type, id),
-          m_path(path)
+protected:
+    virtual
+    wxFileDirPickerWidgetBase *CreatePicker(wxWindow *parent,
+                                            const wxString& path,
+                                            const wxString& message,
+                                            const wxString& WXUNUSED(wildcard))

     {
     {

-        SetEventObject(generator);
+        return new wxDirPickerWidget(parent, wxID_ANY,
+                                     wxGetTranslation(wxDirPickerWidgetLabel),
+                                     path, message,
+                                     wxDefaultPosition, wxDefaultSize,
+                                     GetPickerStyle(GetWindowStyle()));

     }
 
     }
 

-    wxString GetPath() const { return m_path; }
-    void SetPath(const wxString &p) { m_path = p; }
-
-    // default copy ctor, assignment operator and dtor are ok
-    virtual wxEvent *Clone() const { return new wxFileDirPickerEvent(*this); }
+    // extracts the style for our picker from wxFileDirPickerCtrlBase's style
+    long GetPickerStyle(long style) const
+    {
+        return style & (wxDIRP_DIR_MUST_EXIST |
+                        wxDIRP_CHANGE_DIR |
+                        wxDIRP_USE_TEXTCTRL |
+                        wxDIRP_SMALL);
+    }

 
 private:
 
 private:

-    wxString m_path;
-
-    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFileDirPickerEvent)
+    DECLARE_DYNAMIC_CLASS(wxDirPickerCtrl)

 };
 
 };
 

-// ----------------------------------------------------------------------------
-// event types and macros
-// ----------------------------------------------------------------------------
-
-typedef void (wxEvtHandler::*wxFileDirPickerEventFunction)(wxFileDirPickerEvent&);
-
-#define wxFileDirPickerEventHandler(func) \
-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFileDirPickerEventFunction, &func)
-
-#define EVT_FILEPICKER_CHANGED(id, fn) \
-    wx__DECLARE_EVT1(wxEVT_COMMAND_FILEPICKER_CHANGED, id, wxFileDirPickerEventHandler(fn))
-#define EVT_DIRPICKER_CHANGED(id, fn) \
-    wx__DECLARE_EVT1(wxEVT_COMMAND_DIRPICKER_CHANGED, id, wxFileDirPickerEventHandler(fn))
-
-#ifdef _WX_DEFINE_DATE_EVENTS_
-    DEFINE_EVENT_TYPE(wxEVT_COMMAND_FILEPICKER_CHANGED)
-    DEFINE_EVENT_TYPE(wxEVT_COMMAND_DIRPICKER_CHANGED)
-
-    IMPLEMENT_DYNAMIC_CLASS(wxFileDirPickerEvent, wxCommandEvent)
-#endif
-
+#endif      // wxUSE_DIRPICKERCTRL

 
 

-#endif // wxUSE_FILEPICKERCTRL || wxUSE_DIRPICKERCTRL
+// old wxEVT_COMMAND_* constants
+#define wxEVT_COMMAND_FILEPICKER_CHANGED   wxEVT_FILEPICKER_CHANGED
+#define wxEVT_COMMAND_DIRPICKER_CHANGED    wxEVT_DIRPICKER_CHANGED

 
 #endif // _WX_FILEDIRPICKER_H_BASE_
 
 
 #endif // _WX_FILEDIRPICKER_H_BASE_