X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a5a19b836081432731d0302c95985fbb4ebc70d8..a84ece11fffdde5d1bbd254ba58ac3cee79c2e77:/docs/latex/wx/mimetype.tex diff --git a/docs/latex/wx/mimetype.tex b/docs/latex/wx/mimetype.tex index 94c7191bb7..9de41ff3f3 100644 --- a/docs/latex/wx/mimetype.tex +++ b/docs/latex/wx/mimetype.tex @@ -15,13 +15,28 @@ initialization is needed. (system-wide) and .mailcap and .mime.types in the current user's home directory: all of these files are searched for and loaded if found by default. However, additional functions -\helpref{wxMimeTypesManager::ReadMailcap}{wxmimetypesmanagerreadmailcap} and +\helpref{wxMimeTypesManager::ReadMailcap}{wxmimetypesmanagerreadmailcap} and \helpref{wxMimeTypesManager::ReadMimeTypes}{wxmimetypesmanagerreadmimetypes} are provided to load additional files. +If GNOME or KDE desktop environment is installed, then wxMimeTypesManager +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. +\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 on Unix systems. + \wxheading{Derived from} No base class. @@ -70,7 +85,8 @@ default ones which are loaded automatically) containing MIME information in either mailcap(5) or mime.types(5) format. \helpref{ReadMailcap}{wxmimetypesmanagerreadmailcap}\\ -\helpref{ReadMimeTypes}{wxmimetypesmanagerreadmimetypes} +\helpref{ReadMimeTypes}{wxmimetypesmanagerreadmimetypes}\\ +\helpref{AddFallbacks}{wxmimetypesmanageraddfallbacks} %%%%% MEMBERS HERE %%%%% \helponly{\insertatlevel{2}{ @@ -93,6 +109,17 @@ additional mailcap/mime.types files. 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 +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}} @@ -123,17 +150,29 @@ necessary to convert the strings to the same case before calling it. \membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap} -\func{void}{ReadMailcap}{\param{const wxString\&}{ filename}} +\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 information. +{\it fallback} parameter may be used to load additional mailcap files without +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). + +The return value is TRUE if there were no errors in the file or FALSE +otherwise. + \membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes} -\func{void}{ReadMimeTypes}{\param{const wxString\&}{ filename}} +\func{bool}{ReadMimeTypes}{\param{const wxString\&}{ filename}} Load additional file containing information about MIME types and associated 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 +otherwise. +