X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e124873c5bd39ba8e9cc3c05ac7e4c97fbe59cd..341366c67a9af796d39e1f0af92635d47af5308f:/include/wx/mimetype.h diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h index 03445fa3da..28a529ddda 100644 --- a/include/wx/mimetype.h +++ b/include/wx/mimetype.h @@ -3,6 +3,7 @@ // Purpose: classes and functions to manage MIME types // Author: Vadim Zeitlin // Modified by: +// Chris Elliott (biol75@york.ac.uk) 5 Dec 00: write support for Win32 // Created: 23.09.98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin @@ -12,6 +13,11 @@ #ifndef _MIMETYPE_H #define _MIMETYPE_H +#ifdef __GNUG__ +#pragma interface "mimetypebase.h" +#endif + + // fwd decls class wxIcon; class wxFileTypeImpl; @@ -23,6 +29,9 @@ class wxMimeTypesManagerImpl; // the things we really need #include "wx/string.h" +#include "wx/dynarray.h" + +class wxMimeTypeCmnModule; // This class holds information about a given "file type". File type is the // same as MIME type under Unix, but under Windows it corresponds more to an @@ -32,7 +41,7 @@ class wxMimeTypesManagerImpl; // the accessors *must* be checked! class WXDLLEXPORT wxFileType { -friend wxMimeTypesManagerImpl; // it has access to m_impl +friend class WXDLLEXPORT wxMimeTypesManagerImpl; // it has access to m_impl public: // An object of this class must be passed to Get{Open|Print}Command. The @@ -69,11 +78,16 @@ public: // parameters are unchanged) // return the MIME type for this file type bool GetMimeType(wxString *mimeType) const; + bool GetMimeTypes(wxArrayString& mimeTypes) const; // fill passed in array with all extensions associated with this file // type bool GetExtensions(wxArrayString& extensions); - // get the icon corresponding to this file type - bool GetIcon(wxIcon *icon) const; + // get the icon corresponding to this file type, the name of the file + // where the icon resides is return in iconfile if !NULL and its index + // in this file (Win-only) is in iconIndex + bool GetIcon(wxIcon *icon, + wxString *iconFile = NULL, + int *iconIndex = NULL) const; // get a brief file type description ("*.txt" => "text document") bool GetDescription(wxString *desc) const; @@ -85,6 +99,39 @@ public: bool GetPrintCommand(wxString *printCmd, const MessageParameters& params) const; + + // return the number of commands defined for this file type, 0 if none + size_t GetAllCommands(wxArrayString *verbs, wxArrayString *commands, + const wxFileType::MessageParameters& params) const; + + // the methods which modify the system database are only implemented under + // Win32 so far (on other platforms they will just return FALSE) + // + // also, they should only be used with the objects created using + // wxMimeTypesManager::Associate() + + // set the command to be used for opening the file + bool SetOpenCommand(const wxString& cmd, bool overwriteprompt = TRUE); + + // set an arbitrary command, ask confirmation if it already exists and + // overwriteprompt is TRUE + bool SetCommand(const wxString& cmd, const wxString& verb, + bool overwriteprompt = TRUE); + + // set the MIME type for this filetype + bool SetMimeType(const wxString& mimeType); + // set the default icon for this filetype + bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0); + + // remove the association from the system database + bool Unassociate(); + + // delete registration info + bool RemoveOpenCommand(); + bool RemoveCommand(const wxString& verb); + bool RemoveMimeType(); + bool RemoveDefaultIcon(); + // operations // expand a string in the format of GetOpenCommand (which may contain // '%s' and '%t' format specificators for the file name and mime type @@ -148,6 +195,9 @@ private: wxArrayString m_exts; // the extensions which are mapped on this filetype }; +WX_DECLARE_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo); + + // This class accesses the information about all known MIME types and allows // the application to retrieve information (including how to handle data of // given type) about them. @@ -174,6 +224,7 @@ public: // deleting it. // get file type from file extension wxFileType *GetFileTypeFromExtension(const wxString& ext); + wxFileType *GetOrAllocateFileTypeFromExtension(const wxString& ext); // get file type from MIME type (in format /) wxFileType *GetFileTypeFromMimeType(const wxString& mimeType); @@ -190,6 +241,11 @@ public: // read in additional file in mime.types format bool ReadMimeTypes(const wxString& filename); + // enumerate all known MIME types + // + // returns the number of retrieved file types + size_t EnumAllFileTypes(wxArrayString& mimetypes); + // these functions can be used to provide default values for some of the // MIME types inside the program itself (you may also use // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to @@ -201,6 +257,14 @@ public: // The filetypes array should be terminated by a NULL entry void AddFallbacks(const wxFileTypeInfo *filetypes); + // create a new association between the given extension and MIME type and + // return the wxFileType object corresponding (which should be deleted by + // caller) or NULL if something went wrong + wxFileType *Associate(const wxString& ext, + const wxString& mimeType, + const wxString& filetype = wxEmptyString, + const wxString& desc = wxEmptyString); + // dtor (not virtual, shouldn't be derived from) ~wxMimeTypesManager(); @@ -210,8 +274,21 @@ private: wxMimeTypesManager& operator=(const wxMimeTypesManager&); wxMimeTypesManagerImpl *m_impl; + + // if m_impl is NULL, create one + void EnsureImpl(); + + friend class wxMimeTypeCmnModule; }; + +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +// the default mime manager for wxWindows programs +WXDLLEXPORT_DATA(extern wxMimeTypesManager *) wxTheMimeTypesManager; + #endif // wxUSE_FILE