*** empty log message ***

[wxWidgets.git] / include / wx / mimetype.h

diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h
index d79caf78af519d562843cfc8e0e1341935149302..70d3342c60044d1f9902fdfccca98ae86ab4f952 100644 (file)
--- a/include/wx/mimetype.h
+++ b/include/wx/mimetype.h
@@ -9,14 +9,18 @@
 // Licence:     wxWindows license (part of wxExtra library)
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license (part of wxExtra library)
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef   _MIMETYPE_H
-#define   _MIMETYPE_H
+#ifndef _MIMETYPE_H
+#define _MIMETYPE_H

 
 // fwd decls
 class wxIcon;
 class wxFileTypeImpl;
 class wxMimeTypesManagerImpl;
 
 
 // fwd decls
 class wxIcon;
 class wxFileTypeImpl;
 class wxMimeTypesManagerImpl;
 

+#include "wx/defs.h"
+
+#if wxUSE_FILE
+

 // the things we really need
 #include "wx/string.h"
 
 // the things we really need
 #include "wx/string.h"
 


@@ -26,9 +30,13 @@ 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!
 // 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

 {
 {

+#ifdef __MWERKS__
+friend class wxMimeTypesManagerImpl;  // it has access to m_impl
+#else

 friend wxMimeTypesManagerImpl;  // it has access to m_impl
 friend wxMimeTypesManagerImpl;  // it has access to m_impl

+#endif

 
 public:
     // An object of this class must be passed to Get{Open|Print}Command. The
 
 public:
     // An object of this class must be passed to Get{Open|Print}Command. The


@@ -50,7 +58,7 @@ public:
         const wxString& GetMimeType() const { return m_mimetype; }
 
         // override this function in derived class
         const wxString& GetMimeType() const { return m_mimetype; }
 
         // override this function in derived class

-        virtual wxString GetParamValue(const wxString& paramName) const
+        virtual wxString GetParamValue(const wxString& WXUNUSED(paramName)) const

             { return ""; }
 
         // virtual dtor as in any base class
             { return ""; }
 
         // virtual dtor as in any base class


@@ -102,14 +110,65 @@ private:
     wxFileTypeImpl *m_impl;
 };
 
     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
+};
+

 // 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).
 // 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:
 {
 public:

+    // static helper functions
+    // -----------------------
+
+        // check if the given MIME type is the same as the other one: the second
+        // argument may contain wildcards ('*'), but not the first. If the
+        // types are equal or if the mimeType matches wildcard the function
+        // returns TRUE, otherwise it returns FALSE
+    static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
+

     // ctor
     wxMimeTypesManager();
 
     // ctor
     wxMimeTypesManager();
 


@@ -122,12 +181,29 @@ public:
         // get file type from MIME type (in format <category>/<format>)
     wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
 
         // get file type from MIME type (in format <category>/<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)
         // 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
         // read in additional file in mime.types format

-    void ReadMimeTypes(const wxString& filename);
+    bool ReadMimeTypes(const wxString& filename);
+
+    // 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();
 
     // dtor (not virtual, shouldn't be derived from)
     ~wxMimeTypesManager();


@@ -140,6 +216,10 @@ private:
     wxMimeTypesManagerImpl *m_impl;
 };
 
     wxMimeTypesManagerImpl *m_impl;
 };
 

-#endif  //_MIMETYPE_H
+#endif
+  // wxUSE_FILE
+
+#endif
+  //_MIMETYPE_H

 
 /* vi: set cin tw=80 ts=4 sw=4: */
 
 /* vi: set cin tw=80 ts=4 sw=4: */