include/wx/msw/mimetype.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/mimetype.h
   3 // Purpose:     classes and functions to manage MIME types
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     23.09.98
   7 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   8 // Licence:     wxWindows licence (part of wxExtra library)
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _MIMETYPE_IMPL_H
  12 #define _MIMETYPE_IMPL_H
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_MIMETYPE
  17
  18 #include "wx/mimetype.h"
  19
  20 // ----------------------------------------------------------------------------
  21 // wxFileTypeImpl is the MSW version of wxFileType, this is a private class
  22 // and is never used directly by the application
  23 // ----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_BASE wxFileTypeImpl
  26 {
  27 public:
  28     // ctor
  29     wxFileTypeImpl() { }
  30
  31     // one of these Init() function must be called (ctor can't take any
  32     // arguments because it's common)
  33
  34         // initialize us with our file type name and extension - in this case
  35         // we will read all other data from the registry
  36     void Init(const wxString& strFileType, const wxString& ext);
  37
  38     // implement accessor functions
  39     bool GetExtensions(wxArrayString& extensions);
  40     bool GetMimeType(wxString *mimeType) const;
  41     bool GetMimeTypes(wxArrayString& mimeTypes) const;
  42     bool GetIcon(wxIconLocation *iconLoc) const;
  43     bool GetDescription(wxString *desc) const;
  44     bool GetOpenCommand(wxString *openCmd,
  45                         const wxFileType::MessageParameters& params) const;
  46     bool GetPrintCommand(wxString *printCmd,
  47                          const wxFileType::MessageParameters& params) const;
  48
  49     size_t GetAllCommands(wxArrayString * verbs, wxArrayString * commands,
  50                           const wxFileType::MessageParameters& params) const;
  51
  52     bool Unassociate();
  53
  54     // set an arbitrary command, ask confirmation if it already exists and
  55     // overwriteprompt is true
  56     bool SetCommand(const wxString& cmd,
  57                     const wxString& verb,
  58                     bool overwriteprompt = true);
  59
  60     bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0);
  61
  62     // this is called  by Associate
  63     bool SetDescription (const wxString& desc);
  64
  65 private:
  66     // helper function: reads the command corresponding to the specified verb
  67     // from the registry (returns an empty string if not found)
  68     wxString GetCommand(const wxString& verb) const;
  69
  70     // get the registry path for the given verb
  71     wxString GetVerbPath(const wxString& verb) const;
  72
  73     // check that the registry key for our extension exists, create it if it
  74     // doesn't, return false if this failed
  75     bool EnsureExtKeyExists();
  76
  77     wxString m_strFileType,         // may be empty
  78              m_ext;
  79
  80     // these methods are not publicly accessible (as wxMimeTypesManager
  81     // doesn't know about them), and should only be called by Unassociate
  82
  83     bool RemoveOpenCommand();
  84     bool RemoveCommand(const wxString& verb);
  85     bool RemoveMimeType();
  86     bool RemoveDefaultIcon();
  87     bool RemoveDescription();
  88 };
  89
  90 class WXDLLIMPEXP_BASE wxMimeTypesManagerImpl
  91 {
  92 public:
  93     // nothing to do here, we don't load any data but just go and fetch it from
  94     // the registry when asked for
  95     wxMimeTypesManagerImpl() { }
  96
  97     // implement containing class functions
  98     wxFileType *GetFileTypeFromExtension(const wxString& ext);
  99     wxFileType *GetOrAllocateFileTypeFromExtension(const wxString& ext);
 100     wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
 101
 102     size_t EnumAllFileTypes(wxArrayString& mimetypes);
 103
 104     // create a new filetype association
 105     wxFileType *Associate(const wxFileTypeInfo& ftInfo);
 106
 107     // create a new filetype with the given name and extension
 108     wxFileType *CreateFileType(const wxString& filetype, const wxString& ext);
 109 };
 110
 111 #endif // wxUSE_MIMETYPE
 112
 113 #endif
 114   //_MIMETYPE_IMPL_H
 115