include/wx/filedlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/filedlg.h
   3 // Purpose:     wxFileDialog base header
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // Created:     8/17/99
   7 // Copyright:   (c) Robert Roebling
   8 // RCS-ID:      $Id$
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FILEDLG_H_BASE_
  13 #define _WX_FILEDLG_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_FILEDLG
  18
  19 #include "wx/dialog.h"
  20 #include "wx/arrstr.h"
  21
  22 //----------------------------------------------------------------------------
  23 // wxFileDialog data
  24 //----------------------------------------------------------------------------
  25
  26 /*
  27     The flags below must coexist with the following flags in m_windowStyle
  28     #define wxCAPTION               0x20000000
  29     #define wxMAXIMIZE              0x00002000
  30     #define wxCLOSE_BOX             0x00001000
  31     #define wxSYSTEM_MENU           0x00000800
  32     wxBORDER_NONE   =               0x00200000
  33     #define wxRESIZE_BORDER         0x00000040
  34 */
  35
  36 enum
  37 {
  38     wxFD_OPEN              = 0x0001,
  39     wxFD_SAVE              = 0x0002,
  40     wxFD_OVERWRITE_PROMPT  = 0x0004,
  41     wxFD_FILE_MUST_EXIST   = 0x0010,
  42     wxFD_MULTIPLE          = 0x0020,
  43     wxFD_CHANGE_DIR        = 0x0080,
  44     wxFD_PREVIEW           = 0x0100
  45 };
  46
  47 #if WXWIN_COMPATIBILITY_2_6
  48 enum
  49 {
  50     wxOPEN              = wxFD_OPEN,
  51     wxSAVE              = wxFD_SAVE,
  52     wxOVERWRITE_PROMPT  = wxFD_OVERWRITE_PROMPT,
  53     wxFILE_MUST_EXIST   = wxFD_FILE_MUST_EXIST,
  54     wxMULTIPLE          = wxFD_MULTIPLE,
  55     wxCHANGE_DIR        = wxFD_CHANGE_DIR
  56 };
  57 #endif
  58
  59 #define wxFD_DEFAULT_STYLE      wxFD_OPEN
  60
  61 extern WXDLLIMPEXP_DATA_CORE(const char) wxFileDialogNameStr[];
  62 extern WXDLLIMPEXP_DATA_CORE(const char) wxFileSelectorPromptStr[];
  63 extern WXDLLIMPEXP_DATA_CORE(const char) wxFileSelectorDefaultWildcardStr[];
  64
  65 //----------------------------------------------------------------------------
  66 // wxFileDialogBase
  67 //----------------------------------------------------------------------------
  68
  69 class WXDLLIMPEXP_CORE wxFileDialogBase: public wxDialog
  70 {
  71 public:
  72     wxFileDialogBase () { Init(); }
  73
  74     wxFileDialogBase(wxWindow *parent,
  75                      const wxString& message = wxFileSelectorPromptStr,
  76                      const wxString& defaultDir = wxEmptyString,
  77                      const wxString& defaultFile = wxEmptyString,
  78                      const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
  79                      long style = wxFD_DEFAULT_STYLE,
  80                      const wxPoint& pos = wxDefaultPosition,
  81                      const wxSize& sz = wxDefaultSize,
  82                      const wxString& name = wxFileDialogNameStr)
  83     {
  84         Init();
  85         Create(parent, message, defaultDir, defaultFile, wildCard, style, pos, sz, name);
  86     }
  87
  88     virtual ~wxFileDialogBase() {}
  89
  90
  91     bool Create(wxWindow *parent,
  92                 const wxString& message = wxFileSelectorPromptStr,
  93                 const wxString& defaultDir = wxEmptyString,
  94                 const wxString& defaultFile = wxEmptyString,
  95                 const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
  96                 long style = wxFD_DEFAULT_STYLE,
  97                 const wxPoint& pos = wxDefaultPosition,
  98                 const wxSize& sz = wxDefaultSize,
  99                 const wxString& name = wxFileDialogNameStr);
 100
 101     bool HasFdFlag(int flag) const { return HasFlag(flag); }
 102
 103     virtual void SetMessage(const wxString& message) { m_message = message; }
 104     virtual void SetPath(const wxString& path) { m_path = path; }
 105     virtual void SetDirectory(const wxString& dir) { m_dir = dir; }
 106     virtual void SetFilename(const wxString& name) { m_fileName = name; }
 107     virtual void SetWildcard(const wxString& wildCard) { m_wildCard = wildCard; }
 108     virtual void SetFilterIndex(int filterIndex) { m_filterIndex = filterIndex; }
 109
 110     virtual wxString GetMessage() const { return m_message; }
 111     virtual wxString GetPath() const { return m_path; }
 112     virtual void GetPaths(wxArrayString& paths) const { paths.Empty(); paths.Add(m_path); }
 113     virtual wxString GetDirectory() const { return m_dir; }
 114     virtual wxString GetFilename() const { return m_fileName; }
 115     virtual void GetFilenames(wxArrayString& files) const { files.Empty(); files.Add(m_fileName); }
 116     virtual wxString GetWildcard() const { return m_wildCard; }
 117     virtual int GetFilterIndex() const { return m_filterIndex; }
 118
 119     // this function is called with wxFileDialog as parameter and should
 120     // create the window containing the extra controls we want to show in it
 121     typedef wxWindow *(*ExtraControlCreatorFunction)(wxWindow*);
 122
 123     // extra controls are currently supported in GTK and generic versions
 124     // only currently
 125     virtual bool SupportsExtraControl() const { return false; }
 126
 127     bool SetExtraControlCreator(ExtraControlCreatorFunction WXUNUSED(c));
 128     wxWindow *GetExtraControl() const { return m_extraControl; }
 129
 130     // Utility functions
 131
 132 #if WXWIN_COMPATIBILITY_2_6
 133
 134     wxDEPRECATED( long GetStyle() const );
 135     wxDEPRECATED( void SetStyle(long style) );
 136
 137 #endif  // WXWIN_COMPATIBILITY_2_6
 138
 139
 140     // Append first extension to filePath from a ';' separated extensionList
 141     // if filePath = "path/foo.bar" just return it as is
 142     // if filePath = "foo[.]" and extensionList = "*.jpg;*.png" return "foo.jpg"
 143     // if the extension is "*.j?g" (has wildcards) or "jpg" then return filePath
 144     static wxString AppendExtension(const wxString &filePath,
 145                                     const wxString &extensionList);
 146
 147 protected:
 148     wxString      m_message;
 149     wxString      m_dir;
 150     wxString      m_path;       // Full path
 151     wxString      m_fileName;
 152     wxString      m_wildCard;
 153     int           m_filterIndex;
 154     wxWindow*     m_extraControl;
 155
 156     // returns true if control is created (if it already exists returns false)
 157     bool CreateExtraControl();
 158
 159 private:
 160     ExtraControlCreatorFunction m_extraControlCreator;
 161
 162     void Init();
 163     DECLARE_DYNAMIC_CLASS(wxFileDialogBase)
 164     DECLARE_NO_COPY_CLASS(wxFileDialogBase)
 165 };
 166
 167
 168 //----------------------------------------------------------------------------
 169 // wxFileDialog convenience functions
 170 //----------------------------------------------------------------------------
 171
 172 // File selector - backward compatibility
 173 WXDLLIMPEXP_CORE wxString
 174 wxFileSelector(const wxString& message = wxFileSelectorPromptStr,
 175                const wxString& default_path = wxEmptyString,
 176                const wxString& default_filename = wxEmptyString,
 177                const wxString& default_extension = wxEmptyString,
 178                const wxString& wildcard = wxFileSelectorDefaultWildcardStr,
 179                int flags = 0,
 180                wxWindow *parent = NULL,
 181                int x = wxDefaultCoord, int y = wxDefaultCoord);
 182
 183 // An extended version of wxFileSelector
 184 WXDLLIMPEXP_CORE wxString
 185 wxFileSelectorEx(const wxString& message = wxFileSelectorPromptStr,
 186                  const wxString& default_path = wxEmptyString,
 187                  const wxString& default_filename = wxEmptyString,
 188                  int *indexDefaultExtension = NULL,
 189                  const wxString& wildcard = wxFileSelectorDefaultWildcardStr,
 190                  int flags = 0,
 191                  wxWindow *parent = NULL,
 192                  int x = wxDefaultCoord, int y = wxDefaultCoord);
 193
 194 // Ask for filename to load
 195 WXDLLIMPEXP_CORE wxString
 196 wxLoadFileSelector(const wxString& what,
 197                    const wxString& extension,
 198                    const wxString& default_name = wxEmptyString,
 199                    wxWindow *parent = NULL);
 200
 201 // Ask for filename to save
 202 WXDLLIMPEXP_CORE wxString
 203 wxSaveFileSelector(const wxString& what,
 204                    const wxString& extension,
 205                    const wxString& default_name = wxEmptyString,
 206                    wxWindow *parent = NULL);
 207
 208
 209 #if defined (__WXUNIVERSAL__)
 210     #define wxHAS_GENERIC_FILEDIALOG
 211     #include "wx/generic/filedlgg.h"
 212 #elif defined(__WXMSW__)
 213     #include "wx/msw/filedlg.h"
 214 #elif defined(__WXMOTIF__)
 215     #include "wx/motif/filedlg.h"
 216 #elif defined(__WXGTK20__)
 217     #include "wx/gtk/filedlg.h"     // GTK+ > 2.4 has native version
 218 #elif defined(__WXGTK__)
 219     #include "wx/gtk1/filedlg.h"
 220 #elif defined(__WXMAC__)
 221     #include "wx/osx/filedlg.h"
 222 #elif defined(__WXCOCOA__)
 223     #include "wx/cocoa/filedlg.h"
 224 #elif defined(__WXPM__)
 225     #include "wx/os2/filedlg.h"
 226 #elif defined(__WXPALMOS__)
 227     #define wxHAS_GENERIC_FILEDIALOG
 228     #include "wx/generic/filedlgg.h"
 229 #endif
 230
 231 #endif // wxUSE_FILEDLG
 232
 233 #endif // _WX_FILEDLG_H_BASE_