]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filetype.tex
fixed 2 bugs in 2 lines of wxFileSelector example code
[wxWidgets.git] / docs / latex / wx / filetype.tex
index be2b621f190eeab53c5f35d3e0d8c45f6bda1d5b..18f91aab5a217ab4dbcbcc34bcfd10b028153d79 100644 (file)
@@ -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 is 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.
@@ -31,7 +31,7 @@ typically correspond to the extension ".txt", but may as well be associated with
 
 \wxheading{Derived from}
 
-No base class.
+None
 
 \wxheading{Include files}
 
@@ -56,7 +56,7 @@ These parameters may be useful to the program used to open, edit, view or print
 the message, so, for example, an e-mail client program will have to pass them to
 this program. Because wxFileType itself can not know about these parameters,
 it uses MessageParameters class to query them. The default implementation only
-requiers the caller to provide the file name (always used by the program to be
+requires the caller to provide the file name (always used by the program to be
 called - it must know which file to open) and the MIME type and supposes that
 there are no other parameters. If you wish to supply additional parameters, you
 must derive your own class from MessageParameters and override GetParamValue()
@@ -125,6 +125,16 @@ The destructor of this class is not virtual, so it should not be derived from.
 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}}
@@ -147,7 +157,9 @@ function in the first place.
 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}
 
@@ -179,15 +191,15 @@ retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
 
 \func{static wxString}{ExpandCommand}{\param{const wxString\&}{ command}, \param{MessageParameters\&}{ params}}
 
-This function is primarly intended for GetOpenCommand and GetPrintCommand
+This function is primarily 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
+The function replaces all occurrences of
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{format specificator}{with}
+\twocolitem{format specification}{with}
 \twocolitem{\%s}{the full file name}
 \twocolitem{\%t}{the MIME type}
 \twocolitem{\%\{param\}}{the value of the parameter {\it param}}