docs/latex/wx/mimetype.tex

   1 \section{\class{wxMimeTypesManager}}\label{wxmimetypesmanager}
   2
   3 This class allows the application to retrieve the information about all known
   4 MIME types from a system-specific location and the filename extensions to the
   5 MIME types and vice versa. After initialization the functions
   6 \helpref{wxMimeTypesManager::GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}
   7 and \helpref{wxMimeTypesManager::GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
   8 may be called: they will return a \helpref{wxFileType}{wxfiletype} object which
   9 may be further queried for file description, icon and other attributes.
  10
  11 {\bf Windows:} MIME type information is stored in the registry and no additional
  12 initialization is needed.
  13
  14 {\bf Unix:} MIME type information is stored in the files mailcap and mime.types
  15 (system-wide) and .mailcap and .mime.types in the current user's home directory:
  16 all of these files are searched for and loaded if found by default. However,
  17 additional functions
  18 \helpref{wxMimeTypesManager::ReadMailcap}{wxmimetypesmanagerreadmailcap} and
  19 \helpref{wxMimeTypesManager::ReadMimeTypes}{wxmimetypesmanagerreadmimetypes} are
  20 provided to load additional files.
  21
  22 NB: Currently, wxMimeTypesManager is limited to reading MIME type information
  23 but it will support modifying it as well in the future versions.
  24
  25 \wxheading{Required headers}
  26
  27 <wx/mimetype.h>
  28
  29 \wxheading{Derived from}
  30
  31 No base class.
  32
  33 \wxheading{See also}
  34
  35 \helpref{wxFileType}{wxfiletype}
  36
  37 \latexignore{\rtfignore{\wxheading{Function groups}}}
  38
  39 \membersection{Constructor and destructor}
  40
  41 NB: You won't normally need to use more than one wxMimeTypesManager object in a
  42 program.
  43
  44 \helpref{wxMimeTypesManager}{wxmimetypesmanagerctor}\\
  45 \helpref{\destruct{wxMimeTypesManager}}{wxmimetypesmanagerdtor}
  46
  47 \membersection{Query database}
  48
  49 These functions are the heart of this class: they allow to find a \helpref{file type}{wxfiletype} object
  50 from either file extension or MIME type.
  51 If the function is successful, it returns a pointer to the wxFileType object
  52 which {\bf must} be deleted by the caller, otherwise NULL will be returned.
  53
  54 \helpref{GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}\\
  55 \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
  56
  57 \membersection{Initialization functions}\label{wxmimetypesmanagerinit}
  58
  59 {\bf Unix:} These functions may be used to load additional files (except for the
  60 default ones which are loaded automatically) containing MIME
  61 information in either mailcap(5) or mime.types(5) format.
  62
  63 \helpref{ReadMailcap}{wxmimetypesmanagerreadmailcap}\\
  64 \helpref{ReadMimeTypes}{wxmimetypesmanagerreadmimetypes}
  65
  66 %%%%% MEMBERS HERE %%%%%
  67 \helponly{\insertatlevel{2}{
  68
  69 \wxheading{Members}
  70
  71 }}
  72
  73 \membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor}
  74
  75 \func{}{wxMimeTypesManager}{\void}
  76
  77 Constructor puts the object in the "working" state, no additional initialization
  78 are needed - but \helpref{ReadXXX}{wxmimetypesmanagerinit} may be used to load
  79 additional mailcap/mime.types files.
  80
  81 \membersection{wxMimeTypesManager::\destruct{wxMimeTypesManager}}\label{wxmimetypesmanagerdtor}
  82
  83 \func{}{\destruct{wxMimeTypesManager}}{\void}
  84
  85 Destructor is not virtual, so this class should not be derived from.
  86
  87 \membersection{wxMimeTypesManager::GetFileTypeFromExtension}\label{wxmimetypesmanagergetfiletypefromextension}
  88
  89 \func{wxFileType*}{GetFileTypeFromExtension}{\param{const wxString\&}{ extension}}
  90
  91 Gather information about the files with given extension and return the
  92 corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the extension
  93 is unknown.
  94
  95 \membersection{wxMimeTypesManager::GetFileTypeFromMimeType}\label{wxmimetypesmanagergetfiletypefrommimetype}
  96
  97 \func{wxFileType*}{GetFileTypeFromMimeType}{\param{const wxString\&}{ mimeType}}
  98
  99 Gather information about the files with given MIME type and return the
 100 corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the MIME type
 101 is unknown.
 102
 103 \membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap}
 104
 105 \func{void}{ReadMailcap}{\param{const wxString\&}{ filename}}
 106
 107 Load additional file containing information about MIME types and associated
 108 information in mailcap format. See metamail(1) and mailcap(5) for more
 109 information.
 110
 111 \membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes}
 112
 113 \func{void}{ReadMimeTypes}{\param{const wxString\&}{ filename}}
 114
 115 Load additional file containing information about MIME types and associated
 116 information in mime.types file format. See metamail(1) and mailcap(5) for more
 117 information.
 118