X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e124873c5bd39ba8e9cc3c05ac7e4c97fbe59cd..e4861c72be058dd9d7e12cb77127d0be523414c8:/docs/latex/wx/mimetype.tex diff --git a/docs/latex/wx/mimetype.tex b/docs/latex/wx/mimetype.tex index 822e0a553c..d20058d4fb 100644 --- a/docs/latex/wx/mimetype.tex +++ b/docs/latex/wx/mimetype.tex @@ -19,8 +19,23 @@ additional functions \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. +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} @@ -36,7 +51,7 @@ No base class. \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 @@ -45,7 +60,7 @@ types using wxString functions. \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. @@ -53,7 +68,7 @@ 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. @@ -98,7 +113,7 @@ Destructor is not virtual, so this class should not be derived from. \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 @@ -125,17 +140,17 @@ is unknown. \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 @@ -145,9 +160,9 @@ information. 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} @@ -158,6 +173,6 @@ 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 +The return value is true if there were no errors in the file or false otherwise.