]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/mimetype.tex
declared private wxString::operator=(int) to prevent code like "str = 17;" from compiling
[wxWidgets.git] / docs / latex / wx / mimetype.tex
... / ...
CommitLineData
1\section{\class{wxMimeTypesManager}}\label{wxmimetypesmanager}
2
3This class allows the application to retrieve the information about all known
4MIME types from a system-specific location and the filename extensions to the
5MIME types and vice versa. After initialization the functions
6\helpref{wxMimeTypesManager::GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}
7and \helpref{wxMimeTypesManager::GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
8may be called: they will return a \helpref{wxFileType}{wxfiletype} object which
9may 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
12initialization 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:
16all of these files are searched for and loaded if found by default. However,
17additional functions
18\helpref{wxMimeTypesManager::ReadMailcap}{wxmimetypesmanagerreadmailcap} and
19\helpref{wxMimeTypesManager::ReadMimeTypes}{wxmimetypesmanagerreadmimetypes} are
20provided to load additional files.
21
22If GNOME or KDE desktop environment is installed, then wxMimeTypesManager
23gathers MIME information from respective files (e.g. .kdelnk files under KDE).
24
25NB: Currently, wxMimeTypesManager is limited to reading MIME type information
26but it will support modifying it as well in the future versions.
27
28\wxheading{Global objects}
29
30Global instance of wxMimeTypesManager is always available. It is defined
31as follows:
32
33\begin{verbatim}
34wxMimeTypesManager *wxTheMimeTypesManager;
35\end{verbatim}
36
37It is recommended to use this instance instead of creating your own because
38gathering MIME information may take quite a long on Unix systems.
39
40\wxheading{Derived from}
41
42No base class.
43
44\wxheading{Include files}
45
46<wx/mimetype.h>
47
48\wxheading{See also}
49
50\helpref{wxFileType}{wxfiletype}
51
52\latexignore{\rtfignore{\wxheading{Function groups}}}
53
54\membersection{Helper functions}
55
56All of these functions are static (i.e. don't need a wxMimeTypesManager object
57to call them) and provide some useful operations for string representations of
58MIME types. Their usage is recommended instead of directly working with MIME
59types using wxString functions.
60
61\helpref{IsOfType}{wxmimetypesmanagerisoftype}
62
63\membersection{Constructor and destructor}
64
65NB: You won't normally need to use more than one wxMimeTypesManager object in a
66program.
67
68\helpref{wxMimeTypesManager}{wxmimetypesmanagerctor}\\
69\helpref{\destruct{wxMimeTypesManager}}{wxmimetypesmanagerdtor}
70
71\membersection{Query database}
72
73These functions are the heart of this class: they allow to find a \helpref{file type}{wxfiletype} object
74from either file extension or MIME type.
75If the function is successful, it returns a pointer to the wxFileType object
76which {\bf must} be deleted by the caller, otherwise NULL will be returned.
77
78\helpref{GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}\\
79\helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
80
81\membersection{Initialization functions}\label{wxmimetypesmanagerinit}
82
83{\bf Unix:} These functions may be used to load additional files (except for the
84default ones which are loaded automatically) containing MIME
85information in either mailcap(5) or mime.types(5) format.
86
87\helpref{ReadMailcap}{wxmimetypesmanagerreadmailcap}\\
88\helpref{ReadMimeTypes}{wxmimetypesmanagerreadmimetypes}\\
89\helpref{AddFallbacks}{wxmimetypesmanageraddfallbacks}
90
91%%%%% MEMBERS HERE %%%%%
92\helponly{\insertatlevel{2}{
93
94\wxheading{Members}
95
96}}
97
98\membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor}
99
100\func{}{wxMimeTypesManager}{\void}
101
102Constructor puts the object in the "working" state, no additional initialization
103are needed - but \helpref{ReadXXX}{wxmimetypesmanagerinit} may be used to load
104additional mailcap/mime.types files.
105
106\membersection{wxMimeTypesManager::\destruct{wxMimeTypesManager}}\label{wxmimetypesmanagerdtor}
107
108\func{}{\destruct{wxMimeTypesManager}}{\void}
109
110Destructor is not virtual, so this class should not be derived from.
111
112\membersection{wxMimeTypesManager::AddFallbacks}\label{wxmimetypesmanageraddfallbacks}
113
114\func{void}{AddFallbacks}{\param{const wxFileTypeInfo *}{fallbacks}}
115
116This function may be used to provdie hard-wired fallbacks for the MIME types
117and extensions that might not be present in the system MIME database.
118
119% TODO
120
121Please see the typetest sample for an example of using it.
122
123\membersection{wxMimeTypesManager::GetFileTypeFromExtension}\label{wxmimetypesmanagergetfiletypefromextension}
124
125\func{wxFileType*}{GetFileTypeFromExtension}{\param{const wxString\&}{ extension}}
126
127Gather information about the files with given extension and return the
128corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the extension
129is unknown.
130
131\membersection{wxMimeTypesManager::GetFileTypeFromMimeType}\label{wxmimetypesmanagergetfiletypefrommimetype}
132
133\func{wxFileType*}{GetFileTypeFromMimeType}{\param{const wxString\&}{ mimeType}}
134
135Gather information about the files with given MIME type and return the
136corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the MIME type
137is unknown.
138
139\membersection{wxMimeTypesManager::IsOfType}\label{wxmimetypesmanagerisoftype}
140
141\func{bool}{IsOfType}{\param{const wxString\&}{ mimeType}, \param{const wxString\&}{ wildcard}}
142
143This function returns TRUE if either the given {\it mimeType} is exactly the
144same as {\it wildcard} or if it has the same category and the subtype of
145{\it wildcard} is '*'. Note that the '*' wildcard is not allowed in
146{\it mimeType} itself.
147
148The comparaison don by this function is case insensitive so it is not
149necessary to convert the strings to the same case before calling it.
150
151\membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap}
152
153\func{bool}{ReadMailcap}{\param{const wxString\&}{ filename}, \param{bool}{ fallback = FALSE}}
154
155Load additional file containing information about MIME types and associated
156information in mailcap format. See metamail(1) and mailcap(5) for more
157information.
158
159{\it fallback} parameter may be used to load additional mailcap files without
160overriding the settings found in the standard files: normally, entries from
161files loaded with ReadMailcap will override the entries from files loaded
162previously (and the standard ones are loaded in the very beginning), but this
163will not happen if this parameter is set to TRUE (default is FALSE).
164
165The return value is TRUE if there were no errors in the file or FALSE
166otherwise.
167
168\membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes}
169
170\func{bool}{ReadMimeTypes}{\param{const wxString\&}{ filename}}
171
172Load additional file containing information about MIME types and associated
173information in mime.types file format. See metamail(1) and mailcap(5) for more
174information.
175
176The return value is TRUE if there were no errors in the file or FALSE
177otherwise.
178