X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2432b92dd7a837db13d3938a56c1959decd03203..9329312b60229511c24e59cf849fd6281ec4dc7b:/docs/latex/wx/filetype.tex diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex index f4d52516a7..c76595f4b2 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} - +None -\wxheading{Derived from} +\wxheading{Include files} -No base class. + \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 @@ -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}