X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b13d92d1c8840feca54b00e15ad558d77bda78df..c0bcc480680ecdf368839c119f5e984df757f893:/docs/latex/wx/filetype.tex

diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex
index 3b56bcdb6b..e711958c3d 100644
--- a/docs/latex/wx/filetype.tex
+++ b/docs/latex/wx/filetype.tex
@@ -1,6 +1,6 @@
 \section{\class{wxFileType}}\label{wxfiletype}
 
-This class holds information about a given "file type". File type is the same as
+This class holds information about a given {\it file type}. File type is the same as
 MIME type under Unix, but under Windows it corresponds more to an extension than
 to MIME type (in fact, several extensions may correspond to a file type). This
 object may be created in several different ways: the program might know the file
@@ -13,14 +13,14 @@ will be returned if the corresponding information couldn't be found.
 The objects of this class are never created by the application code but are
 returned by \helpref{wxMimeTypesManager::GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype} and 
 \helpref{wxMimeTypesManager::GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension} methods.
-But it's your responsability to delete the returned pointer when you're done
+But it's your responsibility to delete the returned pointer when you're done
 with it!
 
 % TODO describe MIME types better than this...
-A brief remainder about what the MIME types are (see the RFC 1341 for more
-information): basicly, it is just a pair category/type (for example,
-"text/plain") where the category is a basic indication of what a file is
-(examples of categories are "application", "image", "text", "binary"...) and
+A brief reminder about what the MIME types are (see the RFC 1341 for more
+information): basically, it is just a pair category/type (for example,
+"text/plain") where the category is a basic indication of what a file is.
+Examples of categories are "application", "image", "text", "binary", and
 type is a precise definition of the document format: "plain" in the example
 above means just ASCII text without any formatting, while "text/html" is the
 HTML document source.
@@ -29,13 +29,13 @@ A MIME type may have one or more associated extensions: "text/plain" will
 typically correspond to the extension ".txt", but may as well be associated with
 ".ini" or ".conf".
 
-\wxheading{Required headers}
+\wxheading{Derived from}
 
-#include <wx/mimetype.h>
+None
 
-\wxheading{Derived from}
+\wxheading{Include files}
 
-No base class.
+<wx/mimetype.h>
 
 \wxheading{See also}
 
@@ -43,7 +43,7 @@ No base class.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{MessageParameters class}{wxfiletypemessageparameters}
+\membersection{MessageParameters class}\label{wxfiletypemessageparameters}
 
 One of the most common usages of MIME is to encode an e-mail message. The MIME
 type of the encoded message is an example of a {\it message parameter}. These
@@ -64,10 +64,10 @@ function, for example:
 
 \begin{verbatim}
 // provide the message parameters for the MIME type manager
-class MailMessageParamaters : public wxFileType::MessageParameters
+class MailMessageParameters : public wxFileType::MessageParameters
 {
 public:
-   MailMessageParamaters(const wxString& filename,
+   MailMessageParameters(const wxString& filename,
                          const wxString& mimetype)
       : wxFileType::MessageParameters(filename, mimetype)
    {
@@ -85,7 +85,7 @@ public:
 \end{verbatim}
 
 Now you only need to create an object of this class and pass it to, for example,
-\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
+\rtfsp\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
 
 \begin{verbatim}
 wxString command;
@@ -99,7 +99,6 @@ else
 {
     // we don't know how to handle such files...
 }
-
 \end{verbatim}
 
 {\bf Windows:} As only the file name is used by the program associated with the
@@ -107,25 +106,38 @@ given extension anyhow (but no other message parameters), there is no need to
 ever derive from MessageParameters class for a Windows-only program.
 
 \membersection{wxFileType::wxFileType}\label{wxfiletypewxfiletype}
+
 \func{}{wxFileType}{\void}
 
 The default constructor is private because you should never create objects of
-this type: they are only returned by 
-\helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
+this type: they are only returned by \helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
 
 \membersection{wxFileType::\destruct{wxFileType}}\label{wxfiletypedtor}
-\func{}{\destruct{wxFileType}{\void}
+
+\func{}{\destruct{wxFileType}}{\void}
 
 The destructor of this class is not virtual, so it should not be derived from.
 
 \membersection{wxFileType::GetMimeType}\label{wxfiletypegetmimetype}
-\func{bool}{GetMimeType}{\param{wxString *}{mimeType}}
+
+\func{bool}{GetMimeType}{\param{wxString*}{ mimeType}}
 
 If the function returns TRUE, the string pointed to by {\it mimeType} is filled
 with full MIME type specification for this file type: for example, "text/plain".
 
+\membersection{wxFileType::GetMimeTypes}\label{wxfiletypegetmimetypes}
+
+\func{bool}{GetMimeType}{\param{wxArrayString\&}{ mimeTypes}}
+
+Same as \helpref{GetMimeType}{wxfiletypegetmimetype} but returns array of MIME
+types. This array will contain only one item in most cases but sometimes,
+notably under Unix with KDE, may contain more MIME types. This happens when
+one file extension is mapped to different MIME types by KDE, mailcap and
+mime.types.
+
 \membersection{wxFileType::GetExtensions}\label{wxfiletypegetextensions}
-\func{bool}{GetExtensions}{\param{wxArrayString \&}{extensions}}
+
+\func{bool}{GetExtensions}{\param{wxArrayString\&}{ extensions}}
 
 If the function returns TRUE, the array {\it extensions} is filled
 with all extensions associated with this file type: for example, it may
@@ -139,22 +151,27 @@ by \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension
 function in the first place.
 
 \membersection{wxFileType::GetIcon}\label{wxfiletypegeticon}
-\func{bool}{GetIcon}{\param{wxIcon *}{icon}}
+
+\func{bool}{GetIcon}{\param{wxIcon*}{ icon}}
 
 If the function returns TRUE, the icon associated with this file type will be
 created and assigned to the {\it icon} parameter.
 
-{\bf Unix:} This function always returns FALSE under Unix.
+{\bf Unix:} MIME manager gathers information about icons from GNOME
+and KDE settings and thus GetIcon's success depends on availability
+of these desktop environments.
 
 \membersection{wxFileType::GetDescription}\label{wxfiletypegetdescription}
-\func{bool}{GetDescription}{\param{wxString *}{desc}}
+
+\func{bool}{GetDescription}{\param{wxString*}{ desc}}
 
 If the function returns TRUE, the string pointed to by {\it desc} is filled
 with a brief description for this file type: for example, "text document" for
 the "text/plain" MIME type.
 
 \membersection{wxFileType::GetOpenCommand}\label{wxfiletypegetopencommand}
-\func{bool}{GetOpenCommand}{\param{wxString *}{command},\param{MessageParameters \&}{params}}
+
+\func{bool}{GetOpenCommand}{\param{wxString*}{ command}, \param{MessageParameters\&}{ params}}
 
 If the function returns TRUE, the string pointed to by {\it command} is filled
 with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
@@ -162,7 +179,8 @@ order to open the file of the given type. The name of the file is
 retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
 
 \membersection{wxFileType::GetPrintCommand}\label{wxfiletypegetprintcommand}
-\func{bool}{GetPrintCommand}{\param{wxString *}{command},\param{MessageParameters \&}{params}}
+
+\func{bool}{GetPrintCommand}{\param{wxString*}{ command},\param{MessageParameters\&}{ params}}
 
 If the function returns TRUE, the string pointed to by {\it command} is filled
 with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
@@ -170,13 +188,15 @@ order to print the file of the given type. The name of the file is
 retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
 
 \membersection{wxFileType::ExpandCommand}\label{wxfiletypeexpandcommand}
-\func{static wxString}{ExpandCommand}{\param{const wxString \&}{command},\param{MessageParameters \&}{params}}
+
+\func{static wxString}{ExpandCommand}{\param{const wxString\&}{ command}, \param{MessageParameters\&}{ params}}
 
 This function is primarly intended for GetOpenCommand and GetPrintCommand
 usage but may be also used by the application directly if, for example, you want
 to use some non default command to open the file.
 
 The function replaces all occurences of
+
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{format specificator}{with}
@@ -184,6 +204,7 @@ The function replaces all occurences of
 \twocolitem{\%t}{the MIME type}
 \twocolitem{\%\{param\}}{the value of the parameter {\it param}}
 \end{twocollist}
+
 using the MessageParameters object you pass to it.
 
 If there is no '\%s' in the command string (and the string is not empty), it is
@@ -192,3 +213,4 @@ as "< \%s" were appended to the string.
 
 Unlike all other functions of this class, there is no error return for this
 function.
+
