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