wxWidgets/include/wx/filedlg.h

352 lines
12 KiB
C++

/////////////////////////////////////////////////////////////////////////////
// Name: wx/filedlg.h
// Purpose: wxFileDialog base header
// Author: Robert Roebling
// Modified by:
// Created: 8/17/99
// Copyright: (c) Robert Roebling
// RCS-ID: $Id$
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_FILEDLG_H_BASE_
#define _WX_FILEDLG_H_BASE_
#include "wx/defs.h"
#if wxUSE_FILEDLG
#include "wx/dialog.h"
#include "wx/arrstr.h"
//----------------------------------------------------------------------------
// wxFileDialog data
//----------------------------------------------------------------------------
/*
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
{
wxFD_OPEN = 0x0001,
wxFD_SAVE = 0x0002,
wxFD_OVERWRITE_PROMPT = 0x0004,
wxFD_FILE_MUST_EXIST = 0x0010,
wxFD_MULTIPLE = 0x0020,
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[];
extern WXDLLEXPORT_DATA(const wxChar) wxFileSelectorPromptStr[];
extern WXDLLEXPORT_DATA(const wxChar) wxFileSelectorDefaultWildcardStr[];
//----------------------------------------------------------------------------
// wxFileDialogBase
//----------------------------------------------------------------------------
class WXDLLEXPORT wxFileDialogBase: public wxDialog
{
public:
wxFileDialogBase () { Init(); }
wxFileDialogBase(wxWindow *parent,
const wxString& message = wxFileSelectorPromptStr,
const wxString& defaultDir = wxEmptyString,
const wxString& defaultFile = wxEmptyString,
const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
long style = wxFD_DEFAULT_STYLE,
const wxPoint& pos = wxDefaultPosition,
const wxSize& sz = wxDefaultSize,
const wxString& name = wxFileDialogNameStr)
{
Init();
Create(parent, message, defaultDir, defaultFile, wildCard, style, pos, sz, name);
}
bool Create(wxWindow *parent,
const wxString& message = wxFileSelectorPromptStr,
const wxString& defaultDir = wxEmptyString,
const wxString& defaultFile = wxEmptyString,
const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
long style = wxFD_DEFAULT_STYLE,
const wxPoint& pos = wxDefaultPosition,
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 SetFilename(const wxString& name) { m_fileName = name; }
virtual void SetWildcard(const wxString& wildCard) { m_wildCard = wildCard; }
virtual void SetFilterIndex(int filterIndex) { m_filterIndex = filterIndex; }
virtual wxString GetMessage() const { return m_message; }
virtual wxString GetPath() const { return m_path; }
virtual void GetPaths(wxArrayString& paths) const { paths.Empty(); paths.Add(m_path); }
virtual wxString GetDirectory() const { return m_dir; }
virtual wxString GetFilename() const { return m_fileName; }
virtual void GetFilenames(wxArrayString& files) const { files.Empty(); files.Add(m_fileName); }
virtual wxString GetWildcard() const { return m_wildCard; }
virtual int GetFilterIndex() const { return m_filterIndex; }
// Utility functions
#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
// if filePath = "foo[.]" and extensionList = "*.jpg;*.png" return "foo.jpg"
// if the extension is "*.j?g" (has wildcards) or "jpg" then return filePath
static wxString AppendExtension(const wxString &filePath,
const wxString &extensionList);
protected:
wxString m_message;
wxString m_dir;
wxString m_path; // Full path
wxString m_fileName;
wxString m_wildCard;
int m_filterIndex;
private:
void Init();
DECLARE_DYNAMIC_CLASS(wxFileDialogBase)
DECLARE_NO_COPY_CLASS(wxFileDialogBase)
};
//----------------------------------------------------------------------------
// wxFileDialog convenience functions
//----------------------------------------------------------------------------
// 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
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 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
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,
const wxString& wildcard = wxFileSelectorDefaultWildcardStr,
int flags = 0,
wxWindow *parent = NULL,
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
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
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__)
#define wxUSE_GENERIC_FILEDIALOG
#include "wx/generic/filedlgg.h"
#elif defined(__WXMSW__)
#include "wx/msw/filedlg.h"
#elif defined(__WXMOTIF__)
#include "wx/motif/filedlg.h"
#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"
#elif defined(__WXMAC__)
#include "wx/mac/filedlg.h"
#elif defined(__WXCOCOA__)
#include "wx/cocoa/filedlg.h"
#elif defined(__WXPM__)
#include "wx/os2/filedlg.h"
#endif
#endif // wxUSE_FILEDLG
#endif // _WX_FILEDLG_H_BASE_