Added wxCLIP_SIBLINGS. CVS also seems to think lots of other files need updating.

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

diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h
index fb8e884cf3356b15663241a21772e705262d2a3d..dcd26cafa46f272ec526633b05e051a40620b9e1 100644 (file)
--- a/include/wx/mimetype.h
+++ b/include/wx/mimetype.h
@@ -12,6 +12,11 @@
 #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;
 // fwd decls
 class wxIcon;
 class wxFileTypeImpl;


@@ -23,6 +28,9 @@ class wxMimeTypesManagerImpl;
 
 // the things we really need
 #include "wx/string.h"
 
 // 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
 
 // 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 +40,7 @@ class wxMimeTypesManagerImpl;
 // the accessors *must* be checked!
 class WXDLLEXPORT wxFileType
 {
 // 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
 
 public:
     // An object of this class must be passed to Get{Open|Print}Command. The


@@ -69,6 +77,7 @@ public:
     // parameters are unchanged)
         // return the MIME type for this file type
     bool GetMimeType(wxString *mimeType) const;
     // 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);
         // fill passed in array with all extensions associated with this file
         // type
     bool GetExtensions(wxArrayString& extensions);


@@ -106,6 +115,51 @@ 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
+};
+
+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.
 // 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.


@@ -148,6 +202,22 @@ public:
         // read in additional file in mime.types format
     bool ReadMimeTypes(const wxString& filename);
 
         // 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
+    // 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();
 


@@ -157,8 +227,21 @@ private:
     wxMimeTypesManager& operator=(const wxMimeTypesManager&);
 
     wxMimeTypesManagerImpl *m_impl;
     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
 
 #endif
   // wxUSE_FILE