// Purpose: classes and functions to manage MIME types
// Author: Vadim Zeitlin
// Modified by:
+// Chris Elliott (biol75@york.ac.uk) 5 Dec 00: write support for Win32
// Created: 23.09.98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// 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
// 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
// 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);
- // get the icon corresponding to this file type
- bool GetIcon(wxIcon *icon) const;
+ // get the icon corresponding to this file type, the name of the file
+ // where the icon resides is return in iconfile if !NULL and its index
+ // in this file (Win-only) is in iconIndex
+ bool GetIcon(wxIcon *icon,
+ wxString *iconFile = NULL,
+ int *iconIndex = NULL) const;
// get a brief file type description ("*.txt" => "text document")
bool GetDescription(wxString *desc) const;
bool GetPrintCommand(wxString *printCmd,
const MessageParameters& params) const;
+
+ // return the number of commands defined for this file type, 0 if none
+ size_t GetAllCommands(wxArrayString *verbs, wxArrayString *commands,
+ const wxFileType::MessageParameters& params) const;
+
+ // the methods which modify the system database are only implemented under
+ // Win32 so far (on other platforms they will just return FALSE)
+ //
+ // also, they should only be used with the objects created using
+ // wxMimeTypesManager::Associate()
+
+ // set the command to be used for opening the file
+ bool SetOpenCommand(const wxString& cmd, bool overwriteprompt = TRUE);
+
+ // set an arbitrary command, ask confirmation if it already exists and
+ // overwriteprompt is TRUE
+ bool SetCommand(const wxString& cmd, const wxString& verb,
+ bool overwriteprompt = TRUE);
+
+ // set the MIME type for this filetype
+ bool SetMimeType(const wxString& mimeType);
+ // set the default icon for this filetype
+ bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0);
+
+ // remove the association from the system database
+ bool Unassociate();
+
+ // delete registration info
+ bool RemoveOpenCommand();
+ bool RemoveCommand(const wxString& verb);
+ bool RemoveMimeType();
+ bool RemoveDefaultIcon();
+
// operations
// expand a string in the format of GetOpenCommand (which may contain
// '%s' and '%t' format specificators for the file name and mime type
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
// deleting it.
// get file type from file extension
wxFileType *GetFileTypeFromExtension(const wxString& ext);
+ wxFileType *GetOrAllocateFileTypeFromExtension(const wxString& ext);
// 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)
- 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);
+
+ // create a new association between the given extension and MIME type and
+ // return the wxFileType object corresponding (which should be deleted by
+ // caller) or NULL if something went wrong
+ wxFileType *Associate(const wxString& ext,
+ const wxString& mimeType,
+ const wxString& filetype = wxEmptyString,
+ const wxString& desc = wxEmptyString);
// dtor (not virtual, shouldn't be derived from)
~wxMimeTypesManager();
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: */
projects / wxWidgets.git / blobdiff