]>
Commit | Line | Data |
---|---|---|
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{Derived from} | |
26 | ||
27 | No base class. | |
28 | ||
29 | \wxheading{Include files} | |
30 | ||
31 | <wx/mimetype.h> | |
32 | ||
33 | \wxheading{See also} | |
34 | ||
35 | \helpref{wxFileType}{wxfiletype} | |
36 | ||
37 | \latexignore{\rtfignore{\wxheading{Function groups}}} | |
38 | ||
39 | \membersection{Helper functions} | |
40 | ||
41 | All of these functions are static (i.e. don't need a wxMimeTypesManager object | |
42 | to call them) and provide some useful operations for string representations of | |
43 | MIME types. Their usage is recommended instead of directly working with MIME | |
44 | types using wxString functions. | |
45 | ||
46 | \helpref{IsOfType}{wxmimetypesmanagerisoftype} | |
47 | ||
48 | \membersection{Constructor and destructor} | |
49 | ||
50 | NB: You won't normally need to use more than one wxMimeTypesManager object in a | |
51 | program. | |
52 | ||
53 | \helpref{wxMimeTypesManager}{wxmimetypesmanagerctor}\\ | |
54 | \helpref{\destruct{wxMimeTypesManager}}{wxmimetypesmanagerdtor} | |
55 | ||
56 | \membersection{Query database} | |
57 | ||
58 | These functions are the heart of this class: they allow to find a \helpref{file type}{wxfiletype} object | |
59 | from either file extension or MIME type. | |
60 | If the function is successful, it returns a pointer to the wxFileType object | |
61 | which {\bf must} be deleted by the caller, otherwise NULL will be returned. | |
62 | ||
63 | \helpref{GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}\\ | |
64 | \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension} | |
65 | ||
66 | \membersection{Initialization functions}\label{wxmimetypesmanagerinit} | |
67 | ||
68 | {\bf Unix:} These functions may be used to load additional files (except for the | |
69 | default ones which are loaded automatically) containing MIME | |
70 | information in either mailcap(5) or mime.types(5) format. | |
71 | ||
72 | \helpref{ReadMailcap}{wxmimetypesmanagerreadmailcap}\\ | |
73 | \helpref{ReadMimeTypes}{wxmimetypesmanagerreadmimetypes}\\ | |
74 | \helpref{AddFallbacks}{wxmimetypesmanageraddfallbacks} | |
75 | ||
76 | %%%%% MEMBERS HERE %%%%% | |
77 | \helponly{\insertatlevel{2}{ | |
78 | ||
79 | \wxheading{Members} | |
80 | ||
81 | }} | |
82 | ||
83 | \membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor} | |
84 | ||
85 | \func{}{wxMimeTypesManager}{\void} | |
86 | ||
87 | Constructor puts the object in the "working" state, no additional initialization | |
88 | are needed - but \helpref{ReadXXX}{wxmimetypesmanagerinit} may be used to load | |
89 | additional mailcap/mime.types files. | |
90 | ||
91 | \membersection{wxMimeTypesManager::\destruct{wxMimeTypesManager}}\label{wxmimetypesmanagerdtor} | |
92 | ||
93 | \func{}{\destruct{wxMimeTypesManager}}{\void} | |
94 | ||
95 | Destructor is not virtual, so this class should not be derived from. | |
96 | ||
97 | \membersection{wxMimeTypesManager::AddFallbacks}\label{wxmimetypesmanageraddfallbacks} | |
98 | ||
99 | \func{void}{AddFallbacks}{\param{const wxFileTypeInfo *}{fallbacks}} | |
100 | ||
101 | This function may be used to provdie hard-wired fallbacks for the MIME types | |
102 | and extensions that might not be present in the system MIME database. | |
103 | ||
104 | % TODO | |
105 | ||
106 | Please see the typetest sample for an example of using it. | |
107 | ||
108 | \membersection{wxMimeTypesManager::GetFileTypeFromExtension}\label{wxmimetypesmanagergetfiletypefromextension} | |
109 | ||
110 | \func{wxFileType*}{GetFileTypeFromExtension}{\param{const wxString\&}{ extension}} | |
111 | ||
112 | Gather information about the files with given extension and return the | |
113 | corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the extension | |
114 | is unknown. | |
115 | ||
116 | \membersection{wxMimeTypesManager::GetFileTypeFromMimeType}\label{wxmimetypesmanagergetfiletypefrommimetype} | |
117 | ||
118 | \func{wxFileType*}{GetFileTypeFromMimeType}{\param{const wxString\&}{ mimeType}} | |
119 | ||
120 | Gather information about the files with given MIME type and return the | |
121 | corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the MIME type | |
122 | is unknown. | |
123 | ||
124 | \membersection{wxMimeTypesManager::IsOfType}\label{wxmimetypesmanagerisoftype} | |
125 | ||
126 | \func{bool}{IsOfType}{\param{const wxString\&}{ mimeType}, \param{const wxString\&}{ wildcard}} | |
127 | ||
128 | This function returns TRUE if either the given {\it mimeType} is exactly the | |
129 | same as {\it wildcard} or if it has the same category and the subtype of | |
130 | {\it wildcard} is '*'. Note that the '*' wildcard is not allowed in | |
131 | {\it mimeType} itself. | |
132 | ||
133 | The comparaison don by this function is case insensitive so it is not | |
134 | necessary to convert the strings to the same case before calling it. | |
135 | ||
136 | \membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap} | |
137 | ||
138 | \func{bool}{ReadMailcap}{\param{const wxString\&}{ filename}, \param{bool}{ fallback = FALSE}} | |
139 | ||
140 | Load additional file containing information about MIME types and associated | |
141 | information in mailcap format. See metamail(1) and mailcap(5) for more | |
142 | information. | |
143 | ||
144 | {\it fallback} parameter may be used to load additional mailcap files without | |
145 | overriding the settings found in the standard files: normally, entries from | |
146 | files loaded with ReadMailcap will override the entries from files loaded | |
147 | previously (and the standard ones are loaded in the very beginning), but this | |
148 | will not happen if this parameter is set to TRUE (default is FALSE). | |
149 | ||
150 | The return value is TRUE if there were no errors in the file or FALSE | |
151 | otherwise. | |
152 | ||
153 | \membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes} | |
154 | ||
155 | \func{bool}{ReadMimeTypes}{\param{const wxString\&}{ filename}} | |
156 | ||
157 | Load additional file containing information about MIME types and associated | |
158 | information in mime.types file format. See metamail(1) and mailcap(5) for more | |
159 | information. | |
160 | ||
161 | The return value is TRUE if there were no errors in the file or FALSE | |
162 | otherwise. | |
163 |