dont use wxChar* arguments in wxHTML API

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

diff --git a/include/wx/filedlg.h b/include/wx/filedlg.h
index 535380397476dc246153ce42d701848b47ed089e..eebb5c93a6f17c6dbfb525bb2b5964a668d0072d 100644 (file)
--- a/include/wx/filedlg.h
+++ b/include/wx/filedlg.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        filedlg.h
+// Name:        wx/filedlg.h

 // Purpose:     wxFileDialog base header
 // Author:      Robert Roebling
 // Modified by:
 // Purpose:     wxFileDialog base header
 // Author:      Robert Roebling
 // Modified by:


@@ -23,20 +23,15 @@
 // wxFileDialog data
 //----------------------------------------------------------------------------
 
 // wxFileDialog data
 //----------------------------------------------------------------------------
 

-#if WXWIN_COMPATIBILITY_2_6
-enum
-{
-    wxOPEN              = 0x0001,
-    wxSAVE              = 0x0002,
-    wxOVERWRITE_PROMPT  = 0x0004,
-#if WXWIN_COMPATIBILITY_2_4
-    wxHIDE_READONLY     = 0x0008,
-#endif
-    wxFILE_MUST_EXIST   = 0x0010,
-    wxMULTIPLE          = 0x0020,
-    wxCHANGE_DIR        = 0x0040
-};
-#endif
+/*
+    The flags below must coexist with the following flags in m_windowStyle
+    #define wxCAPTION               0x20000000
+    #define wxMAXIMIZE              0x00002000
+    #define wxCLOSE_BOX             0x00001000
+    #define wxSYSTEM_MENU           0x00000800
+    wxBORDER_NONE   =               0x00200000
+    #define wxRESIZE_BORDER         0x00000040
+*/

 
 enum
 {
 
 enum
 {


@@ -45,9 +40,22 @@ enum
     wxFD_OVERWRITE_PROMPT  = 0x0004,
     wxFD_FILE_MUST_EXIST   = 0x0010,
     wxFD_MULTIPLE          = 0x0020,
     wxFD_OVERWRITE_PROMPT  = 0x0004,
     wxFD_FILE_MUST_EXIST   = 0x0010,
     wxFD_MULTIPLE          = 0x0020,

-    wxFD_CHANGE_DIR        = 0x0040
+    wxFD_CHANGE_DIR        = 0x0080,
+    wxFD_PREVIEW           = 0x0100

 };
 
 };
 

+#if WXWIN_COMPATIBILITY_2_6
+enum
+{
+    wxOPEN              = wxFD_OPEN,
+    wxSAVE              = wxFD_SAVE,
+    wxOVERWRITE_PROMPT  = wxFD_OVERWRITE_PROMPT,
+    wxFILE_MUST_EXIST   = wxFD_FILE_MUST_EXIST,
+    wxMULTIPLE          = wxFD_MULTIPLE,
+    wxCHANGE_DIR        = wxFD_CHANGE_DIR
+};
+#endif
+

 #define wxFD_DEFAULT_STYLE      wxFD_OPEN
 
 extern WXDLLEXPORT_DATA(const wxChar) wxFileDialogNameStr[];
 #define wxFD_DEFAULT_STYLE      wxFD_OPEN
 
 extern WXDLLEXPORT_DATA(const wxChar) wxFileDialogNameStr[];


@@ -87,6 +95,8 @@ public:
                 const wxSize& sz = wxDefaultSize,
                 const wxString& name = wxFileDialogNameStr);
 
                 const wxSize& sz = wxDefaultSize,
                 const wxString& name = wxFileDialogNameStr);
 

+    bool HasFdFlag(int flag) const { return HasFlag(flag); }
+

     virtual void SetMessage(const wxString& message) { m_message = message; }
     virtual void SetPath(const wxString& path) { m_path = path; }
     virtual void SetDirectory(const wxString& dir) { m_dir = dir; }
     virtual void SetMessage(const wxString& message) { m_message = message; }
     virtual void SetPath(const wxString& path) { m_path = path; }
     virtual void SetDirectory(const wxString& dir) { m_dir = dir; }


@@ -105,16 +115,13 @@ public:
 
     // Utility functions
 
 
     // Utility functions
 

-#if WXWIN_COMPATIBILITY_2_4
-    // Parses the wildCard, returning the number of filters.
-    // Returns 0 if none or if there's a problem,
-    // The arrays will contain an equal number of items found before the error.
-    // wildCard is in the form:
-    // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
-    wxDEPRECATED( static int ParseWildcard(const wxString& wildCard,
-                                           wxArrayString& descriptions,
-                                           wxArrayString& filters) );
-#endif // WXWIN_COMPATIBILITY_2_4
+#if WXWIN_COMPATIBILITY_2_6
+
+    wxDEPRECATED( long GetStyle() const );
+    wxDEPRECATED( void SetStyle(long style) );
+
+#endif  // WXWIN_COMPATIBILITY_2_6
+

 
     // Append first extension to filePath from a ';' separated extensionList
     // if filePath = "path/foo.bar" just return it as is
 
     // Append first extension to filePath from a ';' separated extensionList
     // if filePath = "path/foo.bar" just return it as is


@@ -141,44 +148,184 @@ private:
 // wxFileDialog convenience functions
 //----------------------------------------------------------------------------
 
 // wxFileDialog convenience functions
 //----------------------------------------------------------------------------
 

-// File selector - backward compatibility
+// NB: wxFileSelector() etc. used to take const wxChar* arguments in wx-2.8
+//     and their default value was NULL. The official way to use these
+//     functions is to use wxString, with wxEmptyString as the default value.
+//     The templates below exist only to maintain compatibility with wx-2.8.
+
+#if WXWIN_COMPATIBILITY_2_8
+// return wxString created from the argument, return empty string if the
+// argument is NULL:
+inline wxString wxPtrOrStringToString(const wxString& s) { return s; }
+inline wxString wxPtrOrStringToString(const char *s) { return s; }
+inline wxString wxPtrOrStringToString(const wchar_t *s) { return s; }
+inline wxString wxPtrOrStringToString(const wxCStrData& s) { return s; }
+inline wxString wxPtrOrStringToString(const wxCharBuffer& s) { return s; }
+inline wxString wxPtrOrStringToString(const wxWCharBuffer& s) { return s; }
+// this one is for NULL:
+inline wxString wxPtrOrStringToString(int s)
+{
+    wxASSERT_MSG( s == 0, _T("passing non-NULL int as string?") );
+    return wxEmptyString;
+}
+#endif // WXWIN_COMPATIBILITY_2_8
+
+WXDLLEXPORT wxString
+wxDoFileSelector(const wxString& message = wxFileSelectorPromptStr,
+                 const wxString& default_path = wxEmptyString,
+                 const wxString& default_filename = wxEmptyString,
+                 const wxString& default_extension = wxEmptyString,
+                 const wxString& wildcard = wxFileSelectorDefaultWildcardStr,
+                 int flags = 0,
+                 wxWindow *parent = NULL,
+                 int x = wxDefaultCoord, int y = wxDefaultCoord);
+
+WXDLLEXPORT wxString
+wxDoFileSelectorEx(const wxString& message = wxFileSelectorPromptStr,
+                   const wxString& default_path = wxEmptyString,
+                   const wxString& default_filename = wxEmptyString,
+                   int *indexDefaultExtension = NULL,
+                   const wxString& wildcard = wxFileSelectorDefaultWildcardStr,
+                   int flags = 0,
+                   wxWindow *parent = NULL,
+                   int x = wxDefaultCoord, int y = wxDefaultCoord);
+
+WXDLLEXPORT wxString
+wxDoLoadFileSelector(const wxString& what,
+                     const wxString& extension,
+                     const wxString& default_name = wxEmptyString,
+                     wxWindow *parent = NULL);
+

 WXDLLEXPORT wxString
 WXDLLEXPORT wxString

-wxFileSelector(const wxChar *message = wxFileSelectorPromptStr,
-               const wxChar *default_path = NULL,
-               const wxChar *default_filename = NULL,
-               const wxChar *default_extension = NULL,
-               const wxChar *wildcard = wxFileSelectorDefaultWildcardStr,
+wxDoSaveFileSelector(const wxString& what,
+                     const wxString& extension,
+                     const wxString& default_name = wxEmptyString,
+                     wxWindow *parent = NULL);
+
+#if WXWIN_COMPATIBILITY_2_8
+
+// File selector - backward compatibility
+inline wxString wxFileSelector()
+{
+    return wxDoFileSelector();
+}
+
+inline wxString wxFileSelector(const wxString& message)
+{
+    return wxDoFileSelector(message);
+}
+
+template<typename T>
+inline wxString wxFileSelector(const wxString& message, const T& default_path)
+{
+    return wxDoFileSelector(message, wxPtrOrStringToString(default_path));
+}
+
+template<typename T1, typename T2>
+inline wxString wxFileSelector(const wxString& message,
+                               const T1& default_path,
+                               const T2& default_filename)
+{
+    return wxDoFileSelector(message,
+                            wxPtrOrStringToString(default_path),
+                            wxPtrOrStringToString(default_filename));
+}
+
+template<typename T1, typename T2, typename T3>
+inline wxString
+wxFileSelector(const wxString& message,
+               const T1& default_path,
+               const T2& default_filename,
+               const T3& default_extension,
+               const wxString& wildcard = wxFileSelectorDefaultWildcardStr,

                int flags = 0,
                wxWindow *parent = NULL,
                int flags = 0,
                wxWindow *parent = NULL,

-               int x = wxDefaultCoord, int y = wxDefaultCoord);
+               int x = wxDefaultCoord, int y = wxDefaultCoord)
+{
+    return wxDoFileSelector(message,
+                            wxPtrOrStringToString(default_path),
+                            wxPtrOrStringToString(default_filename),
+                            wxPtrOrStringToString(default_extension),
+                            wildcard,
+                            flags,
+                            parent,
+                            x, y);
+}

 
 // An extended version of wxFileSelector
 
 // An extended version of wxFileSelector

-WXDLLEXPORT wxString
-wxFileSelectorEx(const wxChar *message = wxFileSelectorPromptStr,
-                 const wxChar *default_path = NULL,
-                 const wxChar *default_filename = NULL,
+inline wxString wxFileSelectorEx()
+{
+    return wxDoFileSelectorEx();
+}
+
+inline wxString wxFileSelectorEx(const wxString& message)
+{
+    return wxDoFileSelectorEx(message);
+}
+
+template<typename T>
+inline wxString wxFileSelectorEx(const wxString& message, const T& default_path)
+{
+    return wxDoFileSelectorEx(message, wxPtrOrStringToString(default_path));
+}
+
+template<typename T1, typename T2>
+inline wxString
+wxFileSelectorEx(const wxString& message,
+                 const T1& default_path,
+                 const T2& default_filename,

                  int *indexDefaultExtension = NULL,
                  int *indexDefaultExtension = NULL,

-                 const wxChar *wildcard = wxFileSelectorDefaultWildcardStr,
+                 const wxString& wildcard = wxFileSelectorDefaultWildcardStr,

                  int flags = 0,
                  wxWindow *parent = NULL,
                  int flags = 0,
                  wxWindow *parent = NULL,

-                 int x = wxDefaultCoord, int y = wxDefaultCoord);
+                 int x = wxDefaultCoord, int y = wxDefaultCoord)
+{
+    return wxDoFileSelectorEx(message,
+                              wxPtrOrStringToString(default_path),
+                              wxPtrOrStringToString(default_filename),
+                              indexDefaultExtension,
+                              wildcard,
+                              flags,
+                              parent,
+                              x, y);
+}

 
 // Ask for filename to load
 
 // Ask for filename to load

-WXDLLEXPORT wxString
-wxLoadFileSelector(const wxChar *what,
-                   const wxChar *extension,
-                   const wxChar *default_name = (const wxChar *)NULL,
-                   wxWindow *parent = (wxWindow *) NULL);
+template<typename T>
+inline wxString wxLoadFileSelector(const wxString& what,
+                                   const wxString& extension,
+                                   const T& default_name = T(),
+                                   wxWindow *parent = NULL)
+{
+    return wxDoLoadFileSelector(what, extension,
+                                wxPtrOrStringToString(default_name),
+                                parent);
+}

 
 // Ask for filename to save
 
 // Ask for filename to save

-WXDLLEXPORT wxString
-wxSaveFileSelector(const wxChar *what,
-                   const wxChar *extension,
-                   const wxChar *default_name = (const wxChar *) NULL,
-                   wxWindow *parent = (wxWindow *) NULL);
+template<typename T>
+inline wxString wxSaveFileSelector(const wxString& what,
+                                   const wxString& extension,
+                                   const T& default_name = T(),
+                                   wxWindow *parent = NULL)
+{
+    return wxDoSaveFileSelector(what, extension,
+                                wxPtrOrStringToString(default_name),
+                                parent);
+}
+
+#else // !WXWIN_COMPATIBILITY_2_8
+
+#define wxFileSelector wxDoFileSelector
+#define wxFileSelectorEx wxDoFileSelectorEx
+#define wxLoadFileSelector wxDoLoadFileSelector
+#define wxSaveFileSelector wxDoSaveFileSelector
+
+#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8

 
 
 #if defined (__WXUNIVERSAL__)
 
 
 #if defined (__WXUNIVERSAL__)

+#define wxUSE_GENERIC_FILEDIALOG

 #include "wx/generic/filedlgg.h"
 #elif defined(__WXMSW__)
 #include "wx/msw/filedlg.h"
 #include "wx/generic/filedlgg.h"
 #elif defined(__WXMSW__)
 #include "wx/msw/filedlg.h"


@@ -187,13 +334,10 @@ wxSaveFileSelector(const wxChar *what,
 #elif defined(__WXGTK24__)
 #include "wx/gtk/filedlg.h"     // GTK+ > 2.4 has native version
 #elif defined(__WXGTK20__)
 #elif defined(__WXGTK24__)
 #include "wx/gtk/filedlg.h"     // GTK+ > 2.4 has native version
 #elif defined(__WXGTK20__)

+#define wxUSE_GENERIC_FILEDIALOG

 #include "wx/generic/filedlgg.h"
 #elif defined(__WXGTK__)
 #include "wx/gtk1/filedlg.h"
 #include "wx/generic/filedlgg.h"
 #elif defined(__WXGTK__)
 #include "wx/gtk1/filedlg.h"

-#elif defined(__WXX11__)
-#include "wx/generic/filedlgg.h"
-#elif defined(__WXMGL__)
-#include "wx/generic/filedlgg.h"

 #elif defined(__WXMAC__)
 #include "wx/mac/filedlg.h"
 #elif defined(__WXCOCOA__)
 #elif defined(__WXMAC__)
 #include "wx/mac/filedlg.h"
 #elif defined(__WXCOCOA__)