X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/da61ab3189f71a2b0913bac13c48755c5d038037..94799627ee0ad217b2fc41df5bd5bccf59494e00:/include/wx/mimetype.h diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h index 18680f3afc..dcd26cafa4 100644 --- a/include/wx/mimetype.h +++ b/include/wx/mimetype.h @@ -9,16 +9,28 @@ // Licence: wxWindows license (part of wxExtra library) ///////////////////////////////////////////////////////////////////////////// -#ifndef _MIMETYPE_H -#define _MIMETYPE_H +#ifndef _MIMETYPE_H +#define _MIMETYPE_H + +#ifdef __GNUG__ +#pragma interface "mimetypebase.h" +#endif + // fwd decls class wxIcon; class wxFileTypeImpl; class wxMimeTypesManagerImpl; +#include "wx/defs.h" + +#if wxUSE_FILE + // 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 @@ -26,9 +38,9 @@ class wxMimeTypesManagerImpl; // file type). This object may be created in many different ways and depending // on how it was created some fields may be unknown so the return value of all // the accessors *must* be checked! -class wxFileType +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 @@ -65,6 +77,7 @@ 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); @@ -102,12 +115,57 @@ private: wxFileTypeImpl *m_impl; }; +// This class is only used wuth wxMimeTypesManager::AddFallbacks() and is meant +// just as the container for the wxFileType data. +class WXDLLEXPORT wxFileTypeInfo +{ +public: + // ctors + // a normal item + wxFileTypeInfo(const char *mimeType, + const char *openCmd, + const char *printCmd, + const char *desc, + // the other parameters form a NULL terminated list of + // extensions + ...); + + // invalid item - use this to terminate the array passed to + // wxMimeTypesManager::AddFallbacks + wxFileTypeInfo() { } + + bool IsValid() const { return !m_mimeType.IsEmpty(); } + + // accessors + // get the MIME type + const wxString& GetMimeType() const { return m_mimeType; } + // get the open command + const wxString& GetOpenCommand() const { return m_openCmd; } + // get the print command + const wxString& GetPrintCommand() const { return m_printCmd; } + // get the description + const wxString& GetDescription() const { return m_desc; } + // get the array of all extensions + const wxArrayString& GetExtensions() const { return m_exts; } + +private: + wxString m_mimeType, // the MIME type in "type/subtype" form + m_openCmd, // command to use for opening the file (%s allowed) + m_printCmd, // command to use for printing the file (%s allowed) + m_desc; // a free form description of this file type + + 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. // // NB: currently it doesn't support modifying MIME database (read-only access). -class wxMimeTypesManager +class WXDLLEXPORT wxMimeTypesManager { public: // static helper functions @@ -131,12 +189,34 @@ public: // get file type from MIME type (in format /) wxFileType *GetFileTypeFromMimeType(const wxString& mimeType); - // other operations + // other operations: return TRUE if there were no errors or FALSE if there + // were some unreckognized entries (the good entries are always read anyhow) // read in additional file (the standard ones are read automatically) // in mailcap format (see mimetype.cpp for description) - void ReadMailcap(const wxString& filename); + // + // 'fallback' parameter may be set to TRUE to avoid overriding the + // settings from other, previously parsed, files by this one: normally, + // the files read most recently would override the older files, but with + // fallback == TRUE this won't happen + bool ReadMailcap(const wxString& filename, bool fallback = FALSE); // read in additional file in mime.types format - void ReadMimeTypes(const wxString& filename); + 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 + // achieve the same goal, but this requires having this info in a file). + // + // It isn't possible (currently) to provide fallback icons using this + // function. + // + // The filetypes array should be terminated by a NULL entry + void AddFallbacks(const wxFileTypeInfo *filetypes); // dtor (not virtual, shouldn't be derived from) ~wxMimeTypesManager(); @@ -147,8 +227,25 @@ private: wxMimeTypesManager& operator=(const wxMimeTypesManager&); wxMimeTypesManagerImpl *m_impl; + + // if m_impl is NULL, create one + void EnsureImpl(); + + friend class wxMimeTypeCmnModule; }; -#endif //_MIMETYPE_H + +// ---------------------------------------------------------------------------- +// global variables +// ---------------------------------------------------------------------------- + +// the default mime manager for wxWindows programs +WXDLLEXPORT_DATA(extern wxMimeTypesManager *) wxTheMimeTypesManager; + +#endif + // wxUSE_FILE + +#endif + //_MIMETYPE_H /* vi: set cin tw=80 ts=4 sw=4: */