include/wx/mac/mimetype.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mac/mimetype.h
   3 // Purpose:     classes and functions to manage MIME types
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     23.09.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence (part of wxExtra library)
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _MIMETYPE_IMPL_H
  13 #define _MIMETYPE_IMPL_H
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "mimetype.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/mimetype.h"
  21
  22
  23 class wxMimeTypesManagerImpl
  24 {
  25 public :
  26     wxMimeTypesManagerImpl() { }
  27 #ifdef __DARWIN__
  28     ~wxMimeTypesManagerImpl() { }
  29 #endif
  30
  31     // load all data into memory - done when it is needed for the first time
  32     void Initialize(int mailcapStyles = wxMAILCAP_STANDARD,
  33                     const wxString& extraDir = wxEmptyString);
  34
  35     // and delete the data here
  36     void ClearData();
  37
  38     // implement containing class functions
  39     wxFileType *GetFileTypeFromExtension(const wxString& ext);
  40     wxFileType *GetOrAllocateFileTypeFromExtension(const wxString& ext) ;
  41     wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
  42
  43     size_t EnumAllFileTypes(wxArrayString& mimetypes);
  44
  45     // this are NOPs under MacOS
  46     bool ReadMailcap(const wxString& WXUNUSED(filename), bool WXUNUSED(fallback) = TRUE) { return TRUE; }
  47     bool ReadMimeTypes(const wxString& WXUNUSED(filename)) { return TRUE; }
  48
  49     void AddFallback(const wxFileTypeInfo& ft) { m_fallbacks.Add(ft); }
  50
  51     // create a new filetype association
  52     wxFileType *Associate(const wxFileTypeInfo& ftInfo);
  53     // remove association
  54     bool Unassociate(wxFileType *ft);
  55
  56     // create a new filetype with the given name and extension
  57     wxFileType *CreateFileType(const wxString& filetype, const wxString& ext);
  58
  59 private:
  60     wxArrayFileTypeInfo m_fallbacks;
  61 };
  62
  63 class wxFileTypeImpl
  64 {
  65 public:
  66     // initialization functions
  67     // this is used to construct a list of mimetypes which match;
  68     // if built with GetFileTypeFromMimetype index 0 has the exact match and
  69     // index 1 the type / * match
  70     // if built with GetFileTypeFromExtension, index 0 has the mimetype for
  71     // the first extension found, index 1 for the second and so on
  72
  73     void Init(wxMimeTypesManagerImpl *manager, size_t index)
  74     { m_manager = manager; m_index.Add(index); }
  75
  76     // initialize us with our file type name
  77     void SetFileType(const wxString& strFileType)
  78         { m_strFileType = strFileType; }
  79     void SetExt(const wxString& ext)
  80         { m_ext = ext; }
  81
  82     // implement accessor functions
  83     bool GetExtensions(wxArrayString& extensions);
  84     bool GetMimeType(wxString *mimeType) const;
  85     bool GetMimeTypes(wxArrayString& mimeTypes) const;
  86     bool GetIcon(wxIconLocation *iconLoc) const;
  87     bool GetDescription(wxString *desc) const;
  88     bool GetOpenCommand(wxString *openCmd,
  89                         const wxFileType::MessageParameters&) const
  90         { return GetCommand(openCmd, "open"); }
  91     bool GetPrintCommand(wxString *printCmd,
  92                          const wxFileType::MessageParameters&) const
  93         { return GetCommand(printCmd, "print"); }
  94
  95     size_t GetAllCommands(wxArrayString * verbs, wxArrayString * commands,
  96                           const wxFileType::MessageParameters& params) const;
  97
  98     // remove the record for this file type
  99     // probably a mistake to come here, use wxMimeTypesManager.Unassociate (ft) instead
 100     bool Unassociate(wxFileType *ft)
 101     {
 102         return m_manager->Unassociate(ft);
 103     }
 104
 105     // set an arbitrary command, ask confirmation if it already exists and
 106     // overwriteprompt is TRUE
 107     bool SetCommand(const wxString& cmd, const wxString& verb, bool overwriteprompt = TRUE);
 108     bool SetDefaultIcon(const wxString& strIcon = wxEmptyString, int index = 0);
 109
 110  private:
 111     // helper function
 112     bool GetCommand(wxString *command, const char *verb) const;
 113
 114     wxMimeTypesManagerImpl *m_manager;
 115     wxArrayInt              m_index; // in the wxMimeTypesManagerImpl arrays
 116     wxString m_strFileType, m_ext;
 117 };
 118
 119 #endif
 120   //_MIMETYPE_H
 121
 122 /* vi: set cin tw=80 ts=4 sw=4: */