X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dcbd177f06597f98aae27bf53a4c98b4739102c7..429e2bb2fabb33092cba181278364867f4f08981:/docs/latex/wx/mimetype.tex

diff --git a/docs/latex/wx/mimetype.tex b/docs/latex/wx/mimetype.tex
index d763119014..f3fcf52bdc 100644
--- a/docs/latex/wx/mimetype.tex
+++ b/docs/latex/wx/mimetype.tex
@@ -23,7 +23,7 @@ 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}
 
@@ -35,7 +35,7 @@ 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.
+gathering MIME information may take quite a long time on Unix systems.
 
 \wxheading{Derived from}
 
@@ -45,12 +45,17 @@ No base class.
 
 <wx/mimetype.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxFileType}{wxfiletype}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
+
 \membersection{Helper functions}\label{mimehelperfunctions}
 
 All of these functions are static (i.e. don't need a wxMimeTypesManager object
@@ -60,6 +65,7 @@ types using wxString functions.
 
 \helpref{IsOfType}{wxmimetypesmanagerisoftype}
 
+
 \membersection{Constructor and destructor}\label{mimeconstructordestructor}
 
 NB: You won't normally need to use more than one wxMimeTypesManager object in a
@@ -68,16 +74,18 @@ program.
 \helpref{wxMimeTypesManager}{wxmimetypesmanagerctor}\\
 \helpref{\destruct{wxMimeTypesManager}}{wxmimetypesmanagerdtor}
 
+
 \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
@@ -95,6 +103,7 @@ information in either mailcap(5) or mime.types(5) format.
 
 }}
 
+
 \membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor}
 
 \func{}{wxMimeTypesManager}{\void}
@@ -103,12 +112,14 @@ Constructor puts the object in the "working" state, no additional initialization
 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}}
@@ -120,22 +131,28 @@ and extensions that might not be present in the system MIME database.
 
 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}}
@@ -148,6 +165,7 @@ same as {\it wildcard} or if it has the same category and the subtype of
 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}}
@@ -165,6 +183,7 @@ 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{bool}{ReadMimeTypes}{\param{const wxString\&}{ filename}}
