gathers MIME information from respective files (e.g. .kdelnk files under KDE).
NB: Currently, wxMimeTypesManager is limited to reading MIME type information
-but it will support modifying it as well in the future versions.
+but it will support modifying it as well in future versions.
+
+\wxheading{Global objects}
+
+Global instance of wxMimeTypesManager is always available. It is defined
+as follows:
+
+\begin{verbatim}
+wxMimeTypesManager *wxTheMimeTypesManager;
+\end{verbatim}
+
+It is recommended to use this instance instead of creating your own because
+gathering MIME information may take quite a long time on Unix systems.
\wxheading{Derived from}
<wx/mimetype.h>
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
\wxheading{See also}
\helpref{wxFileType}{wxfiletype}
\latexignore{\rtfignore{\wxheading{Function groups}}}
-\membersection{Helper functions}
+
+\membersection{Helper functions}\label{mimehelperfunctions}
All of these functions are static (i.e. don't need a wxMimeTypesManager object
to call them) and provide some useful operations for string representations of
\helpref{IsOfType}{wxmimetypesmanagerisoftype}
-\membersection{Constructor and destructor}
+
+\membersection{Constructor and destructor}\label{mimeconstructordestructor}
NB: You won't normally need to use more than one wxMimeTypesManager object in a
program.
\helpref{wxMimeTypesManager}{wxmimetypesmanagerctor}\\
\helpref{\destruct{wxMimeTypesManager}}{wxmimetypesmanagerdtor}
-\membersection{Query database}
+
+\membersection{Query database}\label{mimequerydatabase}
These functions are the heart of this class: they allow to find a \helpref{file type}{wxfiletype} object
from either file extension or MIME type.
If the function is successful, it returns a pointer to the wxFileType object
-which {\bf must} be deleted by the caller, otherwise NULL will be returned.
+which {\bf must} be deleted by the caller, otherwise \NULL will be returned.
\helpref{GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}\\
\helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
+
\membersection{Initialization functions}\label{wxmimetypesmanagerinit}
{\bf Unix:} These functions may be used to load additional files (except for the
}}
+
\membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor}
\func{}{wxMimeTypesManager}{\void}
are needed - but \helpref{ReadXXX}{wxmimetypesmanagerinit} may be used to load
additional mailcap/mime.types files.
+
\membersection{wxMimeTypesManager::\destruct{wxMimeTypesManager}}\label{wxmimetypesmanagerdtor}
\func{}{\destruct{wxMimeTypesManager}}{\void}
Destructor is not virtual, so this class should not be derived from.
+
\membersection{wxMimeTypesManager::AddFallbacks}\label{wxmimetypesmanageraddfallbacks}
\func{void}{AddFallbacks}{\param{const wxFileTypeInfo *}{fallbacks}}
-This function may be used to provdie hard-wired fallbacks for the MIME types
+This function may be used to provide hard-wired fallbacks for the MIME types
and extensions that might not be present in the system MIME database.
% TODO
Please see the typetest sample for an example of using it.
+
\membersection{wxMimeTypesManager::GetFileTypeFromExtension}\label{wxmimetypesmanagergetfiletypefromextension}
\func{wxFileType*}{GetFileTypeFromExtension}{\param{const wxString\&}{ extension}}
Gather information about the files with given extension and return the
-corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the extension
+corresponding \helpref{wxFileType}{wxfiletype} object or \NULL if the extension
is unknown.
+The \arg{extension} parameter may have, or not, the leading dot, if it has it,
+it is stripped automatically. It must not however be empty.
+
+
\membersection{wxMimeTypesManager::GetFileTypeFromMimeType}\label{wxmimetypesmanagergetfiletypefrommimetype}
\func{wxFileType*}{GetFileTypeFromMimeType}{\param{const wxString\&}{ mimeType}}
Gather information about the files with given MIME type and return the
-corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the MIME type
+corresponding \helpref{wxFileType}{wxfiletype} object or \NULL if the MIME type
is unknown.
+
\membersection{wxMimeTypesManager::IsOfType}\label{wxmimetypesmanagerisoftype}
\func{bool}{IsOfType}{\param{const wxString\&}{ mimeType}, \param{const wxString\&}{ wildcard}}
-This function returns TRUE if either the given {\it mimeType} is exactly the
+This function returns true if either the given {\it mimeType} is exactly the
same as {\it wildcard} or if it has the same category and the subtype of
{\it wildcard} is '*'. Note that the '*' wildcard is not allowed in
{\it mimeType} itself.
-The comparaison don by this function is case insensitive so it is not
+The comparison don by this function is case insensitive so it is not
necessary to convert the strings to the same case before calling it.
+
\membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap}
-\func{bool}{ReadMailcap}{\param{const wxString\&}{ filename}, \param{bool}{ fallback = FALSE}}
+\func{bool}{ReadMailcap}{\param{const wxString\&}{ filename}, \param{bool}{ fallback = false}}
Load additional file containing information about MIME types and associated
information in mailcap format. See metamail(1) and mailcap(5) for more
overriding the settings found in the standard files: normally, entries from
files loaded with ReadMailcap will override the entries from files loaded
previously (and the standard ones are loaded in the very beginning), but this
-will not happen if this parameter is set to TRUE (default is FALSE).
+will not happen if this parameter is set to true (default is false).
-The return value is TRUE if there were no errors in the file or FALSE
+The return value is true if there were no errors in the file or false
otherwise.
+
\membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes}
\func{bool}{ReadMimeTypes}{\param{const wxString\&}{ filename}}
information in mime.types file format. See metamail(1) and mailcap(5) for more
information.
-The return value is TRUE if there were no errors in the file or FALSE
+The return value is true if there were no errors in the file or false
otherwise.
projects / wxWidgets.git / blobdiff